Skip to content

rich 14.3.3

Version history | Download JSON

  • PyPI https://pypi.org/project/rich/
    Repository https://github.com/Textualize/rich

  • py.typed

  • Coverage

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "Typed" : 2204
    "Any" : 35
    "Untyped" : 396
    • 85.0% coverage
    • 83.6% coverage (strict)
    • 2635 typable
      • 2204 typed
      • 396 untyped
      • 35 Any

  • Typables

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "functions" : 227
    "classes" : 1908
    "other" : 164
    • 47 functions (+3 overloads)
      • 180 parameters
    • 156 classes
      • 567 methods (+4 overloads)
        • 1259 parameters
      • 73 properties
    • 57 modules
      • 164 attrs

Modules

Module Coverage Coverage (strict) Typables Ignores
rich 100.0% 84.8% 33 0
rich.abc 50.0% 50.0% 4 0
rich.align 80.0% 80.0% 60 0
rich.ansi 53.8% 53.8% 13 0
rich.bar 68.4% 68.4% 19 0
rich.box 90.0% 90.0% 40 0
rich.cells 100.0% 100.0% 25 0
rich.color 86.8% 86.8% 38 1
rich.color_triplet 100.0% 100.0% 3 0
rich.columns 59.3% 59.3% 27 0
rich.console 92.3% 90.4% 364 3
rich.constrain 81.8% 81.8% 11 0
rich.containers 100.0% 100.0% 35 0
rich.control 94.3% 94.3% 35 0
rich.default_styles 33.3% 33.3% 6 0
rich.diagnose 100.0% 100.0% 1 0
rich.emoji 70.6% 70.6% 17 0
rich.errors 0.0% 0.0% 0 0
rich.file_proxy 100.0% 90.0% 10 0
rich.filesize 100.0% 100.0% 4 0
rich.highlighter 94.4% 94.4% 18 0
rich.json 77.8% 74.1% 27 0
rich.jupyter 89.5% 68.4% 19 0
rich.layout 88.9% 88.9% 63 0
rich.live 76.7% 76.7% 43 0
rich.live_render 81.2% 81.2% 16 0
rich.logging 68.5% 68.5% 54 0
rich.markdown 86.3% 86.3% 197 0
rich.markup 76.9% 76.9% 13 0
rich.measure 100.0% 100.0% 17 0
rich.padding 81.0% 81.0% 21 0
rich.pager 85.7% 71.4% 7 0
rich.palette 81.8% 81.8% 11 0
rich.panel 71.7% 71.7% 53 0
rich.pretty 84.4% 77.9% 77 1
rich.progress 85.4% 84.2% 260 2
rich.progress_bar 71.4% 71.4% 42 0
rich.prompt 81.4% 81.4% 59 0
rich.protocol 100.0% 75.0% 4 0
rich.region 0.0% 0.0% 0 0
rich.repr 80.0% 80.0% 10 1
rich.rule 73.9% 73.9% 23 0
rich.scope 100.0% 100.0% 12 0
rich.screen 80.0% 80.0% 10 0
rich.segment 91.3% 91.3% 92 0
rich.spinner 76.9% 76.9% 26 0
rich.status 80.8% 80.8% 26 0
rich.style 85.0% 82.0% 100 0
rich.styled 75.0% 75.0% 12 0
rich.syntax 82.9% 82.9% 111 0
rich.table 81.1% 81.1% 122 0
rich.terminal_theme 38.5% 38.5% 13 0
rich.text 96.6% 95.5% 179 0
rich.theme 85.7% 85.7% 21 0
rich.themes 0.0% 0.0% 1 0
rich.traceback 83.2% 81.1% 95 0
rich.tree 58.3% 58.3% 36 0

Incomplete Annotations

rich (0 missing, 5 any)

Symbol Typable Typed Any
func reconfigure 3 3 2
func print 6 6 1
func inspect 12 12 1
func print_json 11 11 1

rich.abc (2 missing, 0 any)

Symbol Typable Typed Any
attr t 1 0 0
attr f 1 0 0

