rich.traceback¶

class rich.traceback.Traceback(trace=None, *, width=100, extra_lines=3, theme=None, word_wrap=False, show_locals=False, locals_max_length=10, locals_max_string=80, locals_hide_dunder=True, locals_hide_sunder=False, indent_guides=True, suppress=(), max_frames=100)[source]¶

一个控制台可渲染对象，用于渲染回溯。

参数

trace (Trace, optional) – 由 extract 生成的 Trace 对象。默认值为 None，它使用最后一个异常。
width (Optional[int], optional) – 用于回溯的字符数。默认值为 100。
extra_lines (int, optional) – 要渲染的额外代码行数。默认值为 3。
theme (str, optional) – 覆盖回溯中使用的 pygments 主题。
word_wrap (bool, optional) – 启用长行的断词换行。默认值为 False。
show_locals (bool, optional) – 启用显示局部变量。默认值为 False。
indent_guides (bool, optional) – 启用代码和局部变量中的缩进指南。默认值为 True。
locals_max_length (int, optional) – 容器在缩写之前允许的最大长度，或者为 None 表示不缩写。默认值为 10。
locals_max_string (int, optional) – 字符串在截断之前允许的最大长度，或者为 None 表示禁用。默认值为 80。
locals_hide_dunder (bool, optional) – 隐藏以双下划线开头的局部变量。默认值为 True。
locals_hide_sunder (bool, optional) – 隐藏以单个下划线开头的局部变量。默认值为 False。
suppress (Sequence[Union[str, ModuleType]]) – 可选的模块或路径序列，用于从回溯中排除。
max_frames (int) – 回溯中显示的帧数最大值，0 表示无最大值。默认值为 100。

classmethod extract(exc_type, exc_value, traceback, *, show_locals=False, locals_max_length=10, locals_max_string=80, locals_hide_dunder=True, locals_hide_sunder=False)[source]¶

提取回溯信息。

参数

exc_type (Type[BaseException]) – 异常类型。
exc_value (BaseException) – 异常值。
traceback (TracebackType) – Python 回溯对象。
show_locals (bool, optional) – 启用显示局部变量。默认值为 False。
locals_max_length (int, optional) – 容器在缩写之前允许的最大长度，或者为 None 表示不缩写。默认值为 10。
locals_max_string (int, optional) – 字符串在截断之前允许的最大长度，或者为 None 表示禁用。默认值为 80。
locals_hide_dunder (bool, optional) – 隐藏以双下划线开头的局部变量。默认值为 True。
locals_hide_sunder (bool, optional) – 隐藏以单个下划线开头的局部变量。默认值为 False。

返回值

一个 Trace 实例，你可以用它来构造一个 Traceback。

返回类型

Trace

classmethod from_exception(exc_type, exc_value, traceback, *, width=100, extra_lines=3, theme=None, word_wrap=False, show_locals=False, locals_max_length=10, locals_max_string=80, locals_hide_dunder=True, locals_hide_sunder=False, indent_guides=True, suppress=(), max_frames=100)[source]¶

从异常信息创建回溯

参数

exc_type (Type[BaseException]) – 异常类型。
exc_value (BaseException) – 异常值。
traceback (TracebackType) – Python 回溯对象。
width (Optional[int], optional) – 用于回溯的字符数。默认值为 100。
extra_lines (int, optional) – 要渲染的额外代码行数。默认值为 3。
theme (str, optional) – 覆盖回溯中使用的 pygments 主题。
word_wrap (bool, optional) – 启用长行的断词换行。默认值为 False。
show_locals (bool, optional) – 启用显示局部变量。默认值为 False。
indent_guides (bool, optional) – 启用代码和局部变量中的缩进指南。默认值为 True。
locals_max_length (int, optional) – 容器在缩写之前允许的最大长度，或者为 None 表示不缩写。默认值为 10。
locals_max_string (int, optional) – 字符串在截断之前允许的最大长度，或者为 None 表示禁用。默认值为 80。
locals_hide_dunder (bool, optional) – 隐藏以双下划线开头的局部变量。默认值为 True。
locals_hide_sunder (bool, optional) – 隐藏以单个下划线开头的局部变量。默认值为 False。
suppress (Iterable[Union[str, ModuleType]]) – 可选的模块或路径序列，用于从回溯中排除。
max_frames (int) – 回溯中显示的帧数最大值，0 表示无最大值。默认值为 100。

返回值

一个可以打印的 Traceback 实例。

返回类型

回溯

rich.traceback.install(*, console=None, width=100, extra_lines=3, theme=None, word_wrap=False, show_locals=False, locals_max_length=10, locals_max_string=80, locals_hide_dunder=True, locals_hide_sunder=None, indent_guides=True, suppress=(), max_frames=100)[source]¶

安装富 traceback 处理程序。

安装后，所有 traceback 都会以语法高亮和富格式打印。

参数

console (可选[Console], 可选) – 写入异常的控制台。默认使用内部 Console 实例。
width (可选[int], 可选) – traceback 的宽度（以字符为单位）。默认为 100。
extra_lines (int, 可选) – 额外的代码行。默认为 3。
theme (可选[str], 可选) – traceback 中使用的 Pygments 主题。默认为 None，它将选择适合平台的主题。
word_wrap (bool, optional) – 启用长行的断词换行。默认值为 False。
show_locals (bool, optional) – 启用显示局部变量。默认值为 False。
locals_max_length (int, optional) – 容器在缩写之前允许的最大长度，或者为 None 表示不缩写。默认值为 10。
locals_max_string (int, optional) – 字符串在截断之前允许的最大长度，或者为 None 表示禁用。默认值为 80。
locals_hide_dunder (bool, optional) – 隐藏以双下划线开头的局部变量。默认值为 True。
locals_hide_sunder (bool, optional) – 隐藏以单个下划线开头的局部变量。默认值为 False。
indent_guides (bool, optional) – 启用代码和局部变量中的缩进指南。默认值为 True。
suppress (Sequence[Union[str, ModuleType]]) – 可选的模块或路径序列，用于从回溯中排除。
max_frames (int) –

返回值

先前被替换的异常处理程序。

返回类型

可调用对象