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。

返回

原始对象的epr字符串。

返回类型

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)[源代码]

一个丰富的可渲染的，漂亮地打印一个对象。

参数

  • _object (Any) -- 一个漂亮印刷的对象。

  • highlighter (HighlighterType, optional) -- 要应用于结果的高亮对象，或ReprHighlight为无。默认为无。

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

  • justify (JustifyMethod, optional) -- 方法，如果是默认的，则为None。默认为无。

  • overflow (OverflowMethod, optional) -- Overflow方法，或默认设置为None。默认为无。

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

  • indent_guides (bool, optional) -- 启用缩进辅助线。默认为False。

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

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

  • max_depth (int, optional) -- 嵌套数据结构的最大深度，如果没有最大深度，则为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)[源代码]

在PythonREPL中安装自动美观打印。

参数

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

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

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

  • indent_guides (bool, optional) -- 启用缩进辅助线。默认为False。

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

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

  • max_depth (int, optional) -- 嵌套数据结构的最大深度，如果没有最大深度，则为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) -- 控制台实例，或无以使用默认设置。默认为无。

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

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

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

  • 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) -- 要恢复的对象。

  • max_width (int, optional) -- 所需的REPR字符串的最大宽度。默认为80。

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

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

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

  • max_depth (int, optional) -- 嵌套数据结构的最大深度，如果没有深度，则为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) -- 缩写前容器的最大长度，如果没有缩写，则为无。默认为无。

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

  • max_depth (int, optional) -- 数据结构的最大深度，如果没有最大深度，则为NONE。默认为无。

返回

树结构的根，可以用来呈现漂亮的epr。

返回类型

Node