rich.align (12 missing, 0 any)

Symbol Typable Typed Any
attr highlighter 1 0 0
attr Align.renderable 1 0 0
attr Align.align 1 0 0
attr Align.style 1 0 0
attr Align.vertical 1 0 0
attr Align.pad 1 0 0
attr Align.width 1 0 0
attr Align.height 1 0 0
attr console 1 0 0
attr VerticalCenter.renderable 1 0 0
attr VerticalCenter.style 1 0 0
attr panel 1 0 0

rich.ansi (6 missing, 0 any)

Symbol Typable Typed Any
attr stdout_result 1 0 0
attr stdout 1 0 0
attr decoder 1 0 0
attr re_ansi 1 0 0
attr console 1 0 0
attr AnsiDecoder.style 1 0 0

rich.bar (6 missing, 0 any)

Symbol Typable Typed Any
meth Bar.init 7 6 0
attr Bar.size 1 0 0
attr Bar.begin 1 0 0
attr Bar.end 1 0 0
attr Bar.width 1 0 0
attr Bar.style 1 0 0

rich.box (4 missing, 0 any)

Symbol Typable Typed Any
attr columns 1 0 0
attr table 1 0 0
attr Box.ascii 1 0 0
attr console 1 0 0

rich.color (5 missing, 0 any)

Symbol Typable Typed Any
attr table 1 0 0
attr RE_COLOR 1 0 0
attr console 1 0 0
attr color_cell 1 0 0
attr colors 1 0 0

rich.columns (11 missing, 0 any)

Symbol Typable Typed Any
attr Columns.renderables 1 0 0
attr Columns.width 1 0 0
attr Columns.padding 1 0 0
attr Columns.expand 1 0 0
attr Columns.equal 1 0 0
attr Columns.column_first 1 0 0
attr Columns.right_to_left 1 0 0
attr Columns.title 1 0 0
attr console 1 0 0
attr files 1 0 0
attr columns 1 0 0

rich.console (28 missing, 7 any)

Symbol Typable Typed Any
attr PagerContext.pager 1 0 0
attr PagerContext.styles 1 0 0
attr PagerContext.links 1 0 0
attr NewLine.count 1 0 0
attr ThemeContext.console 1 0 0
attr ThemeContext.theme 1 0 0
attr ThemeContext.inherit 1 0 0
attr ScreenContext.console 1 0 0
attr ScreenContext.hide_cursor 1 0 0
attr ScreenContext.screen 1 0 0
attr NO_CHANGE 1 0 0
meth Console.init 29 28 0
meth Console.exit 4 4 3
meth Console.out 6 6 1
meth Console.print 16 16 1
meth Console.print_json 11 11 1
meth Console.log 11 11 1
attr Console.is_jupyter 1 0 0
attr Console.tab_size 1 0 0
attr Console.record 1 0 0
attr Console.soft_wrap 1 0 0
attr Console.quiet 1 0 0
attr Console.stderr 1 0 0
attr Console.safe_box 1 0 0
attr Console.get_datetime 1 0 0
attr Console.get_time 1 0 0
attr Console.style 1 0 0
attr Console.no_color 1 0 0
attr Console.is_interactive 1 0 0
attr console 1 0 0
attr Group.fit 1 0 0
attr ScreenUpdate.x 1 0 0
attr ScreenUpdate.y 1 0 0

rich.constrain (2 missing, 0 any)

Symbol Typable Typed Any
attr Constrain.renderable 1 0 0
attr Constrain.width 1 0 0

rich.control (2 missing, 0 any)

Symbol Typable Typed Any
attr console 1 0 0
attr Control.segment 1 0 0

rich.default_styles (4 missing, 0 any)

Symbol Typable Typed Any
attr table 1 0 0
attr parser 1 0 0
attr args 1 0 0
attr console 1 0 0

rich.emoji (5 missing, 0 any)

Symbol Typable Typed Any
attr console 1 0 0
attr Emoji.name 1 0 0
attr Emoji.style 1 0 0
attr Emoji.variant 1 0 0
attr columns 1 0 0

rich.file_proxy (0 missing, 1 any)

Symbol Typable Typed Any
meth FileProxy.getattr 2 2 1

rich.highlighter (1 missing, 0 any)

Symbol Typable Typed Any
attr console 1 0 0

rich.json (6 missing, 1 any)

Symbol Typable Typed Any
meth JSON.from_data 10 10 1
attr JSON.text 1 0 0
attr json_data 1 0 0
attr parser 1 0 0
attr args 1 0 0
attr console 1 0 0
attr error_console 1 0 0

rich.jupyter (2 missing, 4 any)

Symbol Typable Typed Any
meth JupyterMixin.repr_mimebundle 4 4 1
func print 3 3 2
meth JupyterRenderable.repr_mimebundle 4 4 1
attr JupyterRenderable.html 1 0 0
attr JupyterRenderable.text 1 0 0

rich.layout (7 missing, 0 any)

Symbol Typable Typed Any
attr layout 1 0 0
attr Layout.size 1 0 0
attr Layout.minimum_size 1 0 0
attr Layout.ratio 1 0 0
attr Layout.name 1 0 0
attr Layout.visible 1 0 0
attr console 1 0 0

rich.live (10 missing, 0 any)

Symbol Typable Typed Any
attr table 1 0 0
attr Live.console 1 0 0
attr Live.auto_refresh 1 0 0
attr Live.transient 1 0 0
attr Live.refresh_per_second 1 0 0
attr Live.vertical_overflow 1 0 0
attr syntax 1 0 0
attr examples 1 0 0
attr console 1 0 0
attr progress_renderables 1 0 0

rich.live_render (3 missing, 0 any)

Symbol Typable Typed Any
attr LiveRender.renderable 1 0 0
attr LiveRender.style 1 0 0
attr LiveRender.vertical_overflow 1 0 0

rich.logging (17 missing, 0 any)

Symbol Typable Typed Any
attr log 1 0 0
attr RichHandler.console 1 0 0
attr RichHandler.highlighter 1 0 0
attr RichHandler.enable_link_path 1 0 0
attr RichHandler.markup 1 0 0
attr RichHandler.rich_tracebacks 1 0 0
attr RichHandler.tracebacks_width 1 0 0
attr RichHandler.tracebacks_extra_lines 1 0 0
attr RichHandler.tracebacks_theme 1 0 0
attr RichHandler.tracebacks_word_wrap 1 0 0
attr RichHandler.tracebacks_show_locals 1 0 0
attr RichHandler.tracebacks_suppress 1 0 0
attr RichHandler.tracebacks_max_frames 1 0 0
attr RichHandler.tracebacks_code_width 1 0 0
attr RichHandler.locals_max_length 1 0 0
attr RichHandler.locals_max_string 1 0 0
attr RichHandler.keywords 1 0 0

rich.markdown (27 missing, 0 any)

Symbol Typable Typed Any
attr args 1 0 0
attr fileio 1 0 0
attr MarkdownContext.console 1 0 0
attr MarkdownContext.options 1 0 0
attr ImageItem.destination 1 0 0
attr ImageItem.hyperlinks 1 0 0
attr ListElement.list_type 1 0 0
attr ListElement.list_start 1 0 0
meth Link.init 3 2 0
attr Link.text 1 0 0
attr Link.href 1 0 0
attr Markdown.markup 1 0 0
attr Markdown.parsed 1 0 0
attr Markdown.code_theme 1 0 0
attr Markdown.style 1 0 0
attr Markdown.hyperlinks 1 0 0
attr Markdown.inline_code_lexer 1 0 0
attr Markdown.inline_code_theme 1 0 0
attr parser 1 0 0
attr markdown_body 1 0 0
attr CodeBlock.lexer_name 1 0 0
attr CodeBlock.theme 1 0 0
attr TableDataElement.justify 1 0 0
attr Heading.tag 1 0 0
attr Heading.style_name 1 0 0
attr console 1 0 0
attr markdown 1 0 0

rich.markup (3 missing, 0 any)

Symbol Typable Typed Any
attr RE_TAGS 1 0 0
attr grid 1 0 0
attr RE_HANDLER 1 0 0

rich.padding (4 missing, 0 any)

Symbol Typable Typed Any
meth Padding.init 5 4 0
attr Padding.renderable 1 0 0
attr Padding.style 1 0 0
attr Padding.expand 1 0 0

rich.pager (1 missing, 1 any)

Symbol Typable Typed Any
attr console 1 0 0
meth SystemPager._pager 2 2 1

rich.palette (2 missing, 0 any)

Symbol Typable Typed Any
attr console 1 0 0
meth Palette.init 2 1 0

rich.panel (15 missing, 0 any)

Symbol Typable Typed Any
attr Panel.renderable 1 0 0
attr Panel.box 1 0 0
attr Panel.title 1 0 0
attr Panel.subtitle 1 0 0
attr Panel.subtitle_align 1 0 0
attr Panel.safe_box 1 0 0
attr Panel.expand 1 0 0
attr Panel.style 1 0 0
attr Panel.border_style 1 0 0
attr Panel.width 1 0 0
attr Panel.height 1 0 0
attr Panel.padding 1 0 0
attr Panel.highlight 1 0 0
attr p 1 0 0
attr c 1 0 0

rich.pretty (12 missing, 5 any)

Symbol Typable Typed Any
func pprint 8 8 1
attr data 1 0 0
attr d 1 0 0
meth Pretty.init 14 14 1
attr Pretty.highlighter 1 0 0
attr Pretty.indent_size 1 0 0
attr Pretty.no_wrap 1 0 0
attr Pretty.indent_guides 1 0 0
attr Pretty.max_length 1 0 0
attr Pretty.max_string 1 0 0
attr Pretty.max_depth 1 0 0
attr Pretty.expand_all 1 0 0
attr Pretty.margin 1 0 0
attr Pretty.insert_line 1 0 0
func traverse 5 5 1
func pretty_repr 8 8 1
func is_expandable 2 2 1

rich.progress (38 missing, 3 any)

Symbol Typable Typed Any
attr BarColumn.bar_width 1 0 0
attr BarColumn.style 1 0 0
attr BarColumn.complete_style 1 0 0
attr BarColumn.finished_style 1 0 0
attr BarColumn.pulse_style 1 0 0
attr TextColumn.text_format 1 0 0
attr TextColumn.style 1 0 0
attr TextColumn.markup 1 0 0
attr TextColumn.highlighter 1 0 0
attr TaskProgressColumn.text_format_no_percentage 1 0 0
attr TaskProgressColumn.show_speed 1 0 0
meth SpinnerColumn.init 6 5 0
attr SpinnerColumn.spinner 1 0 0
attr SpinnerColumn.finished_text 1 0 0
attr task1 1 0 0
attr table 1 0 0
meth RenderableColumn.init 3 2 0
attr RenderableColumn.renderable 1 0 0
attr syntax 1 0 0
meth Progress.update 9 9 1
meth Progress.reset 8 8 1
meth Progress.add_task 7 7 1
attr Progress.columns 1 0 0
attr Progress.speed_estimate_period 1 0 0
attr Progress.disable 1 0 0
attr Progress.expand 1 0 0
attr Progress.live 1 0 0
attr Progress.get_time 1 0 0
attr Progress.print 1 0 0
attr Progress.log 1 0 0
attr examples 1 0 0
meth TimeRemainingColumn.init 4 3 0
attr TimeRemainingColumn.compact 1 0 0
attr TimeRemainingColumn.elapsed_when_finished 1 0 0
meth MofNCompleteColumn.init 3 2 0
attr MofNCompleteColumn.separator 1 0 0
attr DownloadColumn.binary_units 1 0 0
attr console 1 0 0
attr progress_renderables 1 0 0
attr task3 1 0 0
attr task2 1 0 0

rich.progress_bar (12 missing, 0 any)

