2bi^ S SK Jr S SKJr S SKJr S SKJr S SKJ r S SK
J r J r J
r
JrJrJrJrJrJrJr SSKJrJrJrJrJr SS KJ r J r SS
K J r \ ( a
SS K J!r!J"r"J#r# \" S 5 r$ " S
S\5 r%\\\% \\%\\&\'4 4 \\%\&\&4 4 r(\ " 5 " S S\5 5 r) " S S5 r* " S S5 r+\,S:X Ga S SK-J!r! S SK.J/r/ S SK0J1r1 Sr2\1Rf " S5 r4\!" 5 r \ Rk S5 \ Rm S 5 \ Rm S 5 \ Rm \/" \2S S S 95 \ Rm 5 \ Rm S!5 \7" \ Rq \45 5 r9\ Rm \95 \ Rm 5 \ Rm S"5 \ Rm \45 \ Rm S#5 g$g$)% )IntEnum) lru_cache) filterfalse) getLogger)
attrgetter)
TYPE_CHECKINGDictIterableList
NamedTupleOptionalSequenceTupleTypeUnion )_is_single_cell_widthscached_cell_lencell_lenget_character_cell_size
set_cell_size)Result rich_repr)Style)ConsoleConsoleOptions RenderResultrichc X \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrSrSrg) ControlType# zDNon-printable control codes which typically translate to ANSI codes.r
N)__name__
__module__ __qualname____firstlineno____doc__BELLCARRIAGE_RETURNHOMECLEAR SHOW_CURSOR HIDE_CURSORENABLE_ALT_SCREENDISABLE_ALT_SCREEN CURSOR_UP CURSOR_DOWNCURSOR_FORWARDCURSOR_BACKWARDCURSOR_MOVE_TO_COLUMNCURSOR_MOVE_TO
ERASE_IN_LINESET_WINDOW_TITLE__static_attributes__r1 ڊ/builddir/build/BUILDROOT/alt-python313-pip-23.3.1-3.el8.x86_64/opt/alt/python313/lib/python3.13/site-packages/pip/_vendor/rich/segment.pyr r # sY N DO D
EKKIKNO NMrH r c \ rS rSr% Sr\\S' Sr\\ \S' Sr
\\ \ \S' \
S\4S j5 rS\4S jrS\4S
jr\
S\4S j5 r\\" S 5 S
S S\S\S 4S j5 5 rS\S\S 4S jr\S1S j5 r\ S2S\S S\\ S\\ S\S 4S jj5 r \ S3S\S S\S\S 4S jj5 r \S\S S\\ S 4S j5 r \ S4S\S S\S\\ S\S\S\\ S 4 S jj5 r \ S5S \ S S\S\\ S\S\ S 4
S jj5 r!\S \ S S\4S j5 r"\S \ \ S S\\\4 4S! j5 r#\ S6S \ \ S S"\S#\\ S\\ S$\S\ \ S 4 S% jj5 r$\ S3S&\%S S \ \ S S"\S#\S\ S$\S\ \ S 4S' jj5 r&\ S3S&\%S S \ \ S S"\S#\S\ S$\S\ \ S 4S( jj5 r'\ S3S&\%S S \ \ S S"\S#\S\ S$\S\ \ S 4S) jj5 r(\S\S S\S 4S* j5 r)\S\S S\S 4S+ j5 r*\S\S S\S 4S, j5 r+\S\S S\S 4S- j5 r,\S\S S.\\ S\\ S 4S/ j5 r-S0r.g)7Segment? a A piece of text with associated style. Segments are produced by the Console render process and
are ultimately converted in to strings to be written to the terminal.
Args:
text (str): A piece of text.
style (:class:`~rich.style.Style`, optional): An optional style to apply to the text.
control (Tuple[ControlCode], optional): Optional sequence of control codes.
Attributes:
cell_length (int): The cell length of this Segment.
textNstylecontrolreturnc 4 U u pnU( a S$ [ U5 $ )zbThe number of terminal cells required to display self.text.
Returns:
int: A number of cells.
r )r )selfrM _stylerO s rI cell_lengthSegment.cell_lengthQ s !% gq/$ /rH c # # U R v U R c U R b U R v g g U R v U R v g 7fN)rM rO rN rR s rI
__rich_repr__Segment.__rich_repr__[ sG ii << zz%jj & ** ,, AAc , [ U R 5 $ )z#Check if the segment contains text.)boolrM rX s rI __bool__Segment.__bool__d s DII rH c U R SL$ )z,Check if the segment contains control codes.N)rO rX s rI
is_controlSegment.is_controlh s ||4''rH i @ segmentcut)rK rK c Uu p4n[ nUR nX': a
X" SXE5 4$ [ n[ X'- [ U5 S-
- 5 n US U n
[ U
5 n X:X a U" XU5 U" X9S XE5 4$ U [ U5 : ag X9 n U S-
n X" U 5 -
n US U n
X:X a U" XU5 U" X9S XE5 4$ X: a U" U
S U S-
S- XE5 U" SX9S - XE5 4$ U [ U5 : a Mg [
S5 e)N r zWill never reach here)rK rT r intlenr AssertionError)
clsrc rd rM rN rO _SegmentrT cell_sizeposbeforecell_poschars
rI _split_cellsSegment._split_cellsm sG ' W )) HR 88 8+ 3$TQ 78dsF# ?0dU4
CIo9D 1HC $ 'H$3ZF VG4 T$Z8 ~ VIcAg . 4eE S4: -u> CIo 455rH c U u p#n[ U5 ( a: U[ U5 : a U [ SX45 4$ [ USU X45 [ X!S X45 4$ U R X5 $ )a Split segment in to two segments at the specified column.
If the cut point falls in the middle of a 2-cell wide character then it is replaced
by two spaces, to preserve the display width of the parent segment.
Returns:
Tuple[Segment, Segment]: Two segments.
rf N)r ri rK rr )rR rd rM rN rO s rI split_cellsSegment.split_cells sr $ W !$ ' 'c$i WR 888Tc
E3T
E3
++rH c U " S5 $ )zMake a new line segment.
r1 )rk s rI line Segment.line s 4yrH segments
post_stylec x ^ ^^ UnU( a UR mUU 4S jU 5 nT( a
U U4S jU 5 nU$ )a Apply style(s) to an iterable of segments.
Returns an iterable of segments where the style is replaced by ``style + segment.style + post_style``.
Args:
segments (Iterable[Segment]): Segments to process.
style (Style, optional): Base style. Defaults to None.
post_style (Style, optional): Style to apply on top of segment style. Defaults to None.
Returns:
Iterable[Segments]: A new iterable of segments (possibly the same iterable).
c 3 Z ># U H u pnT" X( a S OT" U5 U5 v M" g 7frW r1 ).0rM rS rO applyrk s rI &Segment.apply_style.. s1 -<)D' D'$uV}gFF-# U H' u pnT" UU( a S O
U( a UT- OTU5 v M) g 7frW r1 )r rM rS rO rk r| s rI r r sG .=)D' # 5;fz 1 .=s /2)__add__)rk r{ rN r| result_segmentsr s ` ` @rI apply_styleSegment.apply_style sC & # MME -< O .= O rH ra c d U( a [ [ S5 U5 $ [ [ S5 U5 $ )a Filter segments by ``is_control`` attribute.
Args:
segments (Iterable[Segment]): An iterable of Segment instances.
is_control (bool, optional): is_control flag to match in search.
Returns:
Iterable[Segment]: And iterable of Segment instances.
rO )filterr r )rk r{ ra s rI filter_controlSegment.filter_control s+ *Y/: : z) 4h? ?rH c # Z # / nUR nU H nSUR ; al UR ( d[ Uu pVnU( aM UR S5 u pnU( a U" U " X5 5 U ( a Uv / nUR nU( a MK M} M U" U5 M U( a Uv gg7f)zSplit a sequence of segments in to a list of lines.
Args:
segments (Iterable[Segment]): Segments potentially containing line feeds.
Yields:
Iterable[List[Segment]]: Iterable of segment lists, one per line.
rx N)appendrM rO partition)
rk r{ ry r rc rM rN __textnew_lines
rI split_linesSegment.split_lines s ! Gw||#GOO!(Q,0NN4,@)ET s5 01 "
!!% d w J s B
B+ B+lengthpadinclude_new_linesc # # / nUR nU R nU " S5 n U H n
SU
R ; a U
R ( d| U
u pn
U ( an U R S5 u pn U( a U" U " X5 5 U( a3 U" XbX4S9nU( a UR U 5 Uv UR 5 U ( a Ml M M U" U
5 M U( a
U" XbX4S9v gg7f)a Split segments in to lines, and crop lines greater than a given length.
Args:
segments (Iterable[Segment]): An iterable of segments, probably
generated from console.render.
length (int): Desired line length.
style (Style, optional): Style to use for any padding.
pad (bool): Enable padding of lines that are less than `length`.
Returns:
Iterable[List[Segment]]: An iterable of lines of segments.
rx )rN r N)r adjust_line_lengthrM rO r clear)rk r{ r rN r r ry r r new_line_segmentrc rM
segment_styler r r cropped_lines rI split_and_crop_lines Segment.split_and_crop_lines s * ! 3 3 t9 Gw||#GOO)0&Q,0NN4,@)ET s5 89 '9 ( - ( / /0@ A **
d w! " $TH H s B?C%"C%ry c n [ S U 5 5 nXR: a" U( a X" SX%-
- U5 /- nU$ USS n U$ XR: aq / nUR nSnU HX nUR n XY- U: d UR ( a U" U5 XY-
nM6 Uu pn [ XU-
5 n
U" U " X5 5 U$ U$ USS nU$ )a Adjust a line to a given width (cropping or padding as required).
Args:
segments (Iterable[Segment]): A list of segments in a single line.
length (int): The desired width of the line.
style (Style, optional): The style of padding if used (space on the end). Defaults to None.
pad (bool, optional): Pad lines with spaces if they are shorter than `length`. Defaults to True.
Returns:
List[Segment]: A line of segments with the desired length.
c 3 8 # U H oR v M g 7frW )rT )r rc s rI r -Segment.adjust_line_length..K s BT'--Ts rg Nr )sumr rT rO r )
rk ry r rN r line_lengthr r rc segment_lengthrM r r s
rI r Segment.adjust_line_length8 s & BTBB 3sf.B'CU#K"LL& # 7" !
!H __FK !(!4!4 /&8GOO7O 1K-4*D( /CDD3t34 AwHrH c : ^ [ m[ U4S jU 5 5 $ )zGet the length of list of segments.
Args:
line (List[Segment]): A line encoded as a list of Segments (assumes no '\\n' characters),
Returns:
int: The length of the line.
c 3 J ># U H u po3( a M T" U5 v M g 7frW r1 )r rM rN rO _cell_lens rI r *Segment.get_line_length..p s St';tG7?9T??ts
##)r r )rk ry r s @rI get_line_lengthSegment.get_line_lengthe s StSSSrH linesc r ^ U R mU( a [ U4S jU 5 5 OSnU[ U5 4$ )zGet the shape (enclosing rectangle) of a list of lines.
Args:
lines (List[List[Segment]]): A list of lines (no '\\n' characters).
Returns:
Tuple[int, int]: Width and height in characters.
c 3 4 ># U H
nT" U5 v M g 7frW r1 )r ry r s rI r $Segment.get_shape..} s @%$--%s r )r maxri )rk r max_widthr s @rI get_shapeSegment.get_shaper s3 --DIC@%@@q 3u:&&rH widthheight new_linesc 6 U=( d [ U5 nU( a U " SU- S- U5 /O U " SU- U5 /nU R nUSU n U V
s/ s H o" XUS9PM sn
U SS& [ U 5 U: a! U R U/U[ U 5 -
- 5 U $ s sn
f )a Set the shape of a list of lines (enclosing rectangle).
Args:
lines (List[List[Segment]]): A list of lines.
width (int): Desired width.
height (int, optional): Desired height or None for no change.
style (Style, optional): Style of any padding added.
new_lines (bool, optional): Padded lines should include "
". Defaults to False.
Returns:
List[List[Segment]]: New list of lines.
rg rx N)rN )ri r extend) rk r r r rN r _heightblankr shaped_linesry s rI set_shapeSegment.set_shape s * &CJ 1:Sut#U
+ ,C%KQV@W?X ! 3 3 Xg EJ
EJT t% 8U
Q | w & 7S 5F+F G H
s Brk c U[ U5 -
nU( d USS $ USU nU( a U " SU- S- U5 O U " SU- U5 nX//U- - nU$ )a Aligns lines to top (adds extra lines to bottom as required).
Args:
lines (List[List[Segment]]): A list of lines.
width (int): Desired width.
height (int, optional): Desired height or None for no change.
style (Style): Style of any padding added.
new_lines (bool, optional): Padded lines should include "
". Defaults to False.
Returns:
List[List[Segment]]: New list of lines.
Nrg rx ri rk r r r rN r extra_linesr s rI align_topSegment.align_top sd * s5z) 8Ogv2;C%K$&.S5[RWAX K// rH c U[ U5 -
nU( d USS $ USU nU( a U " SU- S- U5 O U " SU- U5 nU//U- U- nU$ )a Aligns render to bottom (adds extra lines above as required).
Args:
lines (List[List[Segment]]): A list of lines.
width (int): Desired width.
height (int, optional): Desired height or None for no change.
style (Style): Style of any padding added. Defaults to None.
new_lines (bool, optional): Padded lines should include "
". Defaults to False.
Returns:
List[List[Segment]]: New list of lines.
Nrg rx r r s rI align_bottomSegment.align_bottom sf * s5z) 8Ogv2;C%K$&.S5[RWAX K'%/ rH c U[ U5 -
nU( d USS $ USU nU( a U " SU- S- U5 O U " SU- U5 nUS- nXh-
n U//U- U- U//U - - nU$ )a Aligns lines to middle (adds extra lines to above and below as required).
Args:
lines (List[List[Segment]]): A list of lines.
width (int): Desired width.
height (int, optional): Desired height or None for no change.
style (Style): Style of any padding added.
new_lines (bool, optional): Padded lines should include "
". Defaults to False.
Returns:
List[List[Segment]]: New list of lines.
Nrg rx r" r )
rk r r r rN r r r top_lines bottom_liness
rI align_middleSegment.align_middle s * s5z) 8Ogv2;C%K$&.S5[RWAX 1$ ". I%-% L0HH rH c # : # [ U5 n [ U5 n[ nU H` nUR UR :X a= UR
( d, U" UR UR - UR 5 nMZ Uv UnMb Uv g! [ a gf = f7f)a Simplify an iterable of segments by combining contiguous segments with the same style.
Args:
segments (Iterable[Segment]): An iterable of segments.
Returns:
Iterable[Segment]: A possibly smaller iterable of segments that will render the same way.
N)iternext
StopIterationrK rN rO rM )rk r{
iter_segments last_segmentrl rc s rI simplifySegment.simplify s X
.L $G!!W]]27?? ' %% 4l6H6H #" & % s( B B A1B
BBBBc # # U HN nUR ( d
UR c Uv M' Uu p4nU " X4( a UR S5 OS5 v MP g7f)zRemove all links from an iterable of styles.
Args:
segments (Iterable[Segment]): An iterable segments.
Yields:
Segment: Segments with link removed.
N)rO rN update_link)rk r{ rc rM rN _controls rI strip_linksSegment.strip_links sL G'--"7
(/%X$5 1 1$ 7dKK r[ c # < # U H u p#nU " USU5 v M g7f)zRemove all styles from an iterable of segments.
Args:
segments (Iterable[Segment]): An iterable segments.
Yields:
Segment: Segments with styles replace with None
Nr1 )rk r{ rM rS rO s rI strip_stylesSegment.strip_styles) s% &. !D'dD'* * &.s c # # 0 nU HJ u p4nU( a1 UR U5 nUc UR nXbU' U " X6U5 v M> U " USU5 v ML g7f)zRemove all color from an iterable of segments.
Args:
segments (Iterable[Segment]): An iterable segments.
Yields:
Segment: Segments with colorless style.
N)get
without_color)rk r{ cacherM rN rO colorless_styles rI remove_colorSegment.remove_color6 s` %'$, D"'))E"2"*&+&9&9O#2%L$99$g.. %-s AAcutsc # # / nUR n[ U5 n [ US5 nUS:X a / $ US:w a O/ v M! SnUR nUR n [
n
U H n U u pnU ( d M U( a UO Xz" U 5 - nX: a U" U 5 UnM5 X:X a@ U" U 5 U " 5 v U" 5 Un[ US5 nUS:X a U( a U " 5 v gMz U R
Xg-
5 u nn U u pnU" U5 U " 5 v U" 5 Un[ US5 nUS:X a U( a U " 5 v gU ( a M M U " 5 v g7f)zDivides an iterable of segments in to portions.
Args:
cuts (Iterable[int]): Cell positions where to divide.
Yields:
[Iterable[List[Segment]]]: An iterable of Segments in List.
r N)r r r r copyr ru )rk r{ r split_segments add_segment iter_cutsrd rn segments_clear
segments_copyr rc rM rS rO end_posro s rI divideSegment.divideL sf +-$++ J y"%Cby axH
'--&++
# G$+ !D'$!(#cIdO.C= (!C> ('/)"$!C y"-Cby)"// 1 '.&9&9#)&DOFG,3)D' ''/)"$ C9b)"9% +o-C $ J o s A+E
1C E
<E
r1 )rP rK )NNF)NTT)NT)NNF)/r2 r3 r4 r5 r6 str__annotations__rN r
r rO r ControlCodepropertyrh rT r rY r] r^ ra classmethodr r rr ru ry r
r r r r r r r r r r r r r r r r r r rG r1 rH rI rK rK ? s
I !E8E?!/3GXh{+
,3
0S 0 0 v $ (D ( ( y$69 $63 $65AU;V $6 $6L,s ,u-A'B ,, "&&* & 9%& & UO &
) & & P ?D@ *@8<@ ) @ @$ 8I#6 8DO;T 8
"&"&
,I9%,I ,I ,I
,I
,I
$y/ ",I ,I\
"& *9o* * *
*
i
* *X
T4 ?
Ts
T
T 'd4 ? 3 'c3h ' '
!%!%
! DO$! !
!
!
!
d9o ! ! F
)_DO$
d9o 8
)_DO$
d9o 8
)_ DO$
d9o < 3 8K 4 L8I#6 L8I;N L L
+HY$7
+HY><<>D ==
) }} $ $s AAAA)r r{ r r r r r rP r ) r2 r3 r4 r5 r6 r
rK r] r r rG r1 rH rI r r sD #'!2 #t #PT # % %+; % %rH r c P \ rS rSrS S\\\ S\SS4S jjr S
S jr Sr
g) SegmentLinesi r r rP Nc 0 [ U5 U l X l g)a A simple renderable containing a number of lines of segments. May be used as an intermediate
in rendering process.
Args:
lines (Iterable[List[Segment]]): Lists of segments forming lines.
new_lines (bool, optional): Insert new lines after each line. Defaults to False.
N)r r r )rR r r s rI r SegmentLines.__init__ s %[
"rH c # # U R ( a6 [ R 5 nU R H nU S h vN Uv M g U R H
nU S h vN M g N+ N 7frW )r rK ry r )rR r r r ry s rI r SegmentLines.__rich_console__ sT >> ||~H
#
# s! :A,A(!A, A*
A,*A,)r r r r ) r2 r3 r4 r5 r
r rK r] r r rG r1 rH rI r r sC #htG} 5 #$ #SW #
+;
rH r __main__)r )Syntax)Textzfrom rich.console import Console
console = Console()
text = Text.from_markup("Hello, [bold magenta]World[/]!")
console.print(text)z Hello, [bold magenta]World[/]!z rich.Segmentz]A Segment is the last step in the Rich render process before generating text with ANSI codes.z
Consider the following code:
pythonT) line_numberszRWhen you call [b]print()[/b], Rich [i]renders[/i] the object in to the following:
zAThe Segments are then processed to produce the following output:
zS
You will only need to know this if you are implementing your own Rich renderables.N):enumr functoolsr itertoolsr loggingr operatorr typingr r r
r r r
r r r r cellsr r r r r reprr r rN r r r r r logr rh r r rK r r r2 pip._vendor.rich.consolepip._vendor.rich.syntaxr pip._vendor.rich.textr code from_markuprM ruleprintr render fragmentsr1 rH rI r s ! $ >>' * + +uS#X
&' +sC
" O j O
O d% %2 2 z0.* D
< =DiG LL MMg MM45 MM&xd;< MMO MM] W^^D)*I MM) MMO MMVW MM$ MM^; rH