Rich
stable
Contents:
Introduction
Console API
Styles
Console Markup
Rich Text
Highlighting
Pretty Printing
Logging Handler
Traceback
Prompt
Columns
Render Groups
Markdown
Padding
Panel
Progress Display
Syntax
Tables
Tree
Live Display
Layout
Console Protocol
Reference
Appendix
Rich
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
__call__() (rich.highlighter.Highlighter method)
A
add() (rich.tree.Tree method)
add_column() (rich.table.Table method)
add_renderable() (rich.columns.Columns method)
add_row() (rich.table.Table method)
add_section() (rich.table.Table method)
add_split() (rich.layout.Layout method)
add_task() (rich.progress.Progress method)
adjust_line_length() (rich.segment.Segment class method)
advance() (rich.progress.Progress method)
Align (class in rich.align)
align() (rich.text.Text method)
align_bottom() (rich.segment.Segment class method)
align_middle() (rich.segment.Segment class method)
align_top() (rich.segment.Segment class method)
append() (rich.text.Text method)
append_text() (rich.text.Text method)
append_tokens() (rich.text.Text method)
apply_meta() (rich.text.Text method)
apply_style() (rich.segment.Segment class method)
ascii_only (rich.console.ConsoleOptions property)
ask() (rich.prompt.PromptBase class method)
assemble() (rich.text.Text class method)
B
background_style (rich.style.Style property)
Bar (class in rich.bar)
BarColumn (class in rich.progress)
begin_capture() (rich.console.Console method)
bell() (rich.console.Console method)
bgcolor (rich.style.Style property)
blank_copy() (rich.text.Text method)
blend_rgb() (in module rich.color)
BlockQuote (class in rich.markdown)
C
Capture (class in rich.console)
capture() (rich.console.Console method)
CaptureError
cell_len (rich.text.Text property)
cell_length (rich.segment.Segment attribute)
(rich.segment.Segment property)
cells (rich.table.Column property)
center() (rich.align.Align class method)
chain() (rich.style.Style class method)
check_choice() (rich.prompt.PromptBase method)
check_length() (rich.pretty.Node method)
children (rich.layout.Layout property)
clamp() (rich.measure.Measurement method)
clear() (rich.console.Console method)
clear_live() (rich.console.Console method)
clear_meta_and_links() (rich.style.Style method)
CodeBlock (class in rich.markdown)
Color (class in rich.color)
color (rich.style.Style property)
color_system (rich.console.Console property)
ColorParseError
ColorSystem (class in rich.color)
ColorType (class in rich.color)
Column (class in rich.table)
Columns (class in rich.columns)
ColumnSplitter (class in rich.layout)
combine() (rich.style.Style class method)
completed (rich.progress.ProgressSample property)
(rich.progress.Task attribute)
config (rich.theme.Theme property)
Confirm (class in rich.prompt)
Console (class in rich.console)
console (rich.status.Status property)
ConsoleDimensions (class in rich.console)
ConsoleOptions (class in rich.console)
ConsoleRenderable (class in rich.console)
ConsoleThreadLocals (class in rich.console)
control (rich.segment.Segment property)
control() (rich.console.Console method)
ControlType (class in rich.segment)
copy() (rich.console.ConsoleOptions method)
(rich.style.Style method)
(rich.table.Column method)
(rich.text.Text method)
copy_styles() (rich.text.Text method)
create() (rich.markdown.CodeBlock class method)
(rich.markdown.Heading class method)
(rich.markdown.ImageItem class method)
(rich.markdown.Link class method)
(rich.markdown.ListElement class method)
(rich.markdown.Paragraph class method)
(rich.markdown.TableDataElement class method)
current (rich.style.StyleStack property)
current_style (rich.markdown.MarkdownContext property)
D
default() (rich.color.Color class method)
description (rich.progress.Task attribute)
detect_indentation() (rich.text.Text method)
detect_legacy_windows() (in module rich.console)
divide() (rich.layout.ColumnSplitter method)
(rich.layout.RowSplitter method)
(rich.layout.Splitter method)
(rich.segment.Segment class method)
(rich.text.Text method)
downgrade() (rich.color.Color method)
DownloadColumn (class in rich.progress)
E
elapsed (rich.progress.Task property)
emit() (rich.logging.RichHandler method)
Emoji (class in rich.emoji)
encoding (rich.console.Console property)
(rich.console.ConsoleOptions attribute)
end_capture() (rich.console.Console method)
end_section (rich.table.Row attribute)
enter_style() (rich.markdown.MarkdownContext method)
escape() (in module rich.markup)
expand (rich.table.Table property)
expand_tabs() (rich.text.Text method)
export_html() (rich.console.Console method)
export_svg() (rich.console.Console method)
export_text() (rich.console.Console method)
extract() (rich.traceback.Traceback class method)
F
fields (rich.progress.Task attribute)
file (rich.console.Console property)
FileSizeColumn (class in rich.progress)
filter_control() (rich.segment.Segment class method)
finished (rich.progress.Progress property)
(rich.progress.Task property)
finished_speed (rich.progress.Task attribute)
finished_time (rich.progress.Task attribute)
fit() (rich.panel.Panel class method)
(rich.text.Text method)
flexible (rich.table.Column property)
FloatPrompt (class in rich.prompt)
footer (rich.table.Column attribute)
footer_style (rich.table.Column attribute)
from_ansi() (rich.color.Color class method)
(rich.text.Text class method)
from_color() (rich.style.Style class method)
from_data() (rich.json.JSON class method)
from_exception() (rich.traceback.Traceback class method)
from_file() (rich.theme.Theme class method)
from_markup() (rich.text.Text class method)
from_meta() (rich.style.Style class method)
from_path() (rich.syntax.Syntax class method)
from_rgb() (rich.color.Color class method)
from_triplet() (rich.color.Color class method)
G
get() (rich.console.Capture method)
(rich.layout.Layout method)
(rich.measure.Measurement class method)
get_ansi_codes() (rich.color.Color method)
get_console() (in module rich)
get_default_columns() (rich.progress.Progress class method)
get_html_style() (rich.style.Style method)
get_input() (rich.prompt.PromptBase class method)
get_level_text() (rich.logging.RichHandler method)
get_line_length() (rich.segment.Segment class method)
get_renderable() (rich.progress.Progress method)
get_renderables() (rich.progress.Progress method)
get_row_style() (rich.table.Table method)
get_shape() (rich.segment.Segment class method)
get_style() (rich.console.Console method)
get_style_at_offset() (rich.text.Text method)
get_table_column() (rich.progress.ProgressColumn method)
get_theme() (rich.syntax.Syntax class method)
get_time() (rich.progress.Task method)
get_tree_icon() (rich.layout.ColumnSplitter method)
(rich.layout.RowSplitter method)
(rich.layout.Splitter method)
get_truecolor() (rich.color.Color method)
grid() (rich.table.Table class method)
Group (class in rich.console)
group() (in module rich.console)
guess_lexer() (rich.syntax.Syntax class method)
H
header (rich.table.Column attribute)
header_style (rich.table.Column attribute)
Heading (class in rich.markdown)
height (rich.console.Console property)
(rich.console.ConsoleDimensions property)
highlight (rich.console.ConsoleOptions attribute)
highlight() (rich.highlighter.Highlighter method)
(rich.highlighter.JSONHighlighter method)
(rich.highlighter.NullHighlighter method)
(rich.highlighter.RegexHighlighter method)
(rich.syntax.Syntax method)
highlight_regex() (rich.text.Text method)
highlight_words() (rich.text.Text method)
Highlighter (class in rich.highlighter)
HIGHLIGHTER_CLASS (rich.logging.RichHandler attribute)
HorizontalRule (class in rich.markdown)
I
id (rich.progress.Task attribute)
ImageItem (class in rich.markdown)
indent() (rich.padding.Padding class method)
input() (rich.console.Console method)
inspect() (in module rich)
install() (in module rich.pretty)
(in module rich.traceback)
IntPrompt (class in rich.prompt)
InvalidResponse
is_alt_screen (rich.console.Console property)
is_control (rich.segment.Segment property)
is_default (rich.color.Color property)
is_dumb_terminal (rich.console.Console property)
is_expandable() (in module rich.pretty)
is_renderable() (in module rich.protocol)
is_started (rich.live.Live property)
is_system_defined (rich.color.Color property)
is_terminal (rich.console.Console property)
(rich.console.ConsoleOptions attribute)
ISO8601Highlighter (class in rich.highlighter)
iter_tokens() (rich.pretty.Node method)
J
join() (rich.text.Text method)
JSON (class in rich.json)
JSONHighlighter (class in rich.highlighter)
justify (rich.console.ConsoleOptions attribute)
(rich.table.Column attribute)
L
Layout (class in rich.layout)
LayoutError
LayoutRender (class in rich.layout)
leave_style() (rich.markdown.MarkdownContext method)
left() (rich.align.Align class method)
legacy_windows (rich.console.ConsoleOptions attribute)
lexer (rich.syntax.Syntax property)
line() (rich.console.Console method)
(rich.segment.Segment class method)
Link (class in rich.markdown)
link (rich.style.Style property)
link_id (rich.style.Style property)
ListElement (class in rich.markdown)
ListItem (class in rich.markdown)
Live (class in rich.live)
log() (rich.console.Console method)
M
make_prompt() (rich.prompt.PromptBase method)
make_tasks_table() (rich.progress.Progress method)
map (rich.layout.Layout property)
Markdown (class in rich.markdown)
MarkdownContext (class in rich.markdown)
markup (rich.console.ConsoleOptions attribute)
(rich.markup.Tag property)
(rich.text.Text property)
max_height (rich.console.ConsoleOptions attribute)
max_width (rich.console.ConsoleOptions attribute)
(rich.table.Column attribute)
maximum (rich.measure.Measurement property)
measure() (rich.console.Console method)
measure_renderables() (in module rich.measure)
Measurement (class in rich.measure)
meta (rich.style.Style property)
min_width (rich.console.ConsoleOptions attribute)
(rich.table.Column attribute)
minimum (rich.measure.Measurement property)
module
rich
rich.abc
rich.align
rich.bar
rich.color
rich.columns
rich.console
rich.emoji
rich.highlighter
rich.json
rich.layout
rich.live
rich.logging
rich.markdown
rich.markup
rich.measure
rich.padding
rich.panel
rich.pretty
rich.progress
rich.progress_bar
rich.prompt
rich.protocol
rich.rule
rich.segment
rich.spinner
rich.status
rich.style
rich.styled
rich.syntax
rich.table
rich.text
rich.theme
rich.traceback
rich.tree
MofNCompleteColumn (class in rich.progress)
N
name (rich.color.Color property)
(rich.markup.Tag property)
NewLine (class in rich.console)
no_wrap (rich.console.ConsoleOptions attribute)
(rich.table.Column attribute)
Node (class in rich.pretty)
normalize() (rich.measure.Measurement method)
(rich.style.Style class method)
NoSplitter
null() (rich.style.Style class method)
NullHighlighter (class in rich.highlighter)
number (rich.color.Color property)
O
on() (rich.style.Style class method)
(rich.text.Text method)
on_child_close() (rich.markdown.BlockQuote method)
(rich.markdown.ListElement method)
(rich.markdown.ListItem method)
(rich.markdown.TableBodyElement method)
(rich.markdown.TableElement method)
(rich.markdown.TableHeaderElement method)
(rich.markdown.TableRowElement method)
on_enter() (rich.markdown.Heading method)
(rich.markdown.ImageItem method)
(rich.markdown.TextElement method)
on_leave() (rich.markdown.TextElement method)
on_text() (rich.markdown.MarkdownContext method)
(rich.markdown.TableDataElement method)
(rich.markdown.TextElement method)
on_validate_error() (rich.prompt.PromptBase method)
open() (in module rich.progress)
(rich.progress.Progress method)
options (rich.console.Console property)
out() (rich.console.Console method)
overflow (rich.console.ConsoleOptions attribute)
(rich.table.Column attribute)
P
pad() (rich.text.Text method)
pad_left() (rich.text.Text method)
pad_right() (rich.text.Text method)
Padding (class in rich.padding)
padding (rich.table.Table property)
pager() (rich.console.Console method)
PagerContext (class in rich.console)
Panel (class in rich.panel)
Paragraph (class in rich.markdown)
parameters (rich.markup.Tag property)
parse() (rich.color.Color class method)
(rich.style.Style class method)
parse_rgb_hex() (in module rich.color)
percentage (rich.progress.Task property)
percentage_completed (rich.progress_bar.ProgressBar property)
pick_first() (rich.style.Style class method)
plain (rich.text.Text property)
pop() (rich.style.StyleStack method)
pop_render_hook() (rich.console.Console method)
pop_theme() (rich.console.Console method)
pprint() (in module rich.pretty)
pre_prompt() (rich.prompt.PromptBase method)
Pretty (class in rich.pretty)
pretty_repr() (in module rich.pretty)
print() (in module rich)
(rich.console.Console method)
print_exception() (rich.console.Console method)
print_json() (in module rich)
(rich.console.Console method)
process_renderables() (rich.console.RenderHook method)
(rich.live.Live method)
process_response() (rich.prompt.Confirm method)
(rich.prompt.PromptBase method)
Progress (class in rich.progress)
ProgressBar (class in rich.progress_bar)
ProgressColumn (class in rich.progress)
ProgressSample (class in rich.progress)
Prompt (class in rich.prompt)
PromptBase (class in rich.prompt)
PromptError
push() (rich.style.StyleStack method)
push_render_hook() (rich.console.Console method)
push_theme() (rich.console.Console method)
R
ratio (rich.table.Column attribute)
read() (rich.theme.Theme class method)
reconfigure() (in module rich)
refresh() (rich.live.Live method)
(rich.progress.Progress method)
refresh_screen() (rich.layout.Layout method)
RegexHighlighter (class in rich.highlighter)
region (rich.layout.LayoutRender property)
remaining (rich.progress.Task property)
remove_color() (rich.segment.Segment class method)
remove_suffix() (rich.text.Text method)
remove_task() (rich.progress.Progress method)
render (rich.layout.LayoutRender property)
render() (in module rich.markup)
(rich.console.Console method)
(rich.layout.Layout method)
(rich.logging.RichHandler method)
(rich.pretty.Node method)
(rich.progress.BarColumn method)
(rich.progress.DownloadColumn method)
(rich.progress.FileSizeColumn method)
(rich.progress.MofNCompleteColumn method)
(rich.progress.ProgressColumn method)
(rich.progress.RenderableColumn method)
(rich.progress.SpinnerColumn method)
(rich.progress.TaskProgressColumn method)
(rich.progress.TextColumn method)
(rich.progress.TimeElapsedColumn method)
(rich.progress.TimeRemainingColumn method)
(rich.progress.TotalFileSizeColumn method)
(rich.progress.TransferSpeedColumn method)
(rich.spinner.Spinner method)
(rich.style.Style method)
(rich.text.Text method)
render_default() (rich.prompt.Confirm method)
(rich.prompt.PromptBase method)
render_lines() (rich.console.Console method)
render_message() (rich.logging.RichHandler method)
render_speed() (rich.progress.TaskProgressColumn class method)
render_str() (rich.console.Console method)
renderable (rich.layout.Layout property)
(rich.live.Live property)
RenderableColumn (class in rich.progress)
RenderHook (class in rich.console)
replace() (rich.emoji.Emoji class method)
ReprHighlighter (class in rich.highlighter)
reset() (rich.progress.Progress method)
reset_height() (rich.console.ConsoleOptions method)
response_type (rich.prompt.Confirm attribute)
(rich.prompt.FloatPrompt attribute)
(rich.prompt.IntPrompt attribute)
(rich.prompt.Prompt attribute)
(rich.prompt.PromptBase attribute)
rich
module
rich.abc
module
rich.align
module
rich.bar
module
rich.color
module
rich.columns
module
rich.console
module
rich.emoji
module
rich.highlighter
module
rich.json
module
rich.layout
module
rich.live
module
rich.logging
module
rich.markdown
module
rich.markup
module
rich.measure
module
rich.padding
module
rich.panel
module
rich.pretty
module
rich.progress
module
rich.progress_bar
module
rich.prompt
module
rich.protocol
module
rich.rule
module
rich.segment
module
rich.spinner
module
rich.status
module
rich.style
module
rich.styled
module
rich.syntax
module
rich.table
module
rich.text
module
rich.theme
module
rich.traceback
module
rich.tree
module
rich_cast() (in module rich.protocol)
RichCast (class in rich.console)
RichHandler (class in rich.logging)
RichRenderable (class in rich.abc)
right() (rich.align.Align class method)
right_crop() (rich.text.Text method)
Row (class in rich.table)
row_count (rich.table.Table property)
RowSplitter (class in rich.layout)
rstrip() (rich.text.Text method)
rstrip_end() (rich.text.Text method)
Rule (class in rich.rule)
rule() (rich.console.Console method)
S
save_html() (rich.console.Console method)
save_svg() (rich.console.Console method)
save_text() (rich.console.Console method)
screen() (rich.console.Console method)
ScreenContext (class in rich.console)
ScreenUpdate (class in rich.console)
Segment (class in rich.segment)
Segments (class in rich.segment)
set_alt_screen() (rich.console.Console method)
set_length() (rich.text.Text method)
set_live() (rich.console.Console method)
set_shape() (rich.segment.Segment class method)
set_spinner() (rich.progress.SpinnerColumn method)
set_window_title() (rich.console.Console method)
show_cursor() (rich.console.Console method)
simplify() (rich.segment.Segment class method)
size (rich.console.Console property)
(rich.console.ConsoleOptions attribute)
span (rich.measure.Measurement property)
spans (rich.text.Text property)
speed (rich.progress.Task property)
Spinner (class in rich.spinner)
SpinnerColumn (class in rich.progress)
split() (rich.layout.Layout method)
(rich.text.Text method)
split_and_crop_lines() (rich.segment.Segment class method)
split_cells() (rich.segment.Segment method)
split_column() (rich.layout.Layout method)
split_lines() (rich.segment.Segment class method)
split_row() (rich.layout.Layout method)
Splitter (class in rich.layout)
start() (rich.live.Live method)
(rich.progress.Progress method)
(rich.status.Status method)
start_task() (rich.progress.Progress method)
start_time (rich.progress.Task attribute)
started (rich.progress.Task property)
Status (class in rich.status)
status() (rich.console.Console method)
stop() (rich.live.Live method)
(rich.progress.Progress method)
(rich.status.Status method)
stop_task() (rich.progress.Progress method)
stop_time (rich.progress.Task attribute)
strip_links() (rich.segment.Segment class method)
strip_styles() (rich.segment.Segment class method)
Style (class in rich.style)
style (rich.segment.Segment property)
(rich.table.Column attribute)
(rich.table.Row attribute)
Styled (class in rich.styled)
styled() (rich.text.Text class method)
StyleStack (class in rich.style)
stylize() (rich.text.Text method)
stylize_before() (rich.text.Text method)
stylize_range() (rich.syntax.Syntax method)
Syntax (class in rich.syntax)
system (rich.color.Color property)
T
Table (class in rich.table)
TableBodyElement (class in rich.markdown)
TableDataElement (class in rich.markdown)
TableElement (class in rich.markdown)
TableHeaderElement (class in rich.markdown)
TableRowElement (class in rich.markdown)
Tag (class in rich.markup)
Task (class in rich.progress)
task_ids (rich.progress.Progress property)
TaskProgressColumn (class in rich.progress)
tasks (rich.progress.Progress property)
test() (rich.style.Style method)
Text (class in rich.text)
text (rich.segment.Segment property)
TextColumn (class in rich.progress)
TextElement (class in rich.markdown)
Theme (class in rich.theme)
ThemeContext (class in rich.console)
time_remaining (rich.progress.Task property)
TimeElapsedColumn (class in rich.progress)
TimeRemainingColumn (class in rich.progress)
timestamp (rich.progress.ProgressSample property)
total (rich.progress.Task attribute)
TotalFileSizeColumn (class in rich.progress)
Traceback (class in rich.traceback)
track() (in module rich.progress)
(rich.progress.Progress method)
TransferSpeedColumn (class in rich.progress)
transparent_background (rich.style.Style property)
traverse() (in module rich.pretty)
Tree (class in rich.tree)
tree (rich.layout.Layout property)
triplet (rich.color.Color property)
truncate() (rich.text.Text method)
type (rich.color.Color property)
U
UnknownElement (class in rich.markdown)
unpack() (rich.padding.Padding static method)
unsplit() (rich.layout.Layout method)
update() (rich.console.ConsoleOptions method)
(rich.console.ScreenContext method)
(rich.layout.Layout method)
(rich.live.Live method)
(rich.progress.Progress method)
(rich.progress_bar.ProgressBar method)
(rich.spinner.Spinner method)
(rich.status.Status method)
update_dimensions() (rich.console.ConsoleOptions method)
update_height() (rich.console.ConsoleOptions method)
update_link() (rich.style.Style method)
update_screen() (rich.console.Console method)
update_screen_lines() (rich.console.Console method)
update_width() (rich.console.ConsoleOptions method)
use_theme() (rich.console.Console method)
V
vertical (rich.table.Column attribute)
VerticalCenter (class in rich.align)
visible (rich.progress.Task attribute)
W
width (rich.console.Console property)
(rich.console.ConsoleDimensions property)
(rich.table.Column attribute)
with_indent_guides() (rich.text.Text method)
with_maximum() (rich.measure.Measurement method)
with_minimum() (rich.measure.Measurement method)
without_color (rich.style.Style property)
wrap() (rich.text.Text method)
wrap_file() (in module rich.progress)
(rich.progress.Progress method)
Read the Docs
v: stable
Versions
latest
stable
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds