Rich library internals

This page is all about the rich python library, the contents below is auto-generated by inspecting a python package’s code base.

Package Files

• rich/__init__.py
• rich/__main__.py
• rich/_cell_widths.py
• rich/_emoji_codes.py
• rich/_emoji_replace.py
• rich/_extension.py
• rich/_inspect.py
• rich/_log_render.py
• rich/_loop.py
• rich/_lru_cache.py
• rich/_palettes.py
• rich/_pick.py
• rich/_ratio.py
• rich/_spinners.py
• rich/_stack.py
• rich/_timer.py
• rich/_windows.py
• rich/_wrap.py
• rich/abc.py
• rich/align.py
• rich/ansi.py
• rich/bar.py
• rich/box.py
• rich/cells.py
• rich/color.py
• rich/color_triplet.py
• rich/columns.py
• rich/console.py
• rich/constrain.py
• rich/containers.py
• rich/control.py
• rich/default_styles.py
• rich/diagnose.py
• rich/emoji.py
• rich/errors.py
• rich/file_proxy.py
• rich/filesize.py
• rich/highlighter.py
• rich/json.py
• rich/jupyter.py
• rich/layout.py
• rich/live.py
• rich/live_render.py
• rich/logging.py
• rich/markdown.py
• rich/markup.py
• rich/measure.py
• rich/padding.py
• rich/pager.py
• rich/palette.py
• rich/panel.py
• rich/pretty.py
• rich/progress.py
• rich/progress_bar.py
• rich/prompt.py
• rich/protocol.py
• rich/py.typed
• rich/region.py
• rich/repr.py
• rich/rule.py
• rich/scope.py
• rich/screen.py
• rich/segment.py
• rich/spinner.py
• rich/status.py
• rich/style.py
• rich/styled.py
• rich/syntax.py
• rich/table.py
• rich/tabulate.py
• rich/terminal_theme.py
• rich/text.py
• rich/theme.py
• rich/themes.py
• rich/traceback.py
• rich/tree.py

Package Classes

• <class ’typing.IO'>

Package Methods

rich.get_console()

and hasn’t been explicitly given one.

rich.get_console() -> 'Console'

rich.get_console(
)

rich.inspect()

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

rich.inspect(obj: Any, *, console: Optional[ForwardRef('Console')] = None, title: Optional[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) -> None

rich.inspect(
  obj,
  console,
  title,
  help,
  methods,
  docs,
  private,
  dunder,
  sort,
  all,
  value,
)

rich.load_ipython_extension()

rich.load_ipython_extension(ip: Any) -> None

rich.load_ipython_extension(
  ip,
)

rich.print()

This function has an identical signature to the built-in print. For more advanced features, see the :class:~rich.console.Console class.

rich.print(*objects: Any, sep: str = ' ', end: str = '\n', file: Optional[IO[str]] = None, flush: bool = False) -> None

rich.print(
  objects,
  sep,
  end,
  file,
  flush,
)

rich.print_json()

rich.print_json(json: Optional[str] = None, *, data: Any = None, indent: int = 2, highlight: bool = True, skip_keys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, default: Optional[Callable[[Any], Any]] = None, sort_keys: bool = False) -> None

rich.print_json(
  json,
  data,
  indent,
  highlight,
  skip_keys,
  ensure_ascii,
  check_circular,
  allow_nan,
  default,
  sort_keys,
)

rich.reconfigure()

rich.reconfigure(*args: Any, **kwargs: Any) -> None

rich.reconfigure(
  args,
  kwargs,
)