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)

呈现回溯的控制台可呈现对象。

参数

• trace (Trace, optional) -- A Trace 产生自的对象 extract 。默认设置为None，即使用最后一个异常。

• width (Optional[int], optional) -- 用于回溯的字符数。默认为100。

• extra_lines (int, optional) -- 要呈现的其他代码行。默认为3。

• theme (str, optional) -- 覆盖回溯中使用的俾格森主题。

• word_wrap (bool, optional) -- 启用长行的自动换行。默认为False。

• show_locals (bool, optional) -- 启用局部变量的显示。默认为False。

• indent_guides (bool, optional) -- 在代码和本地变量中启用缩进辅助线。默认为True。

• locals_max_length (int, optional) -- 缩写前容器的最大长度，如果没有缩写，则为无。默认为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)

提取回溯信息。

参数

• exc_type (Type[BaseException]) -- 例外类型。

• exc_value (BaseException) -- 异常值。

• traceback (TracebackType) -- Python回溯对象。

• show_locals (bool, optional) -- 启用局部变量的显示。默认为False。

• locals_max_length (int, optional) -- 缩写前容器的最大长度，如果没有缩写，则为无。默认为10。

• locals_max_string (int, optional) -- 截断前字符串的最大长度，或禁用None。默认为80。

• locals_hide_dunder (bool, optional) -- 隐藏以双下划线为前缀的本地变量。默认为True。

• locals_hide_sunder (bool, optional) -- 隐藏以单下划线为前缀的本地变量。默认为False。

返回

一个跟踪实例，可用于构造 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)

从异常信息创建回溯

参数

• exc_type (Type[BaseException]) -- 例外类型。

• exc_value (BaseException) -- 异常值。

• traceback (TracebackType) -- Python回溯对象。

• width (Optional[int], optional) -- 用于回溯的字符数。默认为100。

• extra_lines (int, optional) -- 要呈现的其他代码行。默认为3。

• theme (str, optional) -- 覆盖回溯中使用的俾格森主题。

• word_wrap (bool, optional) -- 启用长行的自动换行。默认为False。

• show_locals (bool, optional) -- 启用局部变量的显示。默认为False。

• indent_guides (bool, optional) -- 在代码和本地变量中启用缩进辅助线。默认为True。

• locals_max_length (int, optional) -- 缩写前容器的最大长度，如果没有缩写，则为无。默认为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)

安装丰富的回溯处理程序。

一旦安装，任何回溯都将以语法突出显示和丰富的格式打印出来。

参数

• console (Optional[Console], optional) -- 要向其写入异常的控制台。默认使用内部控制台实例。

• width (Optional[int], optional) -- 追溯的宽度(以字符为单位)。默认为100。

• extra_lines (int, optional) -- 额外的代码行。默认为3。

• theme (Optional[str], optional) -- 要在回溯中使用的Pygments主题。默认为 None 它将选择一个适合平台的主题。

• word_wrap (bool, optional) -- 启用长行的自动换行。默认为False。

• show_locals (bool, optional) -- 启用局部变量的显示。默认为False。

• locals_max_length (int, optional) -- 缩写前容器的最大长度，如果没有缩写，则为无。默认为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) --

返回

被替换的上一个异常处理程序。

返回类型

Callable