rich.console¶

class rich.console.Capture(console: rich.console.Console)[source]¶

Context manager to capture the result of printing to the console. See capture() for how to use.

Parameters: console (Console) – A console instance to capture output.

get() → str[source]¶: Get the result of the capture.

exception rich.console.CaptureError[source]¶: An error in the Capture context manager.

class rich.console.Console(*, color_system: Optional[typing_extensions.Literal[auto, standard, 256, truecolor, windows]] = 'auto', force_terminal: Optional[bool] = None, force_jupyter: Optional[bool] = None, force_interactive: Optional[bool] = None, soft_wrap: bool = False, theme: Optional[rich.theme.Theme] = None, stderr: bool = False, file: Optional[IO[str]] = None, quiet: bool = False, width: Optional[int] = None, height: Optional[int] = None, style: Optional[Union[str, rich.style.Style]] = None, no_color: Optional[bool] = None, tab_size: int = 8, record: bool = False, markup: bool = True, emoji: bool = True, emoji_variant: Optional[typing_extensions.Literal[emoji, text]] = None, highlight: bool = True, log_time: bool = True, log_path: bool = True, log_time_format: Union[str, Callable[[datetime.datetime], rich.text.Text]] = '[%X]', highlighter: Optional[Callable[[Union[str, Text]], Text]] = <rich.highlighter.ReprHighlighter object>, legacy_windows: Optional[bool] = None, safe_box: bool = True, get_datetime: Optional[Callable[[], datetime.datetime]] = None, get_time: Optional[Callable[[], float]] = None, _environ: Optional[Mapping[str, str]] = None)[source]¶

A high level console interface.

Parameters

color_system (str, optional) – The color system supported by your terminal, either "standard", "256" or "truecolor". Leave as "auto" to autodetect.
force_terminal (Optional[bool], optional) – Enable/disable terminal control codes, or None to auto-detect terminal. Defaults to None.
force_jupyter (Optional[bool], optional) – Enable/disable Jupyter rendering, or None to auto-detect Jupyter. Defaults to None.
force_interactive (Optional[bool], optional) – Enable/disable interactive mode, or None to auto detect. Defaults to None.
soft_wrap (Optional[bool], optional) – Set soft wrap default on print method. Defaults to False.
theme (Theme, optional) – An optional style theme object, or None for default theme.
stderr (bool, optional) – Use stderr rather than stdout if file is not specified. Defaults to False.
file (IO, optional) – A file object where the console should write to. Defaults to stdout.
quiet (bool, Optional) – Boolean to suppress all output. Defaults to False.
width (int, optional) – The width of the terminal. Leave as default to auto-detect width.
height (int, optional) – The height of the terminal. Leave as default to auto-detect height.
style (StyleType, optional) – Style to apply to all output, or None for no style. Defaults to None.
no_color (Optional[bool], optional) – Enabled no color mode, or None to auto detect. Defaults to None.
tab_size (int, optional) – Number of spaces used to replace a tab character. Defaults to 8.
record (bool, optional) – Boolean to enable recording of terminal output, required to call export_html() and export_text(). Defaults to False.
markup (bool, optional) – Boolean to enable Console Markup. Defaults to True.
emoji (bool, optional) – Enable emoji code. Defaults to True.
emoji_variant (str, optional) – Optional emoji variant, either “text” or “emoji”. Defaults to None.
highlight (bool, optional) – Enable automatic highlighting. Defaults to True.
log_time (bool, optional) – Boolean to enable logging of time by log() methods. Defaults to True.
log_path (bool, optional) – Boolean to enable the logging of the caller by log(). Defaults to True.
log_time_format (Union[str, TimeFormatterCallable], optional) – If log_time is enabled, either string for strftime or callable that formats the time. Defaults to “[%X] “.
highlighter (HighlighterType, optional) – Default highlighter.
legacy_windows (bool, optional) – Enable legacy Windows mode, or None to auto detect. Defaults to None.
safe_box (bool, optional) – Restrict box options that don’t render on legacy Windows.
get_datetime (Callable[[], datetime], optional) – Callable that gets the current time as a datetime.datetime object (used by Console.log), or None for datetime.now.
get_time (Callable[[], time], optional) – Callable that gets the current time in seconds, default uses time.monotonic.

begin_capture() → None[source]¶: Begin capturing console output. Call end_capture() to exit capture mode and return output.