Symbol Typable Typed Any
attr console 1 0 0
attr bar 1 0 0
meth ProgressBar.init 10 9 0
attr ProgressBar.total 1 0 0
attr ProgressBar.completed 1 0 0
attr ProgressBar.width 1 0 0
attr ProgressBar.pulse 1 0 0
attr ProgressBar.style 1 0 0
attr ProgressBar.complete_style 1 0 0
attr ProgressBar.finished_style 1 0 0
attr ProgressBar.pulse_style 1 0 0
attr ProgressBar.animation_time 1 0 0

rich.prompt (11 missing, 0 any)

Symbol Typable Typed Any
attr doggie 1 0 0
attr PromptBase.console 1 0 0
attr PromptBase.prompt 1 0 0
attr PromptBase.password 1 0 0
attr PromptBase.case_sensitive 1 0 0
attr PromptBase.show_default 1 0 0
attr PromptBase.show_choices 1 0 0
attr result 1 0 0
attr fruit 1 0 0
attr password 1 0 0
attr InvalidResponse.message 1 0 0

rich.protocol (0 missing, 1 any)

Symbol Typable Typed Any
func is_renderable 2 2 1

rich.repr (2 missing, 0 any)

Symbol Typable Typed Any
attr console 1 0 0
attr foo 1 0 0

rich.rule (6 missing, 0 any)

Symbol Typable Typed Any
attr console 1 0 0
attr Rule.title 1 0 0
attr Rule.characters 1 0 0
attr Rule.style 1 0 0
attr Rule.end 1 0 0
attr Rule.align 1 0 0

rich.screen (2 missing, 0 any)

Symbol Typable Typed Any
attr Screen.style 1 0 0
attr Screen.application_mode 1 0 0

rich.segment (8 missing, 0 any)

Symbol Typable Typed Any
attr text 1 0 0
attr Segments.segments 1 0 0
attr Segments.new_lines 1 0 0
attr fragments 1 0 0
attr log 1 0 0
attr console 1 0 0
attr SegmentLines.lines 1 0 0
attr SegmentLines.new_lines 1 0 0

rich.spinner (6 missing, 0 any)

Symbol Typable Typed Any
attr Spinner.name 1 0 0
attr Spinner.frames 1 0 0
attr Spinner.interval 1 0 0
attr Spinner.style 1 0 0
attr Spinner.speed 1 0 0
attr all_spinners 1 0 0

rich.status (5 missing, 0 any)

Symbol Typable Typed Any
attr console 1 0 0
meth Status.init 7 6 0
attr Status.status 1 0 0
attr Status.spinner_style 1 0 0
attr Status.speed 1 0 0

rich.style (15 missing, 3 any)

Symbol Typable Typed Any
attr NULL_STYLE 1 0 0
meth Style.init 18 17 0
meth Style.on 3 3 1
meth Style.eq 2 2 1
meth Style.ne 2 2 1
attr Style.bold 1 0 0
attr Style.dim 1 0 0
attr Style.italic 1 0 0
attr Style.underline 1 0 0
attr Style.blink 1 0 0
attr Style.blink2 1 0 0
attr Style.reverse 1 0 0
attr Style.conceal 1 0 0
attr Style.strike 1 0 0
attr Style.underline2 1 0 0
attr Style.frame 1 0 0
attr Style.encircle 1 0 0
attr Style.overline 1 0 0

rich.styled (3 missing, 0 any)

Symbol Typable Typed Any
attr Styled.renderable 1 0 0
attr Styled.style 1 0 0
attr panel 1 0 0

rich.syntax (19 missing, 0 any)

Symbol Typable Typed Any
attr Syntax.code 1 0 0
attr Syntax.dedent 1 0 0
attr Syntax.line_numbers 1 0 0
attr Syntax.start_line 1 0 0
attr Syntax.line_range 1 0 0
attr Syntax.highlight_lines 1 0 0
attr Syntax.code_width 1 0 0
attr Syntax.tab_size 1 0 0
attr Syntax.word_wrap 1 0 0
attr Syntax.background_color 1 0 0
attr Syntax.background_style 1 0 0
attr Syntax.indent_guides 1 0 0
attr Syntax.padding 1 0 0
attr parser 1 0 0
attr syntax 1 0 0
attr code 1 0 0
attr args 1 0 0
attr ANSISyntaxTheme.style_map 1 0 0
attr console 1 0 0

