Python 开发模式¶

3.7 版本新增。

Python 开发模式引入了额外的运行时检查，这些检查的开销太大，默认情况下不启用。如果代码正确，它不应该比默认情况更冗长；只有在检测到问题时才会发出新的警告。

可以使用 -X dev 命令行选项启用它，或者将 PYTHONDEVMODE 环境变量设置为 1。

Python 开发模式的效果¶

启用 Python 开发模式类似于以下命令，但具有下面描述的附加效果

PYTHONMALLOC=debug PYTHONASYNCIODEBUG=1 python -W default -X faulthandler

Python 开发模式的效果

添加 default 警告过滤器。将显示以下警告
通常，上述警告会被默认的警告过滤器过滤。

它的行为就像使用了 -W default 命令行选项。

使用 -W error 命令行选项或将 PYTHONWARNINGS 环境变量设置为 error，将警告视为错误。
在内存分配器上安装调试钩子以检查
- 缓冲区下溢
- 缓冲区溢出
- 内存分配器 API 违规
- GIL 的不安全使用
请参阅 PyMem_SetupDebugHooks() C 函数。

它的行为就像 PYTHONMALLOC 环境变量设置为 debug。

要在不安装内存分配器调试钩子的情况下启用 Python 开发模式，请将 PYTHONMALLOC 环境变量设置为 default。
在 Python 启动时调用 faulthandler.enable()，为 SIGSEGV, SIGFPE, SIGABRT, SIGBUS 和 SIGILL 信号安装处理程序，以便在崩溃时转储 Python 回溯。

它的行为就像使用了 -X faulthandler 命令行选项，或者将 PYTHONFAULTHANDLER 环境变量设置为 1。
启用 asyncio 调试模式。例如，asyncio 会检查未等待的协程并记录它们。

它的行为就像 PYTHONASYNCIODEBUG 环境变量设置为 1。
检查字符串编码和解码操作的 encoding 和 errors 参数。示例：open(), str.encode() 和 bytes.decode()。

默认情况下，为了获得最佳性能，errors 参数仅在第一次编码/解码错误时检查，而对于空字符串，有时会忽略 encoding 参数。
io.IOBase 析构函数记录 close() 异常。
将 dev_mode 的 sys.flags 属性设置为 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 行

$ python script.py README.txt
269

启用 Python 开发模式会显示 ResourceWarning 警告

$ python -X dev script.py README.txt
269
script.py:10: ResourceWarning: unclosed file <_io.TextIOWrapper name='README.rst' mode='r' encoding='UTF-8'>
  main()
ResourceWarning: Enable tracemalloc to get the object allocation traceback

此外，启用 tracemalloc 会显示打开文件的行

$ python -X dev -X tracemalloc=5 script.py README.rst
269
script.py:10: ResourceWarning: unclosed file <_io.TextIOWrapper name='README.rst' mode='r' encoding='UTF-8'>
  main()
Object allocated at (most recent call last):
  File "script.py", lineno 10
    main()
  File "script.py", lineno 4
    fp = open(sys.argv[1])

修复方法是显式关闭文件。使用上下文管理器的示例

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 不会发出任何警告

$ python script.py
import os

Python 开发模式会显示 ResourceWarning，并在最终确定文件对象时记录 “错误的文件描述符” 错误

$ python -X dev script.py
import os
script.py:10: ResourceWarning: unclosed file <_io.TextIOWrapper name='script.py' mode='r' encoding='UTF-8'>
  main()
ResourceWarning: Enable tracemalloc to get the object allocation traceback
Exception ignored in: <_io.TextIOWrapper name='script.py' mode='r' encoding='UTF-8'>
Traceback (most recent call last):
  File "script.py", line 10, in <module>
    main()
OSError: [Errno 9] Bad file descriptor

os.close(fp.fileno()) 关闭文件描述符。当文件对象 finalizer 再次尝试关闭文件描述符时，它会因 Bad file descriptor 错误而失败。文件描述符只能关闭一次。在最坏的情况下，关闭两次可能会导致崩溃（例如，请参阅 bpo-18748）。

修复方法是删除 os.close(fp.fileno()) 行，或使用 closefd=False 打开文件。

Python 开发模式¶