R`i^ d dl mZ d dlmZ d dlmZ d dlmZ d dlm Z d dl
m Z m Z m
Z
mZmZmZmZmZmZmZ ddlmZmZmZmZmZ dd lm Z m Z dd
l m Z e r
dd l m!Z!m"Z"m#Z# ed Z$ G d
de Z%eee% ee%ee&e'f f ee%e&e&f f Z( e G d de Z) G d d Z* G d d Z+e,dk( rd dl-m!Z! d dl.m/Z/ d dl0m1Z1 dZ2 e1jf d Z4 e! Z e jk d e jm d e jm d e jm e/e2d d e jm e jm d! e7e jq e4 Z9e jm e9 e jm e jm d" e jm e4 e jm d# y$y$)% )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 P e Zd ZdZdZdZdZdZdZdZ dZ
d Z d
Z d Z
d Zd
ZdZdZdZdZy) ControlTypezDNon-printable control codes which typically translate to ANSI codes.r
N)__name__
__module__ __qualname____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 /builddir/build/BUILDROOT/alt-python312-pip-23.3.1-3.el8.x86_64/opt/alt/python312/lib/python3.12/site-packages/pip/_vendor/rich/segment.pyr r # sY N DO D
EKKIKNO NMrE r c v e Zd ZU dZeed< dZee ed< dZ ee
e ed< e de
fd ZdefdZdefd Ze defd
Ze ed d d d
e
ded fd Zd
e
ded fdZed/d Ze d0ded dee dee ded fd Ze d1ded deded fd Z eded dee d fd Z e d2ded de
dee dededee d f d Z e d3d e d de
dee dede d f
d Z ed e d de
fd Z!ed e e d dee
e
f fd Z"e d4d e e d d!e
d"ee
dee d#ede e d f d$ Z#e d1d%e$d d e e d d!e
d"e
ded#ede e d fd& Z%e d1d%e$d d e e d d!e
d"e
ded#ede e d fd' Z&e d1d%e$d d e e d d!e
d"e
ded#ede e d fd( Z'eded ded fd) Z(eded ded fd* Z)eded ded fd+ Z*eded ded fd, Z+eded d-ee
dee d fd. Z,y)5Segmenta 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 , | \ }}}|rdS t | S )zzThe number of terminal cells required to display self.text.
Returns:
int: A number of cells.
r )r )selfrI _stylerK s rF cell_lengthzSegment.cell_lengthQ s! !% fgq/$ /rE c # K | j | j | j | j y y | j | j y wN)rI rK rJ rN s rF
__rich_repr__zSegment.__rich_repr__[ sH ii << zz%jj & ** ,, s AAc , t | j S )z#Check if the segment contains text.)boolrI rS s rF __bool__zSegment.__bool__d s DII rE c | j duS )z,Check if the segment contains control codes.N)rK rS s rF
is_controlzSegment.is_controlh s ||4''rE i @ segmentcut)rH rH c |\ }}}t }|j }||k\ r | |d|| fS t }t ||z t | dz
z } |d | }
t |
} | |k( r ||
|| ||| d || fS | t | k rm|| } | dz
} | || z
} |d | }
| |k( r ||
|| ||| d || fS | |kD r# ||
d | dz
dz || |d|| d z || fS | t | k rmt
d )N r zWill never reach here)rH rP r intlenr AssertionError)
clsrZ r[ rI rJ rK _SegmentrP cell_sizeposbeforecell_poschars
rF _split_cellszSegment._split_cellsm si ' eW )) + HR 88 8+ 3$TQ 78dsF# s?0cdUG4
CIo9D 1HC $ 'H$3ZF3 VUG4 T#$Z8 #~ VIcAg . 4eWE S4: -ug> CIo 455rE c | \ }}}t | r=|t | k\ r| t d|| fS t |d| || t ||d || fS | j | | S )a0 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.
r] N)r r` rH ri )rN r[ rI rJ rK s rF split_cellszSegment.split_cells s{ $ eW !$ 'c$i WR 888Tc
E73ST
E73
s++rE c | d S )zMake a new line segment.
rD )rb s rF linez Segment.line s 4yrE segments
post_stylec ` |}|r|j fd|D }r fd|D }|S )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 N K | ] \ }}} ||rd n | | y wrR rD ).0rI rO rK applyrb s rF z&Segment.apply_style.. s1 -<)D&' D'$uV}gF-. sE .=)D&' # 5;fz 1 .=s #&)__add__)rb ro rJ rp result_segmentsrt s ` ` @rF apply_stylezSegment.apply_style sC & # MME -< O .= O rE rY c Z |rt t d | S t t d | S )a2 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.
rK )filterr r )rb ro rY s rF filter_controlzSegment.filter_control s+ *Y/: : z) 4h? ?rE c # K g }|j }|D ]k }d|j v rS|j sG|\ }}}|s&|j d \ }} }|r | | || | r| g }|j }|r=d || m |r| yyw)a Split 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.
rm N)appendrI rK partition)
rb ro rn r~ rZ rI rJ __textnew_lines
rF split_lineszSegment.split_lines s ! Gw||#GOO!(eQ,0NN4,@)E8T s5% 01 "
!!% w J s 6B .K s BT''--Ts r^ Nr )sumr~ rP rK r )
rb rn r rJ r line_lengthr r~ rZ segment_lengthrI r r s
rF r zSegment.adjust_line_length8 s & BTBB 3sf{.B'CU#K"LL& # 7" ! 6
!H __FK !(!4!4 /&8GOO7O >1K-4*D-(v /CDD3t]34 AwHrE c 8 t t fd|D S )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 < K | ] \ }}}|r
| y wrR rD )rs rI rJ rK _cell_lens rF ru z*Segment.get_line_length..p s St';tUG79T?ts
)r r )rb rn r s @rF get_line_lengthzSegment.get_line_lengthe s StSSSrE linesc f | j |rt fd|D nd}|t | fS )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 . K | ] } | y wrR rD )rs rn r s rF ru z$Segment.get_shape..} s @%$-%s r )r maxr` )rb r max_widthr s @rF get_shapezSegment.get_shaper s3 --DIC@%@@q 3u:&&rE widthheight new_linesc $ |xs t | }|r | d|z dz | gn | d|z | g}| j }|d| } |D
cg c]
}
||
|| c}
| dd t | |k r!| j |g|t | z
z | S c c}
w )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.
r^ rm N)rJ )r` r extend) rb r r r rJ r _heightblankr shaped_linesrn s rF set_shapezSegment.set_shape s * &CJ 1:Sut#U
+ ,C%KQV@W?X ! 3 3 Xg EJ
EJT tU% 8U
Q | w & 7S 5F+F G H
s B
rb c |t | z
}|s|dd S |d| }|r | d|z dz | n | d|z | }||gg|z z }|S )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.
Nr^ rm r` rb r r r rJ r extra_linesr s rF align_topzSegment.align_top sf * s5z) 8Ogv2;C%K$&.S5[RWAX% K// rE c |t | z
}|s|dd S |d| }|r | d|z dz | n | d|z | }|gg|z |z }|S )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.
Nr^ rm r r s rF align_bottomzSegment.align_bottom sf * s5z) 8Ogv2;C%K$&.S5[RWAX K'%/ rE c |t | z
}|s|dd S |d| }|r | d|z dz | n | d|z | }|dz }||z
} |gg|z |z |gg| z z }|S )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.
Nr^ rm r! r )
rb r r r rJ r r r top_lines bottom_liness
rF align_middlezSegment.align_middle s * s5z) 8Ogv2;C%K$&.S5[RWAX 1$ "Y. I%-% L0HH rE c # & K t | } t | }t }|D ]X }|j |j k( r7|j
s+ ||j |j z |j }S| |}Z | y# t $ r Y yw xY ww)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
StopIterationrH rJ rK rI )rb ro
iter_segments last_segmentrc rZ s rF simplifyzSegment.simplify s X
.L $G!!W]]27?? ' %% 4l6H6H #" & % s( B B A(B B B
BBc # K |D ]C }|j s |j | |\ }}} | ||r|j d nd E yw)zRemove all links from an iterable of styles.
Args:
segments (Iterable[Segment]): An iterable segments.
Yields:
Segment: Segments with link removed.
N)rK rJ update_link)rb ro rZ rI rJ _controls rF strip_linkszSegment.strip_links sO G'--"7
(/%eX$5 1 1$ 7dKK s A
A c # : K |D ] \ }}} | |d| yw)zRemove all styles from an iterable of segments.
Args:
segments (Iterable[Segment]): An iterable segments.
Yields:
Segment: Segments with styles replace with None
NrD )rb ro rI rO rK s rF strip_styleszSegment.strip_styles) s( &. !D&'dD'* * &.s c # K i }|D ]E \ }}}|r1|j | }||j }|||< | ||| : | |d| G yw)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)rb ro cacherI rJ rK colorless_styles rF remove_colorzSegment.remove_color6 sg %'$, D%"'))E"2"*&+&9&9O#2E%L$99$g.. %-s AAcutsc # X K g }|j }t | } t |d }|dk( rg S |dk7 rng d}|j }|j } t
}
|D ] } | \ } }
}| s |r|n
| |
| z }||k r || |}+||k( r9 || | | |}t |d }|dk( r
|r | yi| j
||z
\ }} | \ } }
} || | | |}t |d }|dk( r
|r | y| r | yw)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 rk )rb ro r split_segments add_segment iter_cutsr[ re segments_clear
segments_copyr rZ rI rO rK end_posrf s rF dividezSegment.divideL sm +-$++ J y"%Cby axH
'--&++
# G$+ !D&'!(#cIdO.CS= (!Cc> ('/)"$!C y"-Cby)"// 1 '.&9&9#)&DOFG,3)D&' ''/)"$ C9b)"9% +o-C J o s A&D*)B4D* D*)rL rH )NNF)NTT)NT)NNF)-r0 r1 r2 r3 str__annotations__rJ r
r rK r ControlCodepropertyr_ rP r rT rV rW rY classmethodr r ri rk rn r
ry r| r r r r r r r r r r r r r r r r rD rE rF rH rH ? 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 A
A A
Ar r r r r rL r ) r0 r1 r2 r3 r
rH rV r r rD rE rF r r sD #'!2 #t #PT # % %+; % %rE r c B e Zd Zddeee deddfdZ ddZy) SegmentLinesr r rL Nc 2 t | | _ || _ y)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 )rN r r s rF r zSegmentLines.__init__ s %[
"rE c # K | j r4t j }| j D ] }|E d { | y | j D ] }|E d { y 7 '7 wrR )r rH rn r )rN r r r rn s rF r z SegmentLines.__rich_console__ sV >> ||~H
#
# s! 5A#A A#A!A#!A#r r ) r0 r1 r2 r
r rH rV r r rD rE rF r r sC #htG} 5 #$ #SW #
+;
rE 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 rJ r r r r r logr r_ r r rH r r r0 pip._vendor.rich.consolepip._vendor.rich.syntaxr pip._vendor.rich.textr code from_markuprI ruleprintr render fragmentsrD rE rF r s ! $ >>' * + +uS#X
&' +sC
" O j O
O d% %2 2 z0.* D
4 < =DiG LL MMg MM45 MM&xd;< MMO MM] W^^D)*I MM) MMO MMVW MM$ MM^; rE