Rich text and beautiful formatting in the terminal.


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


A console instance.

Return type


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(<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.

  • 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 (Optional[Console]) –

Return type


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.

  • 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


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.

  • 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


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

Reconfigures the global console by replacing it with another.

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

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

Return type