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()) 会关闭文件描述符。当文件对象终结器尝试再次关闭文件描述符时，它会失败并显示 错误文件描述符 错误。文件描述符只能关闭一次。在最坏的情况下，关闭两次可能会导致崩溃（有关示例，请参见 bpo-18748）。

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

Python 开发模式¶