rich.table (23 missing, 0 any)

Symbol Typable Typed Any
attr Table.title 1 0 0
attr Table.caption 1 0 0
attr Table.width 1 0 0
attr Table.min_width 1 0 0
attr Table.box 1 0 0
attr Table.safe_box 1 0 0
attr Table.pad_edge 1 0 0
attr Table.show_header 1 0 0
attr Table.show_footer 1 0 0
attr Table.show_edge 1 0 0
attr Table.show_lines 1 0 0
attr Table.leading 1 0 0
attr Table.collapse_padding 1 0 0
attr Table.style 1 0 0
attr Table.header_style 1 0 0
attr Table.footer_style 1 0 0
attr Table.border_style 1 0 0
attr Table.title_style 1 0 0
attr Table.caption_style 1 0 0
attr Table.highlight 1 0 0
attr table 1 0 0
attr console 1 0 0
attr highlight 1 0 0

rich.terminal_theme (8 missing, 0 any)

Symbol Typable Typed Any
attr NIGHT_OWLISH 1 0 0
attr DEFAULT_TERMINAL_THEME 1 0 0
attr MONOKAI 1 0 0
attr SVG_EXPORT_THEME 1 0 0
attr DIMMED_MONOKAI 1 0 0
attr TerminalTheme.background_color 1 0 0
attr TerminalTheme.foreground_color 1 0 0
attr TerminalTheme.ansi_colors 1 0 0

rich.text (6 missing, 2 any)

Symbol Typable Typed Any
attr text 1 0 0
attr console 1 0 0
meth Text.add 2 2 1
meth Text.on 3 3 1
attr Text.style 1 0 0
attr Text.no_wrap 1 0 0
attr Text.end 1 0 0
attr Text.tab_size 1 0 0

rich.theme (3 missing, 0 any)

Symbol Typable Typed Any
meth Theme.init 3 2 0
attr theme 1 0 0
attr ThemeStack.get 1 0 0

rich.themes (1 missing, 0 any)

Symbol Typable Typed Any
attr DEFAULT 1 0 0

rich.traceback (16 missing, 2 any)

Symbol Typable Typed Any
meth Traceback.init 17 16 0
attr Traceback.trace 1 0 0
attr Traceback.width 1 0 0
attr Traceback.code_width 1 0 0
attr Traceback.extra_lines 1 0 0
attr Traceback.theme 1 0 0
attr Traceback.word_wrap 1 0 0
attr Traceback.show_locals 1 0 0
attr Traceback.indent_guides 1 0 0
attr Traceback.locals_max_length 1 0 0
attr Traceback.locals_max_string 1 0 0
attr Traceback.locals_max_depth 1 0 0
attr Traceback.locals_hide_dunder 1 0 0
attr Traceback.locals_hide_sunder 1 0 0
attr Traceback.locals_overflow 1 0 0
attr Traceback.max_frames 1 0 0
func bar 2 2 1
func foo 2 2 1

rich.tree (15 missing, 0 any)

Symbol Typable Typed Any
attr table 1 0 0
attr node 1 0 0
attr root 1 0 0
attr syntax 1 0 0
attr panel 1 0 0
attr console 1 0 0
attr Tree.label 1 0 0
attr Tree.style 1 0 0
attr Tree.guide_style 1 0 0
attr Tree.expanded 1 0 0
attr Tree.highlight 1 0 0
attr Tree.hide_root 1 0 0
attr markdown 1 0 0
attr simple_node 1 0 0
attr containers_node 1 0 0

Type-Ignore Comments

Flavor Count
type: ignore[union-attr] 3
type: ignore[attr-defined] 2
type: ignore[has-type] 1
type: ignore[no-untyped-def, override] 1
type: ignore[override] 1