Skip to content

rs_rich.pretty

Generated from the type stubs by scripts/gen_python_api.py; do not edit.

rich.pretty: Pretty, Node, traverse, pretty_repr, pprint and install.

install is _native.pretty_install (rich.traceback has an install too, so the compiled module names them apart).

Node

key_repr instance-attribute

key_repr: str

value_repr instance-attribute

value_repr: str

open_brace instance-attribute

open_brace: str

close_brace instance-attribute

close_brace: str

empty instance-attribute

empty: str

last instance-attribute

last: bool

is_tuple instance-attribute

is_tuple: bool

is_namedtuple instance-attribute

is_namedtuple: bool

children instance-attribute

children: Optional[List[Node]]

key_separator instance-attribute

key_separator: str

separator instance-attribute

separator: str

iter_tokens

iter_tokens() -> Iterator[str]

check_length

check_length(start_length: int, max_length: int) -> bool

render

render(max_width: int = 80, indent_size: int = 4, expand_all: bool = False) -> str

Pretty

indent_size instance-attribute

indent_size: int

justify instance-attribute

justify: Optional[JustifyMethod]

overflow instance-attribute

overflow: Optional[OverflowMethod]

no_wrap instance-attribute

no_wrap: Optional[bool]

indent_guides instance-attribute

indent_guides: bool

max_length instance-attribute

max_length: Optional[int]

max_string instance-attribute

max_string: Optional[int]

max_depth instance-attribute

max_depth: Optional[int]

expand_all instance-attribute

expand_all: bool

margin instance-attribute

margin: int

insert_line instance-attribute

insert_line: bool

highlighter property

highlighter: Callable[[Union[str, Text]], Text]

pprint

pprint(_object: Any, *, console: Optional[Console] = None, indent_guides: bool = True, max_length: Optional[int] = None, max_string: Optional[int] = None, max_depth: Optional[int] = None, expand_all: bool = False) -> None

pretty_repr

pretty_repr(_object: Any, *, max_width: int = 80, indent_size: int = 4, max_length: Optional[int] = None, max_string: Optional[int] = None, max_depth: Optional[int] = None, expand_all: bool = False) -> str

traverse

traverse(_object: Any, max_length: Optional[int] = None, max_string: Optional[int] = None, max_depth: Optional[int] = None) -> Node