traceback– 打印或检索堆栈追溯

源代码： Lib / traceback.py

该模块提供了一个标准接口，用于提取，格式化和打印Python程序的堆栈跟踪。它在打印堆栈跟踪时完全模仿了Python解释器的行为。当您想要在程序控制下打印堆栈跟踪时，这非常有用，例如在解释器周围的“包装器”中

该模块使用traceback对象 – 这是存储在sys.last_traceback变量中的对象类型，并作为sys.exc_info().

的第三项返回。该模块定义了以下函数：

traceback.print_tb（tb, limit=None, file=None）

如果limit为正，则打印最多tb来自追踪对象limit的堆栈跟踪条目（从调用者的框架开始）。否则，打印最后的abs(limit)条目。如果省略limit或None，所有条目都已打印。如果省略file或None，则输出到sys.stderr;否则它应该是一个打开的文件或类似文件的对象来接收输出.

更改版本3.5：添加否定limit support.

traceback.print_exception(etype, value, tb, limit=None, file=None, chain=True)

从traceback对象tb打印异常信息和堆栈跟踪条目到file。这与print_tb()的不同之处在于：

• 如果tb不是None，它打印一个标题Traceback (most recentcall last):
• 它会在堆栈跟踪etype之后打印value和

• 异常type(value)是SyntaxError和value具有相应的格式，它打印出语法错误发生的行，同时指示错误的大致位置.

可选limit参数与print_tb()的含义相同。如果chain为真（默认值），则链接异常（__cause__或__context__异常的属性也将被打印出来，就像解释器本身在打印unhandledexception时所做的那样.

在版本3.5中更改：etype参数被忽略并从的类型推断出来value.

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()的含义相同。“预处理”堆栈traceentry是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）

的含义相同，给出一个元组列表或FrameSummary由extract_tb()或extract_stack()返回的对象，返回准备打印的字符串列表。结果列表中的每个字符串对应于参数列表中具有相同索引的项。每个字符串以换行符结尾;对于源文本行不是None.

traceback.format_exception_only（etype, value）

格式化回溯的异常部分的那些项，字符串也可能包含内部换行符。参数是异常类型和值，例如sys.last_type和sys.last_value给出的值。返回值是一个字符串列表，每个字符串以换行符结尾。通常，列表包含单个字符串;但是，对于SyntaxError例外，它包含几行（打印时）显示有关语法错误发生位置的详细信息。指示发生异常的消息是列表中的始终最后一个字符串.

traceback.format_exception（etype, value, tb, limit=None, chain=True）

格式化堆栈跟踪和异常信息。参数与print_exception()。其中的值是一个字符串列表，每个字符串以换行符结尾，一些包含内部换行符。连接和打印这些行时，打印的文本与print_exception().

更改版本3.5： etype参数被忽略并从value.

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）

清除回溯中所有堆栈帧的局部变量tb通过拨打clear()每个框架对象的方法.

版本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中的新功能

该模块还定义了以下类：

import sys, tracebackdef 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, tracebackdef lumberjack():    bright_side_of_death()def bright_side_of_death():    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:")    # exc_type below is ignored on 3.5 and later    traceback.print_exception(exc_type, exc_value, exc_traceback,                              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:")    # exc_type below is ignored on 3.5 and later    print(repr(traceback.format_exception(exc_type, exc_value,                                          exc_traceback)))    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_death()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_death()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_death()\n", "  File "<doctest...>", line 7, in bright_side_of_death\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_death>]*** format_tb:["  File "<doctest...>", line 10, in <module>\n    lumberjack()\n", "  File "<doctest...>", line 4, in lumberjack\n    bright_side_of_death()\n", "  File "<doctest...>", line 7, in bright_side_of_death\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"]