rich — Rich 14.0.0 documentation (original) (raw)

Rich text and beautiful formatting in the terminal.

rich.get_console()[source]¶

Get a global Console instance. This function is used when Rich requires a Console, and hasn’t been explicitly given one.

Returns:

A console instance.

Return type:

Console

rich.inspect(obj, *, console=None, title=None, help=False, methods=False, docs=True, private=False, dunder=False, sort=True, all=False, value=True)[source]¶

Inspect any Python object.

• inspect() to see summarized info.
• inspect(, methods=True) to see methods.
• inspect(, help=True) to see full (non-abbreviated) help.
• inspect(, private=True) to see private attributes (single underscore).
• inspect(, dunder=True) to see attributes beginning with double underscore.
• inspect(, all=True) to see all attributes.

Parameters:

• obj (Any) – An object to inspect.
• title (str, optional) – Title to display over inspect result, or None use type. Defaults to None.
• help (bool, optional) – Show full help text rather than just first paragraph. Defaults to False.
• methods (bool, optional) – Enable inspection of callables. Defaults to False.
• docs (bool, optional) – Also render doc strings. Defaults to True.
• private (bool, optional) – Show private attributes (beginning with underscore). Defaults to False.
• dunder (bool, optional) – Show attributes starting with double underscore. Defaults to False.
• sort (bool, optional) – Sort attributes alphabetically. Defaults to True.
• all (bool, optional) – Show all attributes. Defaults to False.
• value (bool, optional) – Pretty print value. Defaults to True.
• console (Console | None)

Return type:

None

rich.print(*objects, sep=' ', end='\n', file=None, flush=False)[source]¶

Print object(s) supplied via positional arguments. This function has an identical signature to the built-in print. For more advanced features, see the Console class.

Parameters:

• sep (str, optional) – Separator between printed objects. Defaults to “ “.
• end (str, optional) – Character to write at end of output. Defaults to “\n”.
• file (IO _[_str] , optional) – File to write to, or None for stdout. Defaults to None.
• flush (bool, optional) – Has no effect as Rich always flushes output. Defaults to False.
• objects (Any)

Return type:

None

rich.print_json(json=None, *, data=None, indent=2, highlight=True, skip_keys=False, ensure_ascii=False, check_circular=True, allow_nan=True, default=None, sort_keys=False)[source]¶

Pretty prints JSON. Output will be valid JSON.

Parameters:

• json (str) – A string containing JSON.
• data (Any) – If json is not supplied, then encode this data.
• indent (int, optional) – Number of spaces to indent. Defaults to 2.
• highlight (bool, optional) – Enable highlighting of output: Defaults to True.
• skip_keys (bool, optional) – Skip keys not of a basic type. Defaults to False.
• ensure_ascii (bool, optional) – Escape all non-ascii characters. Defaults to False.
• check_circular (bool, optional) – Check for circular references. Defaults to True.
• allow_nan (bool, optional) – Allow NaN and Infinity values. Defaults to True.
• default (Callable , optional) – A callable that converts values that can not be encoded in to something that can be JSON encoded. Defaults to None.
• sort_keys (bool, optional) – Sort dictionary keys. Defaults to False.

Return type:

None

rich.reconfigure(*args, **kwargs)[source]¶

Reconfigures the global console by replacing it with another.

Parameters:

• *args (Any) – Positional arguments for the replacement Console.
• **kwargs (Any) – Keyword arguments for the replacement Console.

Return type:

None