rich

Rich text and beautiful formatting in the terminal.

rich.get_console()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: Any, *, console: Console = None, title: str = None, help: bool = False, methods: bool = False, docs: bool = True, private: bool = False, dunder: bool = False, sort: bool = True, all: bool = False, value: bool = True)[source]

Inspect any Python object.

  • inspect(<OBJECT>) to see summarized info.

  • inspect(<OBJECT>, methods=True) to see methods.

  • inspect(<OBJECT>, help=True) to see full (non-abbreviated) help.

  • inspect(<OBJECT>, private=True) to see private attributes (single underscore).

  • inspect(<OBJECT>, dunder=True) to see attributes beginning with double underscore.

  • inspect(<OBJECT>, 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.

rich.print(*objects: Any, sep=' ', end='\n', file: Optional[IO[str]] = None, flush: bool = 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.

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

Reconfigures the global console bu replacing it with another.

Parameters

console (Console) – Replacement console instance.