2bi
% S SK r S SKrS SKrS SKrS SKrS SKrS SKJrJr S SK J
r
J r S SK J r S SK
Jr S SKJr S SKJr S SK Jr S S KJr S S
KJr S S KJr S S KJrJrJ r S S
K J r J r J r J!r!J"r"J#r#J$r$J%r%J&r&J'r'J(r(J)r)J*r*J+r+J,r, S SK-J.r. \R^ S: a S SK J0r0J1r1J2r2 O
S SK3J0r0J1r1J2r2 SSK4J5r5J6r6 SSK7J7r7 SSK8J9r9J:r: SSK;Jr>J?r? SSK@JArAJBrB SSKCJDrDJErE SSKFJGrG SSKHJIrI SSKJJKrKJLrL SS KMJNrO SS KPJQrQJRrR SS KSJTrTJUrU SS KVJWrWJXrX SS KYJZrZ SS!K[J\r\ SS"K]J^r^ SS#K_J`r` SS$KaJbrb SS%KcJdrdJere SS&KfJgrg SS'KhJiriJjrjJkrk SS(KlJmrmJnrn SS)KoJprpJqrq \ ( a SS*KrJsrs SS+KtJuru SS,KvJwrw S-rxS.ry\R " 5 S/:H r{\!\+\|S04 /S04 r}\0S1 r~\0S2 r " S3 S45 r\" 5 r \GR GR 5 r \GR GR 5 r \GR GR 5 r\\\4r\\4r\DGR \DGR \DGR S6.r " S7 S8\&5 r\
" S9 S:5 5 r\2 " S; S<\15 5 r\2 " S= S>\15 5 r\+\\\|4 r\#\+\\b4 r\K" 5 r " S? S@\5 r " SA SB5 r " SC SD5 r " SE SF5 r " SG SH5 r " SI SJ5 r " SK SL5 r " SM SN5 rSSP\SQ\!SR\!SR\4 4 4SS jjrSQ\4ST jr\DGR \DGR \DGRB \DR SU.r\GRG 5 V Vs0 s H u pX_M snn r\
" SV SW\GRJ 5 5 r " SX SY\5 rSq\'SZ \S[' SS\ jrSQ\4S] jr " S^ S_5 rS`\|SQ\|4Sa jr\Sb:X as \" SOSc9r\GRa SdSeSfSOSgSShSiSjSkSl.SmSn.5 \GRa SoSp\" \5 5 \GRe S/ SOSq/ SrQSsSt.Su.SgSv/ SwQSxSt.Sy/ SzQS{St.S|.S}.S~.5 gg! \ a S r GNVf = f! \ a Sr GNHf = f! \ a S5r GN:f = fs snn f ) N)ABCabstractmethod) dataclassfield)datetime)wraps)getpass)escape)isclass)islice)ceil) monotonic) FrameType
ModuleType
TracebackType)IO
TYPE_CHECKINGAnyCallableDictIterableListMapping
NamedTupleOptionalTextIOTupleTypeUnioncast) NULL_FILE) )LiteralProtocolruntime_checkable )errorsthemes)_emoji_replace)CONSOLE_HTML_FORMATCONSOLE_SVG_FORMAT)
get_fileno)FormatTimeCallable LogRender)Align AlignMethod) ColorSystem blend_rgb)Control) EmojiVariant)NullHighlighterReprHighlighterrender) Measurementmeasure_renderables)Pager SystemPager)Pretty
is_expandable) rich_cast)Region) render_scope)Screen)Segment)Style StyleType)Styled)DEFAULT_TERMINAL_THEMESVG_EXPORT_THEME
TerminalTheme)TextTextType)Theme
ThemeStack)WindowsConsoleFeatures)LiveStatuss d WindowsrK )defaultleftcenterrightfull)foldcropellipsisignorec \ rS rSrSrg)NoChangeV N)__name__
__module__ __qualname____firstlineno____static_attributes__rb ڊ/builddir/build/BUILDROOT/alt-python313-pip-23.3.1-3.el8.x86_64/opt/alt/python313/lib/python3.13/site-packages/pip/_vendor/rich/console.pyr` r` V s rh r` )kitty256color16colorc 0 \ rS rSr% Sr\\S' \\S' Srg)ConsoleDimensionst zSize of the terminal.widthheightrb N)rc rd re rf __doc__int__annotations__rg rb rh ri ro ro t s J. K-rh ro c \ rS rSr% Sr\\S' \\S' \\S' \\S' \\S' \ \S' \\S ' S
r
\ \ \S ' S
r
\ \ \S ' S
r\ \ \S' S
r\ \ \S' S
r\ \ \S' S
r\ \ \S' \S\4S j5 rS S jr\\\\\\\\\S. S\\\4 S\\\4 S\\\4 S \\ \ \4 S \\ \ \4 S\\ \ \4 S\\ \ \4 S\\ \ \4 S\\ \ \4 SS 4S jjrS\SS 4S jrS\SS 4S jrS S jr S\S\SS 4S jr S r g
) ConsoleOptions} z$Options for __rich_console__ method.sizelegacy_windows min_width max_width is_terminalencoding
max_heightNjustifyoverflowFno_wrap highlightmarkuprr returnc B U R R S5 ( + $ )z+Check if renderables should use ascii only.utf)r~
startswithselfs ri
ascii_onlyConsoleOptions.ascii_only s ==++E222rh c v [ R [ 5 nU R R 5 Ul U$ )zLReturn a copy of the options.
Returns:
ConsoleOptions: a copy of self.
)rw __new____dict__copyr optionss ri r ConsoleOptions.copy s. #1"8"8 "H ==--/rh ) rq r{ r| r r r r r rr rq c b U R 5 n
[ U[ 5 ( d [ SU5 =U
l U
l [ U[ 5 ( d X*l [ U[ 5 ( d X:l [ U[ 5 ( d XJl [ U[ 5 ( d XZl [ U[ 5 ( d Xjl [ U[ 5 ( d Xzl [ U[ 5 ( d Xl
[ U [ 5 ( d U b Xl U c SO [ SU 5 U
l U
$ )z Update values, return a copy.r N)
r
isinstancer` maxr{ r| r r r r r r rr ) r rq r{ r| r r r r r rr r s ri updateConsoleOptions.update s ))+%**475M AG 1)X.. ) )X.. ) '8,, %O(H-- ' '8,, %O)X.. ) &(++ #N&(++!%+"%+^TQ GNrh c V U R 5 n[ SU5 =Ul Ul U$ )zUpdate just the width, return a copy.
Args:
width (int): New width (sets both min_width and max_width)
Returns:
~ConsoleOptions: New console options instance.
r )r r r{ r| )r rq r s ri update_widthConsoleOptions.update_width s* ))+03Au
=G -rh c B U R 5 nU=Ul Ul U$ )zUpdate the height, and return a copy.
Args:
height (int): New height
Returns:
~ConsoleOptions: New Console options instance.
)r r rr )r rr r s ri
update_height ConsoleOptions.update_height s# ))+.44W^rh c 4 U R 5 nSUl U$ )zwReturn a copy of the options with height set to ``None``.
Returns:
~ConsoleOptions: New console options instance.
N)r rr r s ri reset_heightConsoleOptions.reset_height s ))+ rh c r U R 5 n[ SU5 =Ul Ul U=Ul Ul U$ )zUpdate the width and height, and return a copy.
Args:
width (int): New width (sets both min_width and max_width).
height (int): New height.
Returns:
~ConsoleOptions: New console options instance.
r )r r r{ r| rr r )r rq rr r s ri update_dimensions ConsoleOptions.update_dimensions s9 ))+03Au
=G -.44+rh rb )r rw ) rc rd re rf rs ro ru boolrt strr r
JustifyMethodr OverflowMethodr r r rr propertyr r NO_CHANGEr r` r r r r r rg rb rh ri rw rw } s .
2N&N&<M O2'+GXm
$+0)-Hh~&-1 #GXd^#$ $Ix~$, !FHTN!/ FHSM
3D 3 3 '0*3*3G3<5>2;1:# S(]## h ' #
h ' # x
.89
# 0(:;# x~x/0# $ 12# htnh./# hsmX-.#
#J # *: C ,<
s
C
33D9
==T - - LL $ $U + rh r r r c U R ( aI U R R S5 U R ( a U R R S5 g g g )NFT)r r r' r r( r s ri r ScreenContext.__exit__ sB == LL ' ' . ((. rh )r r r r r )r r )rc rd re rf rs r rF r RenderableTyper r r r r r r rg rb rh ri r r s s IK /3 ^ [ T 5 S[ S[ S[ 4UU 4S jj5 nU$ )zGConvert a method that returns an iterable of renderables in to a Group.argskwargsr c * > T" U 0 UD6n[ UST06$ )Nr/ )r" )r? r@ r r/ r= s ri _replace*group..decorator.._replace s" $1&1K+/3/ /rh )r r r" )r= rB r/ s ` ri decoratorgroup..decorator s7
v 0C 03 05 0
0 rh )r r r- r" )r/ rD s ` ri grouprF s8
h~ 667
#u*
rh c [ [ 5 n U R R nS[ U R 5 ; d! [
R " S5 ( d US:X a gUS:X a gg! [ a gf = f)z-Check if we're running in a Jupyter notebook.Fz google.colabDATABRICKS_RUNTIME_VERSIONZMQInteractiveShellTTerminalInteractiveShell) get_ipython NameError __class__rc r osgetenv)ipythonshells ri _is_jupyterrR sv mG & &E#g / /00
991 2 2 ) ) , , s A+ +
A87A8)standard256 truecolorwindowsc N \ rS rSr% Sr\\S' \" \S9r \
\ \S' Sr \
\S' Srg )
ConsoleThreadLocalsi# z(Thread local values for Console context. theme_stack)default_factoryr r buffer_indexrb N)rc rd re rf rs rN ru r r5 r r rD r[ rt rg rb rh ri rX rX # s( 2 !$ 7FDM7L#rh rX c @ \ rS rSrSr\S\\ S\\ 4S j5 rSr g)
RenderHooki, z(Provides hooks in to the render process.r r c g)a Called with a list of objects to render.
This method can return a new list of renderables, or modify and return the same list.
Args:
renderables (List[ConsoleRenderable]): A number of renderable objects.
Returns:
List[ConsoleRenderable]: A replacement list of renderables.
Nrb )r r s ri process_renderables RenderHook.process_renderables/ s rh rb N)
rc rd re rf rs r r r r_ rg rb rh ri r] r] , s3 2 12
rh r] rO _windows_console_featuresc B [ b [ $ SSKJn U " 5 q [ $ )Nr' get_windows_console_features)ra _windowsrd rc s ri rd rd B s ,((6 < > $$rh c N [ =( a [ 5 R ( + $ )zDetect legacy Windows.)WINDOWSrd vtrb rh ri detect_legacy_windowsri L s <79<<<\.S)S4S? jr/SS@ jr0S)\ 4SA jr1SSB.S\SC\S)S4SD jjr2SSE jr3SSB.S\SC\S)\44SF jjr5\S)\ \ 4SG j5 r6\S)\ 4SH j5 r7\S)\4SI j5 r8\S)\4SJ j5 r9\S)\:4SK j5 r;\S)\<4SL j5 r=\=R: SM\>\\4 S)S4SN j5 r=\S)\4SO j5 r?\?R: S\S)S4SP j5 r?\S)\4SQ j5 r@\@R: S\S)S4SR j5 r@SSS jrAS)\B4ST jrC SSU\ \D SV\SW\S)\E4SX jjrFSSZ\S)S4S[ jjrGSS\\S)S4S] jjrHS^S_S`SaSb.Sc\ISd\ Se\Sf\Sg\S)Sh4 Si jjrJSSj\S)\4Sk jjrKSSl\S)\4Sm jjrL\S)\4Sn j5 rMSo\ S)\4Sp jrN SSq\S\ \ S)Sr4Ss jjrOSSt.Su\ISv\ \: S)\P4Sw jjrQ SSu\ISv\ \: S)\R\ 4Sx jjrS SSSSSy.Su\ISv\ \: S\ \T Sz\S{\S)\ \ \ 4 S| jjjrUS}SSSSSSS~.S\ S\\ \T4 S\ \V S\ \W S \ \ S\ \ S \ \ S"\ \X S)S4S jjrYSS.S\\ \T4 S\ \\T\ 4 S)\T4S jjrZSSSSS.S\R\. S\ S\ S\ \V S \ \ S\ \ S \ \ S)\ \[ 4S jjr\ SSSSS.So\]S\ S\\ \T4 S\^S)S4
S jjjr_S\`S)S4S jraSSSSS.S\.S\ S\ S\ \\ \T4 S \ \ S)S4 S jjrbSSSSSSSSSSSSSSS.S\.S\ S\ S\ \\ \T4 S\ \V S\ \W S\ \ S \ \ S\ \ S \ \ S\ \ S\ \ S\S\ \ S\S)S4 S jjrc SSSSSSSSSSS. S\ \ S\.S\S\\ 4 S \S\S\S\S\S\ \\./\.4 S\S)S4S jjjrdSSS.Su\IS\ \e Sv\ \: S)S4S jjrf SS\ \ \ S\S\S)S4S jjrgSSSSSSSS.S\ \ S\S\ \ S\S\S\R\\ \h4 S\S)S4S jjri\j\kR 4S\S\/ \ \m 4 S)\>\ \\n\ \.4 4 4S jj5 roSSSSSSSSSYS. S\.S\ S\ S\ \\ \T4 S\ \V S \ \ S\ \ S \ \ S\S\S)S4S jjrpSS jrqS\R\ S)\ 4S jrr SSSSSS.S\]S\S \S\S\ \s S)\ 4 S jjjrtSSS.S\SV\S)\ 4S jjruSSS.S\ S\SV\S)S4S jjrvSSSSS.S\ \w S\S\ \ S\S)\ 4
S jjrxSS\ySS.S\ S\ \w S\S\ S\S)S4 S jjrzSSS\{SSS.So\ S\ \w S\S\ S\S\ \ S)\ 4S jjr|SSS\{SSS.S\ So\ S\ \w S\S\ S\S\ \ S)S4S jjr}Sr~g)r iQ a A high level console interface.
Args:
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 :meth:`export_html`, :meth:`export_svg`, and :meth:`export_text`. Defaults to False.
markup (bool, optional): Boolean to enable :ref:`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 :meth:`log` methods. Defaults to True.
log_path (bool, optional): Boolean to enable the logging of the caller by :meth:`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.
_environautoNFr# Tz[%X]) color_systemforce_terminal
force_jupyterforce_interactive soft_wrapr stderrfilequietrq rr r no_colortab_sizerecordr emoji
emoji_variantr log_timelog_pathlog_time_format highlighterrz safe_box get_datetimeget_timerk rm )rl rS rT rU rV rn ro rp rq r rr rs rt rq rr r ru rv rw r rx ry r rz r{ r| r} HighlighterTyperz r~ r r c f U b U U l Uc
[ 5 OUU l U R ( a U
cE U R R S5 n U b! U R 5 ( a [ U 5 n
O[ n
U cE U R R S5 n U b! U R 5 ( a [ U 5 n O[ n Xl Xl UU l
UU l UU l UU l
Uc" [ 5 =( a U R ( + OUU l U
cK U R R S5 n U b- U R 5 ( a [ U 5 U R -
n
U c> U R R S5 n U b U R 5 ( a [ U 5 n XPl Xl Xl U S U l Ub X l Xl Xl Xpl Uc S U l O*US:X a U R1 5 U l O[2 U U l [4 R6 " 5 U l [; UUUS9U l U=( d [> U l UU l! U=( d [D RF U l$ U=( d [J U l& Xl' U
b U
OSU R ; U l( Uc$ U RR =( a U RT ( + OUU l+ [4 R6 " 5 U l, [[ [] Uc [^ R` OU5 S9U l1 / U l2 / U l3 S U l4 S U l5 g )
NJUPYTER_COLUMNS
JUPYTER_LINESCOLUMNSLINESrl ) show_time show_path time_formatNO_COLOR)rY F)6rk rR
is_jupyterr isdigitrt JUPYTER_DEFAULT_COLUMNSJUPYTER_DEFAULT_LINESrv rw _markup_emoji_emoji_variant
_highlightri rz rq _width_height_force_terminal_filert rr
_color_system_detect_color_system
COLOR_SYSTEMS threadingRLockr r/ _log_render_null_highlighterr} r~ r nowr r r r ru r} is_dumb_terminalis_interactive_record_buffer_lockrX rN r) DEFAULT_thread_locals_record_buffer
_render_hooks_live_is_alt_screen)!r rm rn ro rp rq r rr rs rt rq rr r ru rv rw r rx ry r rz r{ r| r} rz r~ r r rk jupyter_columns
jupyter_linescolumnsr s! ri r Console.__init__w s F $DM+8+@+-m ??}"&--"3"34E"F".?3J3J3L3L 0E 3E~ $
1 1/ B
, 1F1F1H1H /F 2F
6C# % #
$
MM%%g.E U]]__ U" # %#1
!%D
V
#!%!:!:!>N
.0/1'+
#rh r c > SU R SU R < S3$ )Nz)rq r r s ri __repr__Console.__repr__ s" Ad.@.@-C1EErh c U R =( d1 U R ( a [ R O[ R n[ USU5 nUc [
nU$ )z Get the file object to write to.rich_proxied_file)r rr sysstdoutgetattrr! )r rs s ri rs Console.file s@ zzHDKKcjjSZZt 0$7 < D rh new_filec Xl g)zSet a new file object.N)r )r r s ri rs r s
rh c . U R R $ zGet a thread local buffer.)r r r s ri r Console._buffer s "")))rh c . U R R $ r r r[ r s ri
_buffer_indexConsole._buffer_index s ""///rh valuec $ XR l g r r )r r s ri r r s +0(rh c . U R R $ )z!Get the thread local theme stack.)r rY r s ri _theme_stackConsole._theme_stack s ""...rh c U R ( a [ R $ U R ( a U R ( a g[
( a\ U R ( a [ R
$ [ 5 nUR ( a [ R $ [ R $ U R R SS5 R 5 R 5 nUS; a [ R $ U R R SS5 R 5 R 5 nUR S5 u pEn[ R U[ R 5 nU$ )z"Detect color system from env vars.N COLORTERMr )rU 24bitTERM-)r r2 TRUECOLORr} r rg rz rd rU EIGHT_BITrk r striplower
rpartition _TERM_COLORSSTANDARD)r windows_console_features
color_termterm
_term_name_hyphencolorsrm s ri r Console._detect_color_system s ?? (( ( 4#8#8 7"""***'C'E $ ,55 %%
!**
**;;AACIIKJ 33",,,==$$VR0668>>@D*.//#*> 'J'++FK4H4HIL rh c . U =R S-
sl g)z4Enter in to a buffer context, and buffer all output.r' N)r r s ri r Console._enter_buffer/ s a rh c N U =R S- sl U R 5 g)z5Leave buffer context, and render content if required.r' N)r
_check_bufferr s ri r Console._exit_buffer3 s a rh c U R U R b [ R " S5 eXl SSS5 g! , ( d f g= f)zSet Live instance. Used by Live context manager.
Args:
live (Live): Live instance using this Console.
Raises:
errors.LiveError: If this Console has a Live context currently active.
Nz+Only one live display may be active at once)r r r( LiveError)r lives ri set_liveConsole.set_live8 s6 ZZzz% &&'TUU J ZZs *A
Ac ^ U R SU l SSS5 g! , ( d f g= f)zClear the Live instance.N)r r r s ri
clear_liveConsole.clear_liveF s
ZZ DJ ZZs
,hookc U R U R R U5 SSS5 g! , ( d f g= f)zXAdd a new render hook to the stack.
Args:
hook (RenderHook): Render hook instance.
N)r r append)r r s ri push_render_hookConsole.push_render_hookK s) ZZ % %d + ZZs 2
A c U R U R R 5 SSS5 g! , ( d f g= f)z'Pop the last renderhook from the stack.N)r r popr s ri pop_render_hookConsole.pop_render_hookT s%
ZZ " " $ ZZs 1
?c & U R 5 U $ )z,Own context manager to enter buffer context.r r s ri r Console.__enter__Y s rh r exc_value tracebackc $ U R 5 g)zExit buffer context.N)r )r r r r s ri r Console.__exit__^ s rh c $ U R 5 g)z`Begin capturing console output. Call :meth:`end_capture` to exit capture mode and return output.Nr r s ri r Console.begin_captureb s rh c z U R U R 5 nU R SS2 U R 5 U$ )zPEnd capture mode and return captured string.
Returns:
str: Console output.
N)r r r )r
render_results ri r Console.end_capturef s5 ++DLL9
LLO rh r r c 6 U R R XS9 g)a` Push a new theme on to the top of the stack, replacing the styles from the previous theme.
Generally speaking, you should call :meth:`~rich.console.Console.use_theme` to get a context manager, rather
than calling this method directly.
Args:
theme (Theme): A theme instance.
inherit (bool, optional): Inherit existing styles. Defaults to True.
r N)r r r r r s ri r Console.push_themeq s
$$U$E'' 'DKKll*F
04
+ #J8
'
G< s$ 5F F.F+*F+.GGnew_sizec $ Uu p#X l X0l g)z^Set a new size for the terminal.
Args:
new_size (Tuple[int, int]): New width and height.
N)r r )r r# rq rr s ri ry r"
s !
rh c . U R R $ )z[Get the width of the console.
Returns:
int: The width (in characters) of the console.
)ry rq r s ri rq
Console.width s yy rh c Xl g)z.Set width.
Args:
width (int): New width.
N)r )r rq s ri rq r& ! s rh c . U R R $ )zXGet the height of the console.
Returns:
int: The height (in lines) of the console.
)ry rr r s ri rr Console.height* s yy rh c Xl g)z1Set height.
Args:
height (int): new height.
N)r )r rr s ri rr r) 3 s rh c L U R [ R " 5 5 g)z3Play a 'bell' sound (if supported by the terminal).N)controlr4 bellr s ri r- Console.bell< s W\\^$rh c [ U 5 nU$ )a 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:
Capture: Context manager with disables writing to the terminal.
)r )r captures ri r0 Console.capture@ s $-rh r r r c [ XX#S9$ )a 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.
Args:
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:
PagerContext: A context manager.
)r r r )r )r r r r s ri r
Console.pagerQ s * DfJJrh r' r c R US: d S5 eU R [ U5 5 g)zYWrite new line(s).
Args:
count (int, optional): Number of new lines. Defaults to 1.
r zcount must be >= 0N)r$ r r s ri r Console.lineh s& z///z
75>"rh homec U( a9 U R [ R " 5 [ R " 5 5 gU R [ R " 5 5 g)zoClear the screen.
Args:
home (bool, optional): Also move the cursor to 'home' position. Defaults to True.
N)r, r4 clearr6 )r r6 s ri r8
Console.clearr s3 LL ',,. 9 LL )rh dotszstatus.spinnerg ?g )@)spinner
spinner_stylespeedrefresh_per_secondstatusr; r< r= r> rR c ( SSK Jn U" UU UUUUS9nU$ )a, Display a status and spinner.
Args:
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:
Status: A Status object that may be used as a context manager.
r' rQ )r r; r< r= r> )r? rR )r r? r; r< r= r> rR status_renderables ri r? Console.status} s, * # " ' 1
! rh r
c r U R ( a& U R [ R " U5 5 gg)zYShow or hide the cursor.
Args:
show (bool, optional): Set visibility of the cursor.
TF)r} r, r4 r( )r r
s ri r( Console.show_cursor s* LL,,T2 3rh enablec SnU R ( a> U R ( d- U R [ R " U5 5 SnXl U$ )az Enables alternative screen mode.
Note, if you enable this mode, you should ensure that is disabled before
the application exits. See :meth:`~rich.Console.screen` for a context manager
that handles this for you.
Args:
enable (bool, optional): Enable (True) or disable (False) alternate screen. Defaults to True.
Returns:
bool: True if the control codes were written.
FT)r} rz r, r4
alt_screenr )r rE changeds ri r' Console.set_alt_screen sA D$7$7 LL++F3 4G"( rh c U R $ )znCheck if the alt screen was enabled.
Returns:
bool: True if the alt screen was enabled, otherwise False.
)r r s ri
is_alt_screenConsole.is_alt_screen s """rh titlec r U R ( a& U R [ R " U5 5 gg)a| Set the title of the console terminal window.
Warning: There is no means within Rich of "resetting" the window title to its
previous value, meaning the title you set will persist even after your application
exits.
``fish`` shell resets the window title before and after each command by default,
negating this issue. Windows Terminal and command prompt will also reset the title for you.
Most other shells and terminals, however, do not do this.
Some terminals may require configuration changes before you can set the title.
Some terminals may not support setting the title at all.
Other software (including the terminal itself, the shell, custom prompts, plugins, etc.)
may also set the terminal window title. This could result in whatever value you write
using this method being overwritten.
Args:
title (str): The new title of the terminal window.
Returns:
bool: True if the control code to change the terminal title was
written, otherwise False. Note that a return value of True
does not guarantee that the window title has actually changed,
since the feature may be unsupported/disabled in some terminals.
TF)r} r, r4 rM )r rM s ri set_window_titleConsole.set_window_title s( 6 LL u- .rh r r c ( [ XU=( d SS9$ )aE Context manager to enable and disable 'alternative screen' mode.
Args:
hide_cursor (bool, optional): Also hide the cursor. Defaults to False.
style (Style, optional): Optional style for screen. Defaults to None.
Returns:
~ScreenContext: Context which enables alternate screen on enter, and disables it on exit.
r )r r )r )r r r s ri r Console.screen s T%+2NNrh r r# r c Z [ R " X=( d U R U5 nU$ )a Measure a renderable. Returns a :class:`~rich.measure.Measurement` object which contains
information regarding the number of characters required to print the renderable.
Args:
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:
Measurement: A measurement of the renderable.
)r: r r )r r# r measurements ri measureConsole.measure s# "ood,Ct||ZP rh c # # U=( d U R nUR S: a g[ U5 n[ US5 ( a" [ U5 ( d UR X5 nOf[
U[ 5 ( a6 U R XR UR S9nUR X5 nO[ R " SU< S35 e [ U5 n[ nUR! 5 nU H2 n[
X5 ( a Uv M U R# X5 Sh vN M4 g! [ a [ R " SU< S35 ef = f N27f) a# 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.
Args:
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:
Iterable[Segment]: An iterable of segments that may be rendered.
r' Nr )r r zUnable to render zC; A str, Segment or object with __rich_console__ method is requiredzobject z is not renderable)r r| r@ r
r r r r
render_strr r r( NotRenderableErroriter TypeErrorrD r r9 ) r r# r _optionsrender_iterabletext_renderable iter_render_Segment
render_outputs ri r9 Console.render sJ " *dll ! z*
: 1 2 27:;N;N ( 9 9$ IO
C
(
( "oo&8&8 . O . > >t NO++#J> 2T T
/K
((* (M-22## ;;}??? )
++/,,>?
@s+ C E D( AE E E(&EE)r pad new_linesrd re c
U R U=( d U R nU R X5 nU( a [ R " Xs5 nUR
nUb [
SU5 n[ [ [ R " UUR UUUS9SU5 5 n UR
bw UR
[ U 5 -
n
U
S: aY U( a$ [ SUR - U5 [ S5 /O[ SUR - U5 //n U R X- 5 U sSSS5 $ ! , ( d f g= f)aG 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.
Nr )include_new_linesrd r r r )
r r r9 rD apply_stylerr r r5 r split_and_crop_linesr| r! extend) r r# r r rd re render_options _rendered
render_heightr extra_linespad_lines ri render_linesConsole.render_lines9 s! 0 ZZ $ 4 N J?I # / / A * 1 1M ( #A} 5
00!&00*3 # !
E $$0 , 3 3c%j @ ? % !~'?'?!?GQU W %cN,D,D&De L M H
LL!78C ZZs DD11
D?r )r r r rx r r r} textr r rK c U=( d USL =( a U R n U=( d USL =( a U R n
U=( d USL =( a U R n U
( a# [ UUU U R S9n X Convert a string to a Text instance. This is called automatically if
you print or log a string.
Args:
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:
ConsoleRenderable: Renderable object.
N)r rx ry )default_variant)r r r ) r r r
render_markupr r r rK r* r} r copy_styles)r rr r r r rx r r r}
emoji_enabledmarkup_enabledhighlight_enabled rich_text _highlighterhighlight_texts ri rY Console.render_strt s 8 @%4-"?DKK
DFdN$Ct|| % P)t*;*O %# " 1 1 I !( !) t5H5HI !
I =N 7t'7'7SW # )#i. 9N & &y 1! !rh )rV namerV c [ U[ 5 ( a U$ U R R U5 nUc [ R " U5 nUR
( a UR
5 $ U$ ! [ R a< nUb U R U5 s SnA$ [ R " SU< SU 35 SeSnAff = f)zGet a Style instance by its theme name or parse a definition.
Args:
name (str): The name of a style or a style definition.
Returns:
Style: A Style object.
Raises:
MissingStyle: If no style could be parsed from name.
NzFailed to get style z; ) r rE r r parselinkr r( StyleSyntaxError get_style MissingStyle)r r~ rV r errors ri r Console.get_style s dE " "K
%%))$/E} D)#(::5::< 85 8&& "~~g..%%&thb8
s* AA0 .A0 0C B;C B;;C r rx r r objectssepr c
^^^^^^ / nUR m/ mTR n TmTS; a S[ SS4UU4S jjn
U
m[ n U( d Uc U R ( a U R n S UUUUU4S jjn U H n
[ U
5 n
[
U
[ 5 ( a U " U R XXkS95 M; [
U
[ 5 ( a
U " U
5 MZ [
U
[ 5 ( a U " 5 T" U
5 M [ U
5 ( a U " 5 T" [ XS95 M U " U " [ U
5 5 5 M U " 5 U R b6 U R U R 5 nU V
s/ s H n
[ X5 PM nn
U$ s sn
f )
a Combine a number of renderables and text into one renderable.
Args:
objects (Iterable[Any]): Anything that Rich can render.
sep (str): String to write between print data.
end (str): String to write at end of print data.
justify (str, optional): One of "left", "right", "center", or "full". Defaults to ``None``.
emoji (Optional[bool], optional): Enable emoji code, or ``None`` to use console default.
markup (Optional[bool], optional): Enable markup, or ``None`` to use console default.
highlight (Optional[bool], optional): Enable automatic highlighting, or ``None`` to use console default.
Returns:
List[ConsoleRenderable]: A list of things to render.
)rW rX rY r# r Nc F > T" [ U [ [ T5 5 5 g r )r0 r r1 )r# _appendr s ri align_append2Console._collect_renderables..align_append s j${G*DEFrh c z > T( a3 [ TTTS9n T" U R T5 5 TR 5 g g )N)r r )rK joinr8 )sep_textr r r r rr s ri
check_text0Console._collect_renderables..check_text s3 W#>x}}T*+
rh )rx r r} )r} r N)r r- r r r} r@ r r rY rK r r? r> r r rG )r r r r r rx r r r append_textr r{ r r# r r r rr s ``` @@@ri _collect_renderables Console._collect_renderables se 2 02 $$ kk 1 1
G
GD
G
G "F(9 *t ++L "J":.J*c**OO" $
J--J'J(9:: z" z** vjCDLZ 9:# "& :: !NN4::.EGRS{6*4{KS Ts /Fu ─z rule.linerX )
charactersr alignr r c @ SSK Jn U" XX4S9nU R U5 g)u} Draw a line with optional centered title.
Args:
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".
r' )Rule)rM r r r N)ruler r$ )r rM r r r r r s ri r Console.rule s %eQ
4rh r, c U R ( d. U U R R S U 5 5 SSS5 gg! , ( d f g= f)zzInsert non-printing control codes.
Args:
control_codes (str): Control codes, such as those that may move the cursor.
c 3 8 # U H oR v M g 7fr )segment).0_controls ri "Console.control..5 s #MW$4$4W N)r r rj )r r, s ri r, Console.control- s: $$ ###MW#MM %s #A
Ar r )r r r r c b UR S U 5 5 nU R UUUSSSSSUS9 g)ao Output to the terminal. This is a low-level way of writing to the terminal which unlike
:meth:`~rich.console.Console.print` won't pretty print, wrap text, or apply markup, but will
optionally apply highlighting and a basic style.
Args:
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``.
c 3 8 # U H n[ U5 v M g 7fr )r )r _objects ri r Console.out..J s "GwG3w<. s IL Lr r' r rd )r rq r r r_ r r minrq r rj r9 rD rh r r! r
splitlinesinsertr r ri )r r r r r r r rx r r rq rr r\ rq r r render_hooksr r rk new_segmentsrj r9 r#
buffer_extendr s ri r$
Console.printW s J ylG I #D))!,
33 # 4 K % " 6 6{ C % !\\ 0 0 !050Ac%,y # 1 N +-L!((F[[F}"-J6*n=> #. #.J ++ ":~ >u@U #. IL IITTVW !''7<<>: $ 3 3
# 8 8 $**% D "$'
##L1a TTs
F$G33
Hrj ) dataindentr skip_keys ensure_asciicheck_circular allow_nanrV sort_keysjsonr r r r r r r c SSK Jn Uc U R UUUUUUUU U
S9 n O3[ U[ 5 ( d [ SU< S35 eU " UUUUUUUU U
S9 n U R
U SS9 g) a Pretty prints JSON. Output will be valid JSON.
Args:
json (Optional[str]): A string containing JSON.
data (Any): If json is not supplied, then encode this data.
indent (Union[None, int, str], 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.
r )JSONN)r r r r r r rV r z/json must be str. Did you mean print_json(data=z) ?T)rq )pip._vendor.rich.jsonr from_datar r r\ r$ )
r r r r r r r r r rV r r json_renderables
ri
print_jsonConsole.print_json s : / < "nn ## ) -# # -
O dC(( EdXSQ # ## ) -# #
O
?d
3rh )regionr r c j U R ( d [ R " S5 eU=( d U R nUc= S=pVUR UR
UR =( d U R 5 nOUu pVpxUR Xx5 nU R XS9n U R XU5 g)as Update the screen at a given offset.
Args:
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.
0Alt screen must be enabled to call update_screenNr rS ) rK r( NoAltScreenr r r| rr rp update_screen_lines)
r r# r r rk r r rq rr r s
ri
update_screenConsole.update_screen s & !!$$%WX X 0DLL >IA + = = ((.*?*?*N4;; N #) A% + = =e LN!!*!E 1-rh r r r c U R ( d [ R " S5 e[ XU5 nU R U5 nU R
R
U5 U R 5 g)a\ Update lines of the screen at a given offset.
Args:
lines (List[List[Segment]]): Rendered lines (as produced by :meth:`~rich.Console.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.
r N)rK r( r r r9 r rj r )r r r r
screen_updater s ri r Console.update_screen_lines sW !!$$%WX X$Uq1
;;}- H% rh rT r" rb rq rn r word_wrap show_localssuppress
max_framesrn r r r r c
J SSK Jn U" UUUUUUUS9n U R U 5 g)a Prints a rich render of the last exception and traceback.
Args:
width (Optional[int], optional): Number of characters used to render code. Defaults to 100.
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.
suppress (Iterable[Union[str, ModuleType]]): Optional sequence of modules or paths to exclude from traceback.
max_frames (int): Maximum number of frames to show in a traceback, 0 for no maximum. Defaults to 100.
r' ) Tracebackr N)r r r$ )
r rq rn r r r r r r r s
ri print_exceptionConsole.print_exception- s4 , ) # # !
9 rh r currentframec \ U S-
n U" 5 nUbY U ( a Ub UR nU S- n U ( a Ub M Uc eUR R UR UR 4$ [
R " 5 U nUR UR UR R 4$ )a Get caller frame information.
Args:
offset (int): the caller offset within the current frame stack.
currentframe (Callable[[], Optional[FrameType]], optional): the callable to use to
retrieve the current frame. Defaults to ``inspect.currentframe``.
Returns:
Tuple[str, int, Dict[str, Any]]: A tuple containing the filename, the line number and
the dictionary of local variables associated with the caller frame.
Raises:
RuntimeError: If the stack offset is invalid.
r' )
f_backf_code co_filenamef_linenof_localsinspectstackfilenamelinenoframe)r r r
frame_infos ri _caller_frame_infoConsole._caller_frame_infoP s ( ! U . ! U . $ $$<<++U^^U^^K K ! 0J &&
(9(9:;K;K;T;TT Trh ) r r r r rx r r
log_locals
_stack_offsetr r c U
( d [ 5 4n
U R SS n U U R U
UUUUUUS9n Ub U V
s/ s H n
[ X5 PM n n
U R U 5 u pnUR S5 ( a SO [ R R U5 nUR [ R 5 S nU( aW UR 5 VVs0 s H! u nnUR S5 ( a M UU_M# nnnU R [ USS95 U R U U U R 5 UUUS9/n U H nUR! U 5 n M / nUR" nU R$ nU R& nU H n
U" U" U
U5 5 M U R( R" n[* R, " UU R. S S
9 H n U" U 5 M
SSS5 gs sn
f s snnf ! , ( d f g= f) aP Log rich content to the terminal.
Args:
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.
Nr <__z [i]locals)rM )rz pathline_no link_pathFr )r r r rG r r rN r abspathr r itemsr rB r r r_ rj r9 r r rD ri rq ) r r r r r rx r r r r r r r r# r r localsr r keyr
locals_mapr r rj r9 rk r r s ri log Console.logs s : ylG))!,
33 # 4 K KV W;Zvj 8; W(,(?(?
(N %Hv ( 3 3C 8 8bggooh>WI&&rvv.r2D '-lln &4
U >>$/ CJ&4
""<
+#NO ! . . 0 # '
! K % " 6 6{ C %*,L!((F[[F !\\N )
vj.9: * LL / /M 44 djje d#W T X # Ts1 G7G,B G7 G1 G1C G7, G77
Hc U R ( a U R SS2 gU R U R ( a= U R U R
R
U R SS 5 SSS5 U R S:X Gau U R ( aF SSK J
n U" U R U R U R SS 5 5 U R SS2 GO [ ( Ga SnU R ( a! [ U R 5 nUb U[ ; nU( av SSKJn SSKJn U R SS nU R* ( a0 U R, ( a [/ [0 R2 " U5 5 nU" Xd" U R 5 5 GO8U R U R SS 5 nU R R4 nSn [7 U5 U :: a U" U5 O/ n
U
R8 n Sn UR; S 5 H[ n
U [7 U
5 - U : a0 U
( a) U" S
R= U
5 5 U
R? 5 Sn U " U
5 U [7 U
5 -
n M] U
( a' U" S
R= U
5 5 U
R? 5 O:U R U R SS 5 n U R R5 U5 U R RE 5 U R SS2 SSS5 g! , ( d f GN= f! [@ a nURB S 3Ul! e SnAff = f! [@ a nURB S 3Ul! e SnAff = f! , ( d f g= f) a1 Check if the buffer may be rendered. Render it if it can (e.g. Console.quiet is False)
Rendering is supported on Windows, Unix and Jupyter environments. For
legacy Windows consoles, the win32 API is called directly.
This method will also record what it renders if recording is enabled via Console.record.
Nr r' )displayF)LegacyWindowsTerm)legacy_windows_renderi Tr zG
*** You may need to add PYTHONIOENCODING=utf-8 to your environment ***)#rt r r rw r r rj r r jupyterr r rg rz r- rs _STD_STREAMS_OUTPUT pip._vendor.rich._win32_consoler "pip._vendor.rich._windows_rendererr ru r r5 rD remove_colorwriter! r r r r8 UnicodeEncodeErrorreasonflush)r r use_legacy_windows_renderfilenor r r rr r MAX_WRITEbatch batch_appendry r r s ri r Console._check_buffer s :: Q
ZZ{{--''..t||A? . !!Q&??0DLL$*=*=dll1o*NO Q w491 ..%/ %:F % 1$*.A$A !: 5 Y `%)\\!_F #}}1C1C)-g.B.B6.J)K 1&:KDII:V W $(#6#6t||A#GD %)IIOOE(6I &#&t9 #9$)$K79E38< u pxn U( a U" UR UUUS95 M& U( a U ( a M6 U" U5 M@ SR U5 n
U
$ )z)Render buffered output, and clear buffer.)rm rz r ) r r rz r} ru rD r r9 r ) r r outputr rm rz not_terminalrr r r, rendereds ri r Console._render_buffer s )) ,, +++ ==\ ))&1F$* DLL %1'5 ! #wwt %+ 776?rh )r rx passwordstreampromptr r c U( a U R XUSS9 U( a [ SUS9nU$ U( a UR 5 nU$ [ 5 nU$ )a Displays a prompt and waits for input from the user. The prompt may contain color / style.
It works in the same way as Python's builtin :func:`input` function and provides elaborate line editing and history features if Python's builtin :mod:`readline` module is previously loaded.
Args:
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:
str: Text read from stdin.
r )r rx r )r )r$ r readlineinput)r r r rx r r results ri r
Console.input, sU . JJvErJ B R/F
*
rh r8 r r8 c H U R ( d S5 eU R U( a# SR S U R 5 5 nO"SR S U R 5 5 nU( a U R SS2 SSS5 U$ ! , ( d f W$ = f)aq Generate text from console contents (requires record=True argument in constructor).
Args:
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:
str: String containing console contents.
ITo export console contents set record=True in the constructor or instancer c 3 \ # U H" u pnU( a UR U5 OUv M$ g 7fr r8 )r rr r _s ri r &Console.export_text..` s+ *=Q ,1U\\$'d:*=s *,c 3 ` # U H$ nUR ( a M UR v M& g 7fr )r, rr r s ri r r" e s$ #6"?? !GLL#6s ..N)rw r r r )r r8 r rr s ri export_textConsole.export_textN s
KK W V W
%
%ww *.*=*=
ww #'#6#6
''* & &
% s A#B
B!r c U R X#S9n[ USSS9 nUR U5 SSS5 g! , ( d f g= f)aw Generate text from console and save to a given location (requires record=True argument in constructor).
Args:
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``.
r wtr r~ N)r$ openr )r r r8 r rr
write_files ri save_textConsole.save_textn s? e ;
$w
/: T " 0
/
/s 6
Ar r8 code_format
inline_stylesr. r/ c U R ( d S5 e/ nUR nU=( d [ nSnUc [ OUn U R U( a [
R " [
R " U R 5 5 Hg u pn [ U
5 n
U ( aG U R U5 n
U R ( a SU R SU
S3n
U
( a SU
SU
S3OU
n
U" U
5 Mi GO 0 n[
R " [
R " U R 5 5 H u pn [ U
5 n
U ( a` U R U5 n
UR U
[ U5 S - 5 nU R ( a S
U S U R SU
S3n
O S U SU
S3n
U" U
5 M / nUR nUR 5 H u nnU( d M U" S
U SU S35 M SR U5 nU R! SR U5 UUR" R$ UR& R$ S9nU( a U R SS2 SSS5 U$ ! , ( d f W$ = f)a Generate HTML from console contents (requires record=True argument in constructor).
Args:
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. In addition to '{foreground}',
'{background}', and '{code}', should contain '{stylesheet}' if inline_styles is ``False``.
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:
str: String containing console contents as HTML.
r r Nz zz
D6#QD4L' /1 $4$;$;!06 ,J !z)B|nC
|2*NO 1? "YY'7 8
. 5 5WWY'%!2266!2266 6 M ''*Q &R S &
%R s F I, BI,,
I;c U R UUUUS9n[ USSS9 nUR U5 SSS5 g! , ( d f g= f)a Generate HTML from console contents and write to a file (requires record=True argument in constructor).
Args:
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. In addition to '{foreground}',
'{background}', and '{code}', should contain '{stylesheet}' if inline_styles is ``False``.
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.
r- r' r r( N)rF r) r )r r r r8 r. r/ htmlr* s ri save_htmlConsole.save_html sO , #'
$w
/: T " 0
/
/s 9
ARichgQ ?rM r r8 r. font_aspect_ratio unique_idrN rO c D ^^3^4^5^6^7^8 SSK Jn 0 m7S[ S[ 4U3U74S jjnU=( d [ m3U R
m8Sn X- m4U S- m5Sn
Sn Sn Sn
S nS
nS
nS
nUU- nUU- nX- nX- n/ n/ n0 nSnS [ S[ 4S jn S2S[ S[ [ S[ S[ 4S jjm6U R [ [ R " U R 5 5 nU( a U R R 5 S
S
S
5 Tc[ S[ [ R " SR! S W 5 5 R# SS5 UR# SS5 - 5 5 - mSn [% [ R& " WT8S95 GH u n n Sn U GH u n n n!U =( d
[ 5 n U" U 5 n"U"U; a
UUU"' US-
nSUU" 3n#U R( ( aK Sn$U R* c T3R, R. O$U R* R1 T35 R. n%OpU R2 n&U&S
L=( a U&R4 ( + n$U R2 c T3R6 R. O$U R2 R1 T35 R. n%U" U 5 n'U$( a* UR9 T6" SU%U T4- U T5- S- T4U'- T5S - S S 95 U S [; U 5 - :w aB UR9 T6" S U" U 5 T S U# 3U T4- U T5- U - T4[; U 5 - S!T S"U S#3S$95 U U" U 5 -
n GM GM [= U 5 V(s/ s H n(U(T5- S- PM
n)n(S%R! U4U5U6UU84S& j[% U)5 5 5 n*S%R! U4S' jUR? 5 5 5 n+SR! U5 n,SR! U5 n-[A T8T4- U- 5 n.U S- T5- U- n/T6" ST3R6 R. S(S)U
U
U.U/S
S*9 n0T3R, R. n1U( a U0T6" S U" U5 T S+3U1S,U.S-- X- S.- S/9-
n0U0S0-
n0URC TT4U T5T4T8- S-
U S- T5- S-
U.U- U/U- U
U- X- U+U0U,U-U*S19n2U2$ ! , ( d f GN= fs sn(f )3a
Generate an SVG from the console contents (requires record=True in Console constructor).
Args:
title (str, optional): The title of the tab in the output image
theme (TerminalTheme, optional): The ``TerminalTheme`` object to use to style the terminal
clear (bool, optional): Clear record buffer after exporting. Defaults to ``True``
code_format (str, optional): Format string used to generate the SVG. Rich will inject a number of variables
into the string in order to form the final SVG output. The default template used and the variables
injected by Rich can be found by inspecting the ``console.CONSOLE_SVG_FORMAT`` variable.
font_aspect_ratio (float, optional): The width to height ratio of the font used in the ``code_format``
string. Defaults to 0.61, which is the width to height ratio of Fira Code (the default font).
If you aren't specifying a different font inside ``code_format``, you probably don't need this.
unique_id (str, optional): unique id that is used as the prefix for various elements (CSS styles, node
ids). If not set, this defaults to a computed value based on the recorded content.
r )cell_lenr r c 6 > U T; a TU $ / nU R b U R R ( a TR OU R R T5 nU R b U R R ( a TR
OU R R T5 nU R ( a X2p2U R ( a [ X#S5 nUR SUR 35 U R ( a UR S5 U R ( a UR S5 U R ( a UR S5 U R ( a UR S5 SR U5 nUTU ' U$ )z%Convert a Style to CSS rules for SVG.g?zfill: zfont-weight: boldzfont-style: italic;ztext-decoration: underline;z text-decoration: line-through;;)color
is_defaultr;
get_truecolorbgcolorr= reversedimr3 r r< bolditalic underlinestriker )r css_rulesrT rW cssr? style_caches ri
get_svg_style)Console.export_svg..get_svg_style s> #"5))I KK'5;;+A+A ''[[..v6
MM)U]]-E-E '']]008
}}!(wyy!%#6 veii[ 1 2zz !45|| !67 !>?|| !AB((9%C!$K Jrh gQ ?r' ( r# rr c 8 [ U 5 R SS5 $ )z.HTML escape text and replace spaces with nbsp.r z )r
replacer s ri escape_text'Console.export_svg..escape_textA s $<''X6 6rh Nr~ r attribsc ^ S[ S[ 4S jmSR U4S jUR 5 5 5 nU( a SU SU SU SU S3 $ SU SU S 3$ )
z.Make a tag from name, content, and attributes.r r c Z [ U [ 5 ( a [ U S5 $ [ U 5 $ )Ng)r floatr: r )r s ri stringify7Console.export_svg..make_tag..stringifyJ s& ee--!%--5z!rh r c 3 ># U H4 u pUR S 5 R S S5 ST" U5 S3v M6 g7f)r! r z=""N)lstriprf )r kvrn s ri r 7Console.export_svg..make_tag..O sA # +DA 88C=((c232il^1E +s )objectr r r )r~ r ri tag_attribsrn s @ri make_tag$Console.export_svg..make_tagE s|
"
"C
"
(( # #MMO# K D6;-q D6;
a }B/
rh z terminal-r c 3 8 # U H n[ U5 v M g 7fr )reprr s ri r %Console.export_svg..a s C(wT']](r r r^ )lengthrTrectg ? ?
crispEdges)fillr r rq rr shape_renderingr r zurl(#-line-))_classr r
textLength clip_pathr c 3 \ ># U H! u pS T SU ST" SSUTT- TS- S9 S3v M# g7f) z
r r r )r r rq rr z
Nrb )r r r
char_width line_heightrx rO rq s ri r r| sV
$; yky 9
fV:+=kTXFXYZ [
$;s ),c 3 @ ># U H u pS T SU SU S3v M g7f).z-rz { z }Nrb )r r_ rule_norO s ri r r| s+
GV|sa {"WIT#c 2s zrgba(255,255,255,0.35)1)r stroke stroke_widthr r rq rr rxz-titlemiddlerj )r r text_anchorr r z
)rO r char_heightr terminal_widthterminal_heightrq rr
terminal_x
terminal_yr chrome backgroundsmatrixr r )"pip._vendor.rich.cellsrQ rE r rI rq r rv r r5 rD r6 r r8 zlibadler32r encoder ri rX rT r; r< rV rW rU r= r r! ranger r
r: )9r rM r r8 r. rN rO rQ ra r
margin_top margin_right
margin_bottom margin_left padding_top
padding_rightpadding_bottom padding_left
padding_widthpadding_height margin_width
margin_heighttext_backgrounds
text_groupclassesstyle_norg r r r r rr r r rules
class_namehas_backgroundr5 rW text_lengthr line_offsetsr r r r r r r title_colorsvgr? r r rx r` rq s9 ` @@@@@@ri
export_svgConsole.export_svg sZ 6 4(* 3 B **
4
!D(
$}4
$~5"1 "2
&( "
"$ 7c 7c 7
15 (
AG
(
%
%G 2 243F3F GHH##))+ &
#c WW C( CCKK ll7H5 6' I
!=!=hu!UVGAtA)-%eX (%e,'%-GEN MH 0 1
==%)N !;;. //33 "[[ 6 6v > B B $mmG%,D%8%SASAS=SN !==0 //33 "]] 8 8 @ D D 'tn !$++ "!+ *n +o 3",{":#.#5,8
3T?* %% " ' -&/[* #> *n +o ;'1CI'=(-i[qc&C
Xd^#e *. Wl DI8L8+-38 L
$-\#:
GN}}
gg ./ $ ej 0= @A q5K/.@ ((,,+ "
--11 hE"#F+ $ A% *Q.
F !##%-1 Uk 1A 5 </"]2"\1!/# !
"
M &
%L Ms 9A R R
Rc U R UUUUUUS9n[ USSS9 n U R U5 SSS5 g! , ( d f g= f)a Generate an SVG file from the console contents (requires record=True in Console constructor).
Args:
path (str): The path to write the SVG to.
title (str, optional): The title of the tab in the output image
theme (TerminalTheme, optional): The ``TerminalTheme`` object to use to style the terminal
clear (bool, optional): Clear record buffer after exporting. Defaults to ``True``
code_format (str, optional): Format string used to generate the SVG. Rich will inject a number of variables
into the string in order to form the final SVG output. The default template used and the variables
injected by Rich can be found by inspecting the ``console.CONSOLE_SVG_FORMAT`` variable.
font_aspect_ratio (float, optional): The width to height ratio of the font used in the ``code_format``
string. Defaults to 0.61, which is the width to height ratio of Fira Code (the default font).
If you aren't specifying a different font inside ``code_format``, you probably don't need this.
unique_id (str, optional): unique id that is used as the prefix for various elements (CSS styles, node
ids). If not set, this defaults to a computed value based on the recorded content.
rM r' r r( N)r r) r )
r r rM r r8 r. rN rO r r* s
ri save_svgConsole.save_svg sS 6 oo# /
$w
/: S ! 0
/
/s ;
A ) r r r rk r r r r r r r r r r r r r r r r r} r r rz ru rt rw r~ rq rr r rv r )r rP r N)r r r r r )TNr r, )r r )rc rd re rf rs rN environrk r r ru r7 r r$ r rM r rt rF r5 r r. r r rm r r r rs setterr rD r r rN r r2 r r r r r r] r r r r r r r r r r r rm r~ r} r rw r ro ry r rq rr r- r r0 r< r r r r8 r- r? r( r' rK rO r r: rV r r9 rE rp r r r rY r r r rL r1 r r4 r, r r$ r rA r r r r staticmethodr r r r r r r r r r r$ r+ rJ rF r+ rJ r, r r rg rb rh ri r r Q ss !F #%**Hgc3h ,
)-(,,0 !% "& # $%)#' 04 :@3B3D)- 9=2604Az$ E F
z$ !
z$ ~z$ $D>z$ z$ z$ z$ r#w z$ z$ } z$
z$ "!z$" 4.#z$$ %z$& 'z$( )z$* +z$, --z$. /z$0 1z$2 3z$4 s$6 675z$6 /07z$8 !9z$: ;z$< xH 56=z$> 8BI./?z$@ 738,-Az$xF# F bg
[[ RW *g * * 0s 0 0 13 14 1 1 /j / / h{&; 0
,Z ,D ,%
S ;? = =4 =4 =& :>
2u
2$
2,
2
hsm
L# L L !T ! !F ,$ , ,
+
' +
+
Z
[[ U38_ s \\ 3 4 ]] S T % $ RWK e_K59KJNK K.## #d # *$ *$ * #3$( ! ! !
! !
! " !
!B T T * #t # # c d B FJ O O/7 /B O O RV(6>~6N $ OS1@(1@3;N3K1@ ' 1@l -19
"& 9"9 .)9
9
9 9
d7m 9~ $&+/-1 $!%$(1599 S%Z 9
-( 9 >*
9 ~9 9 D>9 o.9
9x RV #u*% 3;E%*I
IZ #. %
S%Z
*N ND N -1$(
c5j)*
D>
F -1+/-1"& $!%$( # $$( $!a2a2 a2 a2
c5j)* a2 -(
a2 >*a2 $ a2 ~a2 a2 D>a2 }a2
a2 a2 D> a2 !a2"
#a2J #;4 () " # 26 ;4sm;4 ;4
dCn% ;4
;4 ;4 ;4 ;4 ;4 (C5#:./;4 ;4
;4B $(,0 ." . .
.) .
.F @A $w-( -0 9<
. # # !57 ! }! !
} !
! ! 5j 12! !
! F ;B:N:N U U r8I#6 67 U
sCc3h ' ( U UJ -1+/ $!%$( P$P$ P$ P$
c5j)* P$ -(
P$ ~P$ P$ D>P$ P$ P$
P$dM(^Xg%6 3 4 #'
D ,0 D # @ 59 #c #T #$ #SW #" *.%) #
I
&I I
c] I
I
I ^ *.. # # #
& #
#
# #
#D )--#'#'y y
& y
y
y !y C=y
y~ )--#'#'$"$" $"
& $"
$" $" !$" C=$"
$" $"rh r
svg_main_codec \ [ [ R " U R 5 5 5 $ )zReturns a unique hash for the given SVG main code.
Args:
svg_main_code (str): The content we're going to inject in the SVG envelope.
Returns:
str: a hash of the given content
)r r r r )r s ri _svg_hashr
s! t||M 0 0 23 44rh __main__)rw zJSONRPC [i]request[/i] g?Fz2.0subtract* )minuend
subtrahendr" )jsonrpcr= paramsidz
Hello, World!z{'a': 1}z&Which one is correct team name in NBA?)zNew York BullszLos Angeles KingszGolden State Warriors
Huston Rocketr )questionr answer)answeredq1z 5 + 7 = ?)
r z
12 - 8 = ?)r' rj r" r )r r q2)sportmaths)r~ emptyquizr )r rO )r rN platformr r r abcr r dataclassesr r r functoolsr r rI r
r itertoolsr mathr
timer typesr r r typingr r r r r r r r r r r r r r r pip._vendor.rich._null_filer! version_infor$ r% r& pip._vendor.typing_extensionsr r( r) r* _export_formatr+ r, _filenor- r r. r/ r r0 r1 rT r2 r3 r, r4 rx r5 r} r6 r7 r r9 ru rV r: r; r r< r= prettyr> r? protocolr@ r rA scoperB r rC r rD r rE rF styledrG terminal_themerH rI rJ rr rK rL r rM rN re rO r rP r? rR r r systemrg r r r r r` r __stdin__r
_STDIN_FILENO Exception
__stdout___STDOUT_FILENO
__stderr___STDERR_FILENOr r r r r ro rw r r r- r r r r r r r r r r" r rF rR r r r r localrX r] ra ru rd ri r r rc r r r{ r$ )r~ r s 00ri r s
# ( 6 6 $ 2v ;; * C 6 % ) 9 + 5 % ) # S S $0
//
y
(E#v+ ./78DE
=>
J MM((*M^^**,N^^**,N ~~> %~6
"
"%%## .
. B B BJ x ((C78 ng 567 #% 39 3 ) ) $ B! !*$% $%N,/ ,/^ $ $Bt xXc5j-A(A B ,T * $$ &&""
:G9L9L9NO9N 9NO )// & AE 8$<= D%=t =
t " t "n= 5S 5S 5 zT"G KK
"$B7
KKT']; MM !%$L$ #2 !&$/#3"$ %1#/"#
!) mM M N Nt
Ps< 7 P P- 1 P< Q P*)P*-P98P9<QQ