rich.pretty

class rich.pretty.Node(key_repr='', value_repr='', open_brace='', close_brace='', empty='', last=False, is_tuple=False, is_namedtuple=False, children=None, key_separator=': ', separator=', ')

repr 树中的一个节点。可以是原子或容器。

参数

• key_repr (str) –

• value_repr (str) –

• open_brace (str) –

• close_brace (str) –

• empty (str) –

• last (bool) –

• is_tuple (bool) –

• is_namedtuple (bool) –

• children (Optional[List[Node]]) –

• key_separator (str) –

• separator (str) –

check_length(start_length, max_length)

检查长度是否在限制范围内。

参数

• start_length (int) – 行的起始长度（缩进、前缀、后缀）。

• max_length (int) – 最大长度。

返回值

如果节点可以在最大长度内渲染，则为 True，否则为 False。

返回值类型

bool

iter_tokens()

为该节点生成标记。

返回值类型

Iterable[str]

render(max_width=80, indent_size=4, expand_all=False)

将节点渲染为漂亮的 repr。

参数

• max_width (int, optional) – repr 的最大宽度。默认为 80。

• indent_size (int, optional) – 缩进的尺寸。默认为 4。

• expand_all (bool, optional) – 展开所有级别。默认为 False。

返回值

原始对象的 repr 字符串。

返回值类型

str

class rich.pretty.Pretty(_object, highlighter=None, *, indent_size=4, justify=None, overflow=None, no_wrap=False, indent_guides=False, max_length=None, max_string=None, max_depth=None, expand_all=False, margin=0, insert_line=False)

一个漂亮的 rich 可渲染对象，用于漂亮打印对象。

参数

• _object (Any) – 要漂亮打印的对象。

• highlighter (HighlighterType, optional) – 要应用于结果的高亮显示器对象，或 None 用于 ReprHighlighter。默认为 None。

• indent_size (int, optional) – 缩进中的空格数。默认为 4。

• justify (JustifyMethod, optional) – 对齐方式方法，或 None 用于默认值。默认为 None。

• overflow (OverflowMethod, optional) – 溢出方法，或 None 用于默认值。默认为 None。

• no_wrap (Optional[bool], optional) – 禁用自动换行。默认为 False。

• indent_guides (bool, optional) – 启用缩进指南。默认为 False。

• max_length (int, optional) – 在缩写之前容器的最大长度，或 None 用于不缩写。默认为 None。

• max_string (int, optional) – 在截断之前字符串的最大长度，或 None 用于禁用。默认为 None。

• max_depth (int, optional) – 嵌套数据结构的最大深度，或 None 用于没有最大值。默认为 None。

• expand_all (bool, optional) – 展开所有容器。默认为 False。

• margin (int, optional) – 从宽度中减去一个边距，以强制容器更早扩展。默认为 0。

• insert_line (bool, optional) – 如果输出有多个新行，则插入一个新行。默认为 False。

rich.pretty.install(console=None, overflow='ignore', crop=False, indent_guides=False, max_length=None, max_string=None, max_depth=None, expand_all=False)

在 Python REPL 中安装自动漂亮打印。

参数

• console (Console, optional) – 控制台实例或 None 以使用全局控制台。默认为 None。

• overflow (Optional[OverflowMethod], optional) – 溢出方法。默认为“ignore”。

• crop (Optional[bool], optional) – 启用长行的裁剪。默认为 False。

• indent_guides (bool, optional) – 启用缩进指南。默认为 False。

• max_length (int, optional) – 在缩写之前容器的最大长度，或 None 用于不缩写。默认为 None。

• max_string (int, optional) – 在截断之前字符串的最大长度，或 None 用于禁用。默认为 None。

• max_depth (int, optional) – 嵌套数据结构的最大深度，或 None 用于没有最大值。默认为 None。

• expand_all (bool, optional) – 展开所有容器。默认为 False。

• max_frames (int) – 在回溯中显示的最大帧数，0 表示无最大值。默认为 100。

返回值类型

None

rich.pretty.is_expandable(obj)

检查对象是否可以通过漂亮打印扩展。

参数

obj (Any) –

返回值类型

bool

rich.pretty.pprint(_object, *, console=None, indent_guides=True, max_length=None, max_string=None, max_depth=None, expand_all=False)

用于漂亮打印的便捷函数。

参数

• _object (Any) – 要漂亮打印的对象。

• console (Console, optional) – 控制台实例，或 None 以使用默认值。默认为 None。

• max_length (int, optional) – 在缩写之前容器的最大长度，或 None 用于不缩写。默认为 None。

• max_string (int, optional) – 字符串在截断之前的最大长度，或 None 以禁用。默认为 None。

• max_depth (int, optional) – 嵌套数据结构的最大深度，或 None 表示无限深度。默认为 None。

• indent_guides (bool, optional) – 启用缩进指南。默认为 True。

• expand_all (bool, optional) – 展开所有容器。默认为 False。

返回值类型

None

rich.pretty.pretty_repr(_object, *, max_width=80, indent_size=4, max_length=None, max_string=None, max_depth=None, expand_all=False)

通过扩展到新行以适应给定宽度来美化 repr 字符串。

参数

• _object (Any) – 要 repr 的对象。

• max_width (int, optional) – 期望的 repr 字符串的最大宽度。默认为 80。

• indent_size (int, optional) – 要缩进的空格数。默认为 4。

• max_length (int, optional) – 在缩写之前容器的最大长度，或 None 用于不缩写。默认为 None。

• max_string (int, optional) – 字符串在截断之前的最大长度，或 None 表示禁用截断。默认为 None。

• max_depth (int, optional) – 嵌套数据结构的最大深度，或 None 表示无深度。默认为 None。

• expand_all (bool, optional) – 无论可用宽度如何，都展开所有容器。默认为 False。

返回值

对象的可能多行表示。

返回值类型

str

rich.pretty.traverse(_object, max_length=None, max_string=None, max_depth=None)

遍历对象并生成树。

参数

• _object (Any) – 要遍历的对象。

• max_length (int, optional) – 在缩写之前容器的最大长度，或 None 用于不缩写。默认为 None。

• max_string (int, optional) – 字符串在截断之前的最大长度，或 None 表示禁用截断。默认为 None。

• max_depth (int, optional) – 数据结构的最大深度，或 None 表示无最大值。默认为 None。

返回值

可以用来渲染漂亮 repr 的树结构的根。

返回值类型

Node