bell() → None[source]¶: Play a ‘bell’ sound (if supported by the terminal).

capture() → rich.console.Capture[source]¶

A context manager to capture the result of print() or log() in a string, rather than writing it to the console.

Example

>>> from rich.console import Console
>>> console = Console()
>>> with console.capture() as capture:
...     console.print("[bold magenta]Hello World[/]")
>>> print(capture.get())

Returns: Context manager with disables writing to the terminal.
Return type: Capture

clear(home: bool = True) → None[source]¶

Clear the screen.

Parameters: home (bool, optional) – Also move the cursor to ‘home’ position. Defaults to True.

clear_live() → None[source]¶: Clear the Live instance.

property color_system: Optional[str]¶

Get color system string.

Returns: “standard”, “256” or “truecolor”.
Return type: Optional[str]

control(*control: rich.control.Control) → None[source]¶

Insert non-printing control codes.

Parameters: control_codes (str) – Control codes, such as those that may move the cursor.

property encoding: str¶

Get the encoding of the console file, e.g. "utf-8".

Returns: A standard encoding string.
Return type: str

end_capture() → str[source]¶

End capture mode and return captured string.

Returns: Console output.
Return type: str

export_html(*, theme: Optional[rich.terminal_theme.TerminalTheme] = None, clear: bool = True, code_format: Optional[str] = None, inline_styles: bool = False) → str[source]¶

Generate HTML from console contents (requires record=True argument in constructor).

Parameters

theme (TerminalTheme, optional) – TerminalTheme object containing console colors.
clear (bool, optional) – Clear record buffer after exporting. Defaults to True.
code_format (str, optional) – Format string to render HTML, should contain {foreground} {background} and {code}.
inline_styles (bool, optional) – If True styles will be inlined in to spans, which makes files larger but easier to cut and paste markup. If False, styles will be embedded in a style tag. Defaults to False.

Returns

String containing console contents as HTML.

Return type

str

export_text(*, clear: bool = True, styles: bool = False) → str[source]¶

Generate text from console contents (requires record=True argument in constructor).

Parameters

clear (bool, optional) – Clear record buffer after exporting. Defaults to True.
styles (bool, optional) – If True, ansi escape codes will be included. False for plain text. Defaults to False.

Returns

String containing console contents.

Return type

str

property file: IO[str]¶: Get the file object to write to.

get_style(name: Union[str, rich.style.Style], *, default: Optional[Union[str, rich.style.Style]] = None) → rich.style.Style[source]¶

Get a Style instance by it’s theme name or parse a definition.

Parameters: name (str) – The name of a style or a style definition.
Returns: A Style object.
Return type: Style
Raises: MissingStyle – If no style could be parsed from name.

property height: int¶

Get the height of the console.

Returns: The height (in lines) of the console.
Return type: int

input(prompt: Union[str, rich.text.Text] = '', *, markup: bool = True, emoji: bool = True, password: bool = False, stream: Optional[TextIO] = None) → str[source]¶

Displays a prompt and waits for input from the user. The prompt may contain color / style.

Parameters

prompt (Union[str, Text]) – Text to render in the prompt.
markup (bool, optional) – Enable console markup (requires a str prompt). Defaults to True.
emoji (bool, optional) – Enable emoji (requires a str prompt). Defaults to True.
password – (bool, optional): Hide typed text. Defaults to False.
stream – (TextIO, optional): Optional file to read input from (rather than stdin). Defaults to None.

Returns

Text read from stdin.

Return type

str

property is_alt_screen: bool¶

Check if the alt screen was enabled.

Returns: True if the alt screen was enabled, otherwise False.
Return type: bool

property is_dumb_terminal: bool¶

Detect dumb terminal.

Returns: True if writing to a dumb terminal, otherwise False.
Return type: bool

property is_terminal: bool¶

Check if the console is writing to a terminal.

Returns: True if the console writing to a device capable of understanding terminal codes, otherwise False.
Return type: bool

line(count: int = 1) → None[source]¶

Write new line(s).

Parameters: count (int, optional) – Number of new lines. Defaults to 1.

log(*objects: Any, sep: str = ' ', end: str = '\n', style: Optional[Union[str, rich.style.Style]] = None, justify: Optional[typing_extensions.Literal[default, left, center, right, full]] = None, emoji: Optional[bool] = None, markup: Optional[bool] = None, highlight: Optional[bool] = None, log_locals: bool = False, _stack_offset: int = 1) → None[source]¶

Log rich content to the terminal.

Parameters

objects (positional args) – Objects to log to the terminal.
sep (str, optional) – String to write between print data. Defaults to ” “.
end (str, optional) – String to write at end of print data. Defaults to “\n”.
style (Union[str, Style], optional) – A style to apply to output. Defaults to None.
justify (str, optional) – One of “left”, “right”, “center”, or “full”. Defaults to None.
overflow (str, optional) – Overflow method: “crop”, “fold”, or “ellipsis”. Defaults to None.
emoji (Optional[bool], optional) – Enable emoji code, or None to use console default. Defaults to None.
markup (Optional[bool], optional) – Enable markup, or None to use console default. Defaults to None.
highlight (Optional[bool], optional) – Enable automatic highlighting, or None to use console default. Defaults to None.
log_locals (bool, optional) – Boolean to enable logging of locals where log() was called. Defaults to False.
_stack_offset (int, optional) – Offset of caller from end of call stack. Defaults to 1.

measure(renderable: Union[rich.console.ConsoleRenderable, rich.console.RichCast, str], *, options: Optional[rich.console.ConsoleOptions] = None) → rich.measure.Measurement[source]¶

Measure a renderable. Returns a Measurement object which contains information regarding the number of characters required to print the renderable.

Parameters

renderable (RenderableType) – Any renderable or string.
options (Optional[ConsoleOptions], optional) – Options to use when measuring, or None to use default options. Defaults to None.

Returns

A measurement of the renderable.

Return type

Measurement

property options: rich.console.ConsoleOptions¶: Get default console options.

out(*objects: Any, sep: str = ' ', end: str = '\n', style: Optional[Union[str, rich.style.Style]] = None, highlight: Optional[bool] = None) → None[source]¶

Output to the terminal. This is a low-level way of writing to the terminal which unlike print() won’t pretty print, wrap text, or apply markup, but will optionally apply highlighting and a basic style.

Parameters

sep (str, optional) – String to write between print data. Defaults to ” “.
end (str, optional) – String to write at end of print data. Defaults to “\n”.
style (Union[str, Style], optional) – A style to apply to output. Defaults to None.
highlight (Optional[bool], optional) – Enable automatic highlighting, or None to use console default. Defaults to None.

pager(pager: Optional[rich.pager.Pager] = None, styles: bool = False, links: bool = False) → rich.console.PagerContext[source]¶

A context manager to display anything printed within a “pager”. The pager application is defined by the system and will typically support at least pressing a key to scroll.

Parameters

pager (Pager, optional) – A pager object, or None to use :class:~rich.pager.SystemPager`. Defaults to None.
styles (bool, optional) – Show styles in pager. Defaults to False.
links (bool, optional) – Show links in pager. Defaults to False.

Example

>>> from rich.console import Console
>>> from rich.__main__ import make_test_card
>>> console = Console()
>>> with console.pager():
        console.print(make_test_card())

Returns: A context manager.
Return type: PagerContext

pop_render_hook() → None[source]¶: Pop the last renderhook from the stack.

pop_theme() → None[source]¶: Remove theme from top of stack, restoring previous theme.

print(*objects: Any, sep: str = ' ', end: str = '\n', style: Optional[Union[str, rich.style.Style]] = None, justify: Optional[typing_extensions.Literal[default, left, center, right, full]] = None, overflow: Optional[typing_extensions.Literal[fold, crop, ellipsis, ignore]] = None, no_wrap: Optional[bool] = None, emoji: Optional[bool] = None, markup: Optional[bool] = None, highlight: Optional[bool] = None, width: Optional[int] = None, height: Optional[int] = None, crop: bool = True, soft_wrap: Optional[bool] = None, new_line_start: bool = False) → None[source]¶

Print to the console.

Parameters

objects (positional args) – Objects to log to the terminal.
sep (str, optional) – String to write between print data. Defaults to ” “.
end (str, optional) – String to write at end of print data. Defaults to “\n”.
style (Union[str, Style], optional) – A style to apply to output. Defaults to None.
justify (str, optional) – Justify method: “default”, “left”, “right”, “center”, or “full”. Defaults to None.
overflow (str, optional) – Overflow method: “ignore”, “crop”, “fold”, or “ellipsis”. Defaults to None.
no_wrap (Optional[bool], optional) – Disable word wrapping. Defaults to None.
emoji (Optional[bool], optional) – Enable emoji code, or None to use console default. Defaults to None.
markup (Optional[bool], optional) – Enable markup, or None to use console default. Defaults to None.
highlight (Optional[bool], optional) – Enable automatic highlighting, or None to use console default. Defaults to None.
width (Optional[int], optional) – Width of output, or None to auto-detect. Defaults to None.
crop (Optional[bool], optional) – Crop output to width of terminal. Defaults to True.
soft_wrap (bool, optional) – Enable soft wrap mode which disables word wrapping and cropping of text or None for Console default. Defaults to None.
new_line_start (bool, False) – Insert a new line at the start if the output contains more than one line. Defaults to False.

print_exception(*, width: Optional[int] = 100, extra_lines: int = 3, theme: Optional[str] = None, word_wrap: bool = False, show_locals: bool = False) → None[source]¶

Prints a rich render of the last exception and traceback.

Parameters

width (Optional[int], optional) – Number of characters used to render code. Defaults to 88.
extra_lines (int, optional) – Additional lines of code to render. Defaults to 3.
theme (str, optional) – Override pygments theme used in traceback
word_wrap (bool, optional) – Enable word wrapping of long lines. Defaults to False.
show_locals (bool, optional) – Enable display of local variables. Defaults to False.

print_json(json: Optional[str] = None, *, data: Optional[Any] = None, indent: int = 2, highlight: bool = True) → None[source]¶

Pretty prints JSON. Output will be valid JSON.

Parameters

json (Optional[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.

push_render_hook(hook: rich.console.RenderHook) → None[source]¶

Add a new render hook to the stack.

Parameters: hook (RenderHook) – Render hook instance.

push_theme(theme: rich.theme.Theme, *, inherit: bool = True) → None[source]¶

Push a new theme on to the top of the stack, replacing the styles from the previous theme. Generally speaking, you should call use_theme() to get a context manager, rather than calling this method directly.

Parameters

theme (Theme) – A theme instance.
inherit (bool, optional) – Inherit existing styles. Defaults to True.

render(renderable: Union[rich.console.ConsoleRenderable, rich.console.RichCast, str], options: Optional[rich.console.ConsoleOptions] = None) → Iterable[rich.segment.Segment][source]¶

Render an object in to an iterable of Segment instances.

This method contains the logic for rendering objects with the console protocol. You are unlikely to need to use it directly, unless you are extending the library.

Parameters

renderable (RenderableType) – An object supporting the console protocol, or an object that may be converted to a string.
options (ConsoleOptions, optional) – An options object, or None to use self.options. Defaults to None.

Returns

An iterable of segments that may be rendered.

Return type

Iterable[Segment]

render_lines(renderable: Union[rich.console.ConsoleRenderable, rich.console.RichCast, str], options: Optional[rich.console.ConsoleOptions] = None, *, style: Optional[rich.style.Style] = None, pad: bool = True, new_lines: bool = False) → List[List[rich.segment.Segment]][source]¶

Render objects in to a list of lines.

The output of render_lines is useful when further formatting of rendered console text is required, such as the Panel class which draws a border around any renderable object.

Args:
renderable (RenderableType): Any object renderable in the console. options (Optional[ConsoleOptions], optional): Console options, or None to use self.options. Default to None. style (Style, optional): Optional style to apply to renderables. Defaults to None. pad (bool, optional): Pad lines shorter than render width. Defaults to True. new_lines (bool, optional): Include “

” characters at end of lines.

Returns:
List[List[Segment]]: A list of lines, where a line is a list of Segment objects.

render_str(text: str, *, style: Union[str, rich.style.Style] = '', justify: Optional[typing_extensions.Literal[default, left, center, right, full]] = None, overflow: Optional[typing_extensions.Literal[fold, crop, ellipsis, ignore]] = None, emoji: Optional[bool] = None, markup: Optional[bool] = None, highlight: Optional[bool] = None, highlighter: Optional[Callable[[Union[str, rich.text.Text]], rich.text.Text]] = None) → rich.text.Text[source]¶

Convert a string to a Text instance. This is is called automatically if you print or log a string.

Parameters

text (str) – Text to render.
style (Union[str, Style], optional) – Style to apply to rendered text.
justify (str, optional) – Justify method: “default”, “left”, “center”, “full”, or “right”. Defaults to None.
overflow (str, optional) – Overflow method: “crop”, “fold”, or “ellipsis”. Defaults to None.
emoji (Optional[bool], optional) – Enable emoji, or None to use Console default.
markup (Optional[bool], optional) – Enable markup, or None to use Console default.
highlight (Optional[bool], optional) – Enable highlighting, or None to use Console default.
highlighter (HighlighterType, optional) – Optional highlighter to apply.

Returns

Renderable object.

Return type

ConsoleRenderable

rule(title: Union[str, rich.text.Text] = '', *, characters: str = '─', style: Union[str, rich.style.Style] = 'rule.line', align: typing_extensions.Literal[left, center, right] = 'center') → None[source]¶

Draw a line with optional centered title.

Parameters

title (str, optional) – Text to render over the rule. Defaults to “”.
characters (str, optional) – Character(s) to form the line. Defaults to “─”.
style (str, optional) – Style of line. Defaults to “rule.line”.
align (str, optional) – How to align the title, one of “left”, “center”, or “right”. Defaults to “center”.

save_html(path: str, *, theme: Optional[rich.terminal_theme.TerminalTheme] = None, clear: bool = True, code_format: str = '<!DOCTYPE html>\n<head>\n<meta charset="UTF-8">\n<style>\n{stylesheet}\nbody {{\n color: {foreground};\n background-color: {background};\n}}\n</style>\n</head>\n<html>\n<body>\n <code>\n <pre style="font-family:Menlo,\'DejaVu Sans Mono\',consolas,\'Courier New\',monospace">{code}</pre>\n </code>\n</body>\n</html>\n', inline_styles: bool = False) → None[source]¶

Generate HTML from console contents and write to a file (requires record=True argument in constructor).

Parameters

path (str) – Path to write html file.
theme (TerminalTheme, optional) – TerminalTheme object containing console colors.
clear (bool, optional) – Clear record buffer after exporting. Defaults to True.
code_format (str, optional) – Format string to render HTML, should contain {foreground} {background} and {code}.
inline_styles (bool, optional) – If True styles will be inlined in to spans, which makes files larger but easier to cut and paste markup. If False, styles will be embedded in a style tag. Defaults to False.

save_text(path: str, *, clear: bool = True, styles: bool = False) → None[source]¶

Generate text from console and save to a given location (requires record=True argument in constructor).

Parameters

path (str) – Path to write text files.
clear (bool, optional) – Clear record buffer after exporting. Defaults to True.
styles (bool, optional) – If True, ansi style codes will be included. False for plain text. Defaults to False.

screen(hide_cursor: bool = True, style: Optional[Union[str, rich.style.Style]] = None) → rich.console.ScreenContext[source]¶

Context manager to enable and disable ‘alternative screen’ mode.

Parameters

hide_cursor (bool, optional) – Also hide the cursor. Defaults to False.
style (Style, optional) – Optional style for screen. Defaults to None.

Returns

Context which enables alternate screen on enter, and disables it on exit.

Return type

~ScreenContext

set_alt_screen(enable: bool = True) → bool[source]¶

Enables alternative screen mode.

Note, if you enable this mode, you should ensure that is disabled before the application exits. See screen() for a context manager that handles this for you.

Parameters: enable (bool, optional) – Enable (True) or disable (False) alternate screen. Defaults to True.
Returns: True if the control codes were written.
Return type: bool

set_live(live: Live) → None[source]¶

Set Live instance. Used by Live context manager.

Parameters: live (Live) – Live instance using this Console.
Raises: errors.LiveError – If this Console has a Live context currently active.

show_cursor(show: bool = True) → bool[source]¶

Show or hide the cursor.

Parameters: show (bool, optional) – Set visibility of the cursor.

property size: rich.console.ConsoleDimensions¶

Get the size of the console.

Returns: A named tuple containing the dimensions.
Return type: ConsoleDimensions

status(status: Union[rich.console.ConsoleRenderable, rich.console.RichCast, str], *, spinner: str = 'dots', spinner_style: str = 'status.spinner', speed: float = 1.0, refresh_per_second: float = 12.5) → Status[source]¶

Display a status and spinner.

Parameters

status (RenderableType) – A status renderable (str or Text typically).
spinner (str, optional) – Name of spinner animation (see python -m rich.spinner). Defaults to “dots”.
spinner_style (StyleType, optional) – Style of spinner. Defaults to “status.spinner”.
speed (float, optional) – Speed factor for spinner animation. Defaults to 1.0.
refresh_per_second (float, optional) – Number of refreshes per second. Defaults to 12.5.

Returns

A Status object that may be used as a context manager.

Return type

Status

update_screen(renderable: Union[rich.console.ConsoleRenderable, rich.console.RichCast, str], *, region: Optional[rich.region.Region] = None, options: Optional[rich.console.ConsoleOptions] = None) → None[source]¶

Update the screen at a given offset.

Parameters

renderable (RenderableType) – A Rich renderable.
region (Region, optional) – Region of screen to update, or None for entire screen. Defaults to None.
x (int, optional) – x offset. Defaults to 0.
y (int, optional) – y offset. Defaults to 0.

Raises

errors.NoAltScreen – If the Console isn’t in alt screen mode.

update_screen_lines(lines: List[List[rich.segment.Segment]], x: int = 0, y: int = 0) → None[source]¶

Update lines of the screen at a given offset.

Parameters

lines (List[List[Segment]]) – Rendered lines (as produced by render_lines()).
x (int, optional) – x offset (column no). Defaults to 0.
y (int, optional) – y offset (column no). Defaults to 0.

Raises

errors.NoAltScreen – If the Console isn’t in alt screen mode.

use_theme(theme: rich.theme.Theme, *, inherit: bool = True) → rich.console.ThemeContext[source]¶

Use a different theme for the duration of the context manager.

Parameters

theme (Theme) – Theme instance to user.
inherit (bool, optional) – Inherit existing console styles. Defaults to True.

Returns

[description]

Return type

ThemeContext

property width: int¶

Get the width of the console.

Returns: The width (in characters) of the console.
Return type: int

class rich.console.ConsoleDimensions(width: int, height: int)[source]¶

Size of the terminal.

property height¶: The height of the console in lines.

property width¶: The width of the console in ‘cells’.

class rich.console.ConsoleOptions(size: rich.console.ConsoleDimensions, legacy_windows: bool, min_width: int, max_width: int, is_terminal: bool, encoding: str, max_height: int, justify: Optional[typing_extensions.Literal[default, left, center, right, full]] = None, overflow: Optional[typing_extensions.Literal[fold, crop, ellipsis, ignore]] = None, no_wrap: Optional[bool] = False, highlight: Optional[bool] = None, markup: Optional[bool] = None, height: Optional[int] = None)[source]¶

Options for __rich_console__ method.

property ascii_only: bool¶: Check if renderables should use ascii only.

copy() → rich.console.ConsoleOptions[source]¶

Return a copy of the options.

Returns: a copy of self.
Return type: ConsoleOptions

encoding: str¶: Encoding of terminal.

highlight: Optional[bool] = None¶: Highlight override for render_str.

is_terminal: bool¶: True if the target is a terminal, otherwise False.

justify: Optional[typing_extensions.Literal[default, left, center, right, full]] = None¶: Justify value override for renderable.

legacy_windows: bool¶

flag for legacy windows.

Type: legacy_windows

markup: Optional[bool] = None¶: Enable markup when rendering strings.

max_height: int¶: Height of container (starts as terminal)

max_width: int¶: Maximum width of renderable.

min_width: int¶: Minimum width of renderable.

no_wrap: Optional[bool] = False¶: Disable wrapping for text.

overflow: Optional[typing_extensions.Literal[fold, crop, ellipsis, ignore]] = None¶: Overflow value override for renderable.

size: rich.console.ConsoleDimensions¶: Size of console.

update(*, width: Union[int, rich.console.NoChange] = <rich.console.NoChange object>, min_width: Union[int, rich.console.NoChange] = <rich.console.NoChange object>, max_width: Union[int, rich.console.NoChange] = <rich.console.NoChange object>, justify: Union[typing_extensions.Literal[default, left, center, right, full], None, rich.console.NoChange] = <rich.console.NoChange object>, overflow: Union[typing_extensions.Literal[fold, crop, ellipsis, ignore], None, rich.console.NoChange] = <rich.console.NoChange object>, no_wrap: Union[bool, None, rich.console.NoChange] = <rich.console.NoChange object>, highlight: Union[bool, None, rich.console.NoChange] = <rich.console.NoChange object>, markup: Union[bool, None, rich.console.NoChange] = <rich.console.NoChange object>, height: Union[int, None, rich.console.NoChange] = <rich.console.NoChange object>) → rich.console.ConsoleOptions[source]¶: Update values, return a copy.

update_dimensions(width: int, height: int) → rich.console.ConsoleOptions[source]¶

Update the width and height, and return a copy.

Parameters

width (int) – New width (sets both min_width and max_width).
height (int) – New height.

Returns

New console options instance.

Return type

~ConsoleOptions

update_width(width: int) → rich.console.ConsoleOptions[source]¶

Update just the width, return a copy.

Parameters: width (int) – New width (sets both min_width and max_width)
Returns: New console options instance.
Return type: ~ConsoleOptions

class rich.console.ConsoleRenderable(*args, **kwds)[source]¶: An object that supports the console protocol.

class rich.console.ConsoleThreadLocals(theme_stack: rich.theme.ThemeStack, buffer: List[rich.segment.Segment] = <factory>, buffer_index: int = 0)[source]¶: Thread local values for Console context.

class rich.console.Group(*renderables: Union[rich.console.ConsoleRenderable, rich.console.RichCast, str], fit: bool = True)[source]¶

Takes a group of renderables and returns a renderable object that renders the group.

Parameters

renderables (Iterable[RenderableType]) – An iterable of renderable objects.
fit (bool, optional) – Fit dimension of group to contents, or fill available space. Defaults to True.

class rich.console.NewLine(count: int = 1)[source]¶: A renderable to generate new line(s)

class rich.console.PagerContext(console: rich.console.Console, pager: Optional[rich.pager.Pager] = None, styles: bool = False, links: bool = False)[source]¶: A context manager that ‘pages’ content. See pager() for usage.

rich.console.RenderGroup¶: alias of rich.console.Group

class rich.console.RenderHook[source]¶

Provides hooks in to the render process.

abstract process_renderables(renderables: List[rich.console.ConsoleRenderable]) → List[rich.console.ConsoleRenderable][source]¶

Called with a list of objects to render.

This method can return a new list of renderables, or modify and return the same list.

Parameters: renderables (List[ConsoleRenderable]) – A number of renderable objects.
Returns: A replacement list of renderables.
Return type: List[ConsoleRenderable]

rich.console.RenderResult¶

The result of calling a __rich_console__ method.

alias of Iterable[Union[rich.console.ConsoleRenderable, rich.console.RichCast, str, rich.segment.Segment]]

rich.console.RenderableType¶

A type that may be rendered by Console.

alias of Union[rich.console.ConsoleRenderable, rich.console.RichCast, str]

class rich.console.RichCast(*args, **kwds)[source]¶: An object that may be ‘cast’ to a console renderable.

class rich.console.ScreenContext(console: rich.console.Console, hide_cursor: bool, style: Union[str, rich.style.Style] = '')[source]¶

A context manager that enables an alternative screen. See screen() for usage.

update(*renderables: Union[rich.console.ConsoleRenderable, rich.console.RichCast, str], style: Optional[Union[str, rich.style.Style]] = None) → None[source]¶

Update the screen.

Parameters

renderable (RenderableType, optional) – Optional renderable to replace current renderable, or None for no change. Defaults to None.
style – (Style, optional): Replacement style, or None for no change. Defaults to None.

class rich.console.ScreenUpdate(lines: List[List[rich.segment.Segment]], x: int, y: int)[source]¶: Render a list of lines at a given offset.

class rich.console.ThemeContext(console: rich.console.Console, theme: rich.theme.Theme, inherit: bool = True)[source]¶: A context manager to use a temporary theme. See use_theme() for usage.

rich.console.detect_legacy_windows() → bool[source]¶: Detect legacy Windows.

rich.console.group(fit: bool = True) → Callable[[...], Callable[[...], rich.console.Group]][source]¶

A decorator that turns an iterable of renderables in to a group.

Parameters: fit (bool, optional) – Fit dimension of group to contents, or fill available space. Defaults to True.

rich.console.render_group(fit: bool = True) → Callable[[...], Callable[[...], rich.console.Group]]¶

A decorator that turns an iterable of renderables in to a group.

Parameters: fit (bool, optional) – Fit dimension of group to contents, or fill available space. Defaults to True.