Python标准库faulthandler——转储Python的跟踪信息

转储跟踪信息¶

faulthandler.dump_traceback(file=sys.stderr, all_threads=True)¶

将所有线程的跟踪数据转储到 file 中。如果 all_threads 为 False，则只转储当前线程。

在 3.5 版更改: 增加了向本函数传入文件描述符的支持。

错误处理程序的状态¶

faulthandler.enable(file=sys.stderr, all_threads=True)¶

启用故障处理程序：为 SIGSEGV 、 SIGFPE 、 SIGABRT 、 SIGBUS 和 SIGILL 信号安装处理程序，以转储 Python 跟踪信息。如果 all_threads 为 True，则会为每个运行中的线程生成跟踪信息。否则只转储当前线程。

该 文件 必须保持打开状态，直至禁用故障处理程序为止：参见 文件描述符相关话题。

在 3.5 版更改: 增加了向本函数传入文件描述符的支持。

在 3.6 版更改: 在 Windows 系统中，同时会安装一个 Windows 异常处理程序。

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