pip._vendor.rich.pretty.Pretty Class Reference

Inheritance diagram for pip._vendor.rich.pretty.Pretty:

Collaboration diagram for pip._vendor.rich.pretty.Pretty:

Public Member Functions
None	__init__ (self, Any _object, Optional["HighlighterType"] highlighter=None, *int indent_size=4, Optional["JustifyMethod"] justify=None, Optional["OverflowMethod"] overflow=None, Optional[bool] no_wrap=False, bool indent_guides=False, Optional[int] max_length=None, Optional[int] max_string=None, Optional[int] max_depth=None, bool expand_all=False, int margin=0, bool insert_line=False)
"RenderResult"	__rich_console__ (self, "Console" console, "ConsoleOptions" options)
"Measurement"	__rich_measure__ (self, "Console" console, "ConsoleOptions" options)

Public Attributes
	highlighter
	indent_size
	no_wrap
	indent_guides
	max_length
	max_string
	max_depth
	expand_all
	margin
	insert_line

Protected Attributes
	_object

Additional Inherited Members
Protected Member Functions inherited from pip._vendor.rich.jupyter.JupyterMixin
Dict[str, str]	_repr_mimebundle_ ("ConsoleRenderable" self, Sequence[str] include, Sequence[str] exclude, **Any kwargs)

Detailed Description

A rich renderable that pretty prints an object.

Args:
    _object (Any): An object to pretty print.
    highlighter (HighlighterType, optional): Highlighter object to apply to result, or None for ReprHighlighter. Defaults to None.
    indent_size (int, optional): Number of spaces in indent. Defaults to 4.
    justify (JustifyMethod, optional): Justify method, or None for default. Defaults to None.
    overflow (OverflowMethod, optional): Overflow method, or None for default. Defaults to None.
    no_wrap (Optional[bool], optional): Disable word wrapping. Defaults to False.
    indent_guides (bool, optional): Enable indentation guides. Defaults to False.
    max_length (int, optional): Maximum length of containers before abbreviating, or None for no abbreviation.
        Defaults to None.
    max_string (int, optional): Maximum length of string before truncating, or None to disable. Defaults to None.
    max_depth (int, optional): Maximum depth of nested data structures, or None for no maximum. Defaults to None.
    expand_all (bool, optional): Expand all containers. Defaults to False.
    margin (int, optional): Subtrace a margin from width to force containers to expand earlier. Defaults to 0.
    insert_line (bool, optional): Insert a new line if the output has multiple new lines. Defaults to False.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/rich/pretty.py