U
ʗRe[ @ s d dl mZmZmZ d dlmZmZmZmZm Z m
Z
m Z m Z m
Z
ddlmZmZ ddlmZmZ ddlmZ ddlmZmZ ddlmZ dd lm Z dd
l m Z dd l m Z m!Z! dd l"m#Z# dd
l$m%Z% ddl&m'Z'm(Z( ddl)m*Z*m+Z+ erddl,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2 eG dd dZ3eG dd dZ4G dd de Z5G dd de Z6e7dkrd dl8m-Z- d dl9m:Z: d d l;m6Z6 dd le>j?d#d$d%d&d' e>j?d(d)d* e>j?d+d!d,d- e>@d.d/d0 e>@d1d2d3 e>j@d4d5d6d7d&d8 e>@d9d:d; eAdd?ZBe- Z,e: ZCeBd@ e,jDe>dAdB d&e>_EeBdC e,De> dDe>_FeBdE e,jDe>dAdB d_FdFe>_EdGdHge>_GeBdI e,jDe>dAdB d_FdFe>_EdGdHge>_Gde>_HeBdJ e,jDe>dAdB d_FdFe>_EdGdHge>_Gd&e>_Id e>_HeBdK e,jDe>dAdB W 5 Q R X d r? rA rA rB cellsv s z Column.cellsc C s
| j dk S )z!Check if this column is flexible.N)r7 r? rA rA rB flexible{ s zColumn.flexible) __name__
__module__ __qualname____doc__r) __annotations__r* r+ r r, r- r/ r1 r3 r4 r
intr5 r6 r7 r8 boolr9 r listr; r rC propertyr rD rE rA rA rA rB r' & s*
r' c @ s. e Zd ZU dZdZee ed< dZe ed< dS )Rowz Information regarding a row.Nr- F end_section)
rF rG rH rI r- r
r rJ rP rL rA rA rA rB rO s
rO c @ s* e Zd ZU dZeed< ded< eed< dS )_CellzA single cell in a table.r- r%
renderabler1 N)rF rG rH rI r rJ r rA rA rA rB rQ s
rQ c @ s e Zd ZU dZee ed< ee ed< ddddej ddddddddddd dd
d dddd d dd
e
ee f e e
e e
e e e e e ej e e eeeeeeeeeee ee e e e e e e e e e e ddeddddZeddddde
ee f eeeed dddZeedddZejeddddZeeddd Zeedd d Zd eed d!d"Z d d#e d$d%d&Z ee eeeef dd'd(Z e jed d)d*d(Z dNdddd,d-d.dddddd/ d0d0e e e e e e dd1d2e e e e e e e e edd3d4d5Z!ddd6e d0 e e edd7d8d9Z"d d#d:d$d;d<Z#d d#ee d$d=d>Z$eee ee eee d?d@dAZ%d eeee& dBdCdDZ'eedEdFdGZ(d d#ee dHdIdJZ)d d#ee d:dKdLdMZ*dS )OTablea A console renderable to draw a table.
Args:
*headers (Union[Column, str]): Column headers, either as a string, or :class:`~rich.table.Column` instance.
title (Union[str, Text], optional): The title of the table rendered at the top. Defaults to None.
caption (Union[str, Text], optional): The table caption rendered below. Defaults to None.
width (int, optional): The width in characters of the table, or ``None`` to automatically fit. Defaults to None.
min_width (Optional[int], optional): The minimum width of the table, or ``None`` for no minimum. Defaults to None.
box (box.Box, optional): One of the constants in box.py used to draw the edges (see :ref:`appendix_box`), or ``None`` for no box lines. Defaults to box.HEAVY_HEAD.
safe_box (Optional[bool], optional): Disable box characters that don't display on windows legacy terminal with *raster* fonts. Defaults to True.
padding (PaddingDimensions, optional): Padding for cells (top, right, bottom, left). Defaults to (0, 1).
collapse_padding (bool, optional): Enable collapsing of padding around cells. Defaults to False.
pad_edge (bool, optional): Enable padding of edge cells. Defaults to True.
expand (bool, optional): Expand the table to fit the available space if ``True``, otherwise the table width will be auto-calculated. Defaults to False.
show_header (bool, optional): Show a header row. Defaults to True.
show_footer (bool, optional): Show a footer row. Defaults to False.
show_edge (bool, optional): Draw a box around the outside of the table. Defaults to True.
show_lines (bool, optional): Draw lines between every row. Defaults to False.
leading (bool, optional): Number of blank lines between rows (precludes ``show_lines``). Defaults to 0.
style (Union[str, Style], optional): Default style for the table. Defaults to "none".
row_styles (List[Union, str], optional): Optional list of row styles, if more than one style is given then the styles will alternate. Defaults to None.
header_style (Union[str, Style], optional): Style of the header. Defaults to "table.header".
footer_style (Union[str, Style], optional): Style of the footer. Defaults to "table.footer".
border_style (Union[str, Style], optional): Style of the border. Defaults to None.
title_style (Union[str, Style], optional): Style of the title. Defaults to None.
caption_style (Union[str, Style], optional): Style of the caption. Defaults to None.
title_justify (str, optional): Justify method for title. Defaults to "center".
caption_justify (str, optional): Justify method for caption. Defaults to "center".
highlight (bool, optional): Highlight cell contents (if str). Defaults to False.
columnsrowsN)r r FTr nonez table.headerz table.footercenter)titlecaptionr4 r5 r safe_boxpaddingcollapse_paddingpad_edgeexpand show_header show_footer show_edge
show_linesleadingr-
row_stylesr+ r, border_style title_style
caption_style
title_justifycaption_justify highlightr# )headersrX rY r4 r5 r rZ r[ r\ r] r^ r_ r` ra rb rc r- rd r+ r, re rf rg rh ri rj r= c G s g | _ g | _|| _|| _|| _|| _|| _|| _t || _
| | _ |
| _ | | _
| | _|
| _|| _|| _|| _|| _|pxd| _|pd| _|| _|| _|| _|| _|| _|| _t |pg | _ | j j }|D ]0} t | t r| j!| d qt"| j | _#|| qd S )Nr( )r) )$rT rU rX rY r4 r5 r rZ r unpack_paddingr] _expandr_ r` ra rb rc r\ r- r+ r, re rf rg rh ri rj rM rd append
isinstancestr
add_columnlenr9 ) r@ rX rY r4 r5 r rZ r[ r\ r] r^ r_ r` ra rb rc r- rd r+ r, re rf rg rh ri rj rk
append_columnr) rA rA rB __init__ sB
zTable.__init__)r[ r\ r] r^ )rk r[ r\ r] r^ r= c G s | |d||ddd||dS )a Get a table with no lines, headers, or footer.
Args:
*headers (Union[Column, str]): Column headers, either as a string, or :class:`~rich.table.Column` instance.
padding (PaddingDimensions, optional): Get padding around cells. Defaults to 0.
collapse_padding (bool, optional): Enable collapsing of padding around cells. Defaults to True.
pad_edge (bool, optional): Enable padding around edges of table. Defaults to False.
expand (bool, optional): Expand the table to fit the available space if ``True``, otherwise the table width will be auto-calculated. Defaults to False.
Returns:
Table: A table instance.
NF)r r[ r\ r_ r` ra r] r^ rA )clsr[ r\ r] r^ rk rA rA rB grid s z
Table.gridr< c C s | j p| jdk S )z-Setting a non-None self.width implies expand.N)rn r4 r? rA rA rB r^ s z Table.expand)r^ r= c C s
|| _ dS )z Set expand.N)rn )r@ r^ rA rA rB r^ ! s c C s4 d}| j r| jr|d7 }| j r0|t| jd 7 }|S )z'Get extra width to add to cell content.r r )r ra rs rT )r@ r4 rA rA rB _extra_width& s zTable._extra_widthc C s
t | jS )z Get the current number of rows.)rs rU r? rA rA rB row_count0 s zTable.row_countr! )consoleindexr= c C sR t }| jr,||| j|t| j 7 }| j| j}|dk rN|||7 }|S )zGet the current row style.N)r nullrd get_stylers rU r- )r@ r{ r| r- row_stylerA rA rB
get_row_style5 s zTable.get_row_styler" )r{ optionsr= c s j | jd k r| jdk r(tddS | j}t| | | j fdd| jD }tdd |D | }| jd krtdd |D | n| j}t||}| | j
}|S )Nr c s g | ]} |qS rA ) update_width.0column_measure_columnr{ r6 r rA rB
P s z*Table.__rich_measure__..c s s | ] }|j V qd S N)minimumr measurementrA rA rB U s z)Table.__rich_measure__..c s s | ] }|j V qd S r maximumr rA rA rB r X s ) r6 r4 r ry sum_calculate_column_widthsr r rT clampr5 )r@ r{ r extra_width measurements
minimum_width
maximum_widthr rA r rB __rich_measure__? s2
zTable.__rich_measure__c C s | j S )zGet cell padding.)rm r? rA rA rB r[ ` s z
Table.padding)r[ r= c C s t || _| S )zSet cell padding.)r rl rm )r@ r[ rA rA rB r[ e s r( r. r0 r2 ) r+ r, r- r/ r1 r3 r4 r5 r6 r7 r8 r% r r$ )r) r* r+ r, r- r/ r1 r3 r4 r5 r6 r7 r8 r= c C sF t t| j|||pd|pd|p d|||| |
| | |
d}| j| dS )a Add a column to the table.
Args:
header (RenderableType, optional): Text or renderable for the header.
Defaults to "".
footer (RenderableType, optional): Text or renderable for the footer.
Defaults to "".
header_style (Union[str, Style], optional): Style for the header, or None for default. Defaults to None.
footer_style (Union[str, Style], optional): Style for the footer, or None for default. Defaults to None.
style (Union[str, Style], optional): Style for the column cells, or None for default. Defaults to None.
justify (JustifyMethod, optional): Alignment for cells. Defaults to "left".
vertical (VerticalAlignMethod, optional): Vertical alignment, one of "top", "middle", or "bottom". Defaults to "top".
overflow (OverflowMethod): Overflow method: "crop", "fold", "ellipsis". Defaults to "ellipsis".
width (int, optional): Desired width of column in characters, or None to fit to contents. Defaults to None.
min_width (Optional[int], optional): Minimum width of column, or ``None`` for no minimum. Defaults to None.
max_width (Optional[int], optional): Maximum width of column, or ``None`` for no maximum. Defaults to None.
ratio (int, optional): Flexible ratio for the column (requires ``Table.expand`` or ``Table.width``). Defaults to None.
no_wrap (bool, optional): Set to ``True`` to disable wrapping of this column.
r( )r9 r) r* r+ r, r- r/ r1 r3 r4 r5 r6 r7 r8 N)r' rs rT ro )r@ r) r* r+ r, r- r/ r1 r3 r4 r5 r6 r7 r8 r rA rA rB rr k s" %zTable.add_columnr- rP ) renderablesr- rP r= c G s t ddddd}t|}| j}t|t|k rJ|dgt|t| }t|D ]\}}|t|krt |d} | jD ]}
|| td qv| j| n|| } |dkr|| d qRt|r|| | qRt
dt |j d qR| jt
||d
dS ) a Add a row of renderables.
Args:
*renderables (None or renderable): Each cell in a row must be a renderable object (including str),
or ``None`` for a blank cell.
style (StyleType, optional): An optional style to apply to the entire row. Defaults to None.
end_section (bool, optional): End a section and draw a line. Defaults to False.
Raises:
errors.NotRenderableError: If you add something that can't be rendered.
r% N)r rR r= c S s | j | d S r )r; ro )r rR rA rA rB add_cell s z Table.add_row..add_cell)r9 r( zunable to render z1; a string or other renderable object is requiredr )r' rM rT rs enumeraterU r ro r r NotRenderableErrortyperF rO ) r@ r- rP r r cell_renderablesrT r| rR r _rA rA rB add_row s,
z
Table.add_rowr& c # s | j stdV d S |j}| jd k r*| j}| j}| ||| }t|| }|j|| j d dd t
t ddd fdd
}| j r|| j t
| jd | jd
E d H | |E d H | jr|| jt
| jd | jd
E d H d S )
N
)r4 rj heightrW r# r& )textr- r/ r= c s4 t | tr j| |ddn| } j|j|ddS )NF)r- rj r/ )r )rp rq
render_strrenderupdate)r r- r/ render_textr{ render_optionsrA rB render_annotation s
z1Table.__rich_console__..render_annotationz table.title)r- r/ z
table.caption)rW )rT r r6 r4 ry r r r r rj r r rX r
pick_firstrf rh _renderrY rg ri )r@ r{ r r6 r widths table_widthr rA r rB __rich_console__ sJ
zTable.__rich_console__c s j }j} fdd|D }dd |D }jj}jrdd |D }t|rdd t||D } fdd|D }
|t| } t| ||
} t | }
t
|D ]"\}}|j r| | t |
||< qt|}||krX
|dd |D |}t|}||kr.|| }t|dgt| ||}t|} fd dt||D }d
d |D }||k rjjsjd k r|j| k rȈjd kr|ntj| |}t|| |}d d t||D }|S )
zNCalculate the widths of each column, including padding, not including borders.c s g | ]} |qS rA )r r r{ r r@ rA rB r s z2Table._calculate_column_widths..c S s g | ]}|j pd qS r r r _rangerA rA rB r
s c S s g | ]}|j r|jpd qS r )rE r7 )r colrA rA rB r s c S s g | ]\}}|j rd n|jqS r )rE r )r r r rA rA rB r s c s& g | ] }|j r|jpd |j qS r )rE r4 r9 r )get_padding_widthrA rB r s c S s g | ]}|j d ko|j qS r )r4 r8 r rA rA rB r $ s r c s$ g | ] \}} ||qS rA )r r )r r4 r r rA rB r . s c S s g | ]}|j pd qS r r r rA rA rB r 2 s Nc S s g | ]\}}|| qS rA rA )r _widthpadrA rA rB r = s )r6 rT _get_padding_widthry r^ anyzipr r iterr rE next_collapse_widthsr rs r5 min)r@ r{ r r6 rT width_rangesr r ratios fixed_widths flex_minimumflexible_width flex_widthsiter_flex_widthsr| r r excess_width
_max_width
pad_widthsrA )r{ r r r@ rB r sf
z Table._calculate_column_widths)r wrapabler6 r= c
s t |}|| }t|r|r|dkrtdd t||D t fddt||D } | } fddt||D }t|r|sqt||gt| } t||| |}t |}|| }q|S )aM Reduce widths so that the total is under max_width.
Args:
widths (List[int]): List of widths.
wrapable (List[bool]): List of booleans that indicate if a column may shrink.
max_width (int): Maximum width to reduce to.
Returns:
List[int]: A new list of widths.
r c s s | ]\}}|r|V qd S r rA r r4
allow_wraprA rA rB r S s z)Table._collapse_widths..c 3 s& | ] \}}|r| kr|nd V qdS )r NrA r
max_columnrA rB r V s c s$ g | ] \}}| kr |r d ndqS )r r rA r r rA rB r [ s z*Table._collapse_widths..)r r maxr r rs r )
rv r r r6 total_widthr second_max_columncolumn_differencer
max_reducerA r rB r A s*
zTable._collapse_widths)r{ column_indexr r= c # st | j | j| jt}|dk|t| jd ki tttttttf d fdd }g }|j }|j
}| j r|| j pd||j } || |j
f ||jpd}
|jD ]} ||
| f q| jr|| jpd||j } || |jf |rBt}
t|D ]:\}}\}}t||
||||t|ddp6|jV qn.|D ](\}}t||t|ddpf|jV qFdS ) z3Get all the cells with padding and optional header.r r ) first_rowlast_rowr= c s | |f}|r|S \}}}}rJs8td|| }|sJtd|| }snrVd}r^d}| rfd}|rnd}||||f}| | |f< |S )Nr )getr )r r cachedr0 rightbottomr. rm _padding_cacher\ first_column last_columnr] r[ rA rB get_paddingw s* z%Table._get_cells..get_paddingr( r1 N)r\ r] r[ r rs rT rL r rK ro r~ r_ r+ r) r- rD r` r, r* r r rQ getattrr1 )r@ r{ r r any_paddingr raw_cells_appendr~ r+
cell_stylecellr, _Paddingfirstlastr- rR rA r rB
_get_cellsh sL ,
zTable._get_cells)r r= c C s2 | j \}}}}| jr*|dkr*td|| }|| S )z Get extra width from padding.r )r[ r\ r )r@ r r pad_rightpad_leftrA rA rB r s
zTable._get_padding_width)r{ r r r= c C s |j }|dk rtddS | |j}|jdk rJt|j| |j| |S g }g }|j}|j} tj}
| ||j|D ]&} |
||| j \} }
|| | |
qtt|rt
|nd|rt
|n||}| |j dkrdn|j | |j dkrdn|j | }|S )z0Get the minimum and maximum width of the column.r r N)
r6 r r r9 r4 with_maximumro r r rR r r r5 )r@ r{ r r r6
padding_width
min_widths
max_widths
append_min
append_maxget_render_widthr _min_maxr rA rA rB r s>
zTable._measure_column)r{ r r r= c % # s jp d}| jp d } fddt jD }tt| } jrj jj|t j
j
dnd }|r j s| n|}t
} j}
j } j} j}
j} j}t
|r> |j| |j| |j|f |j| |j| |j|f |j| |j| |j|fg}|
rB | ||V | V ng } j }j tt |D ]\}\}}}|or| |o|| ss j || nd }dg }srt ! n || r|d n|t|||
D ]Z\}}}|j"||j#|j$|j%d d}j&|j'||j d} t(t)| |*| qt(dd |D t+t+t
d t,t t+t+t
d
fd d fd
dt||||
D |d d < |r|r| r܈ |j-|d|
d|V | V ||rdn |rdnd \} } } | j./ r| n | j.j0| j } t1D ]R}!|
r:| V t2|D ]$\}"}#|#|! E d H |"sB| V qB|
rt| V | V q*n0t1D ]&}!|D ]}#|#|! E d H q| V q|r|r| r |j-|d|
d|V | V |o|j3}$|rZ|s|s|$rZ|sZ| r"|t)|d ksZ| r.sZ|rR |j-|d|
d| |V n |j-|d|
d|V | V qZ|r|
r |4||V | V d S )Nr( c 3 s | ]\}} ||V qd S r )r )r r r )r{ r@ rA rB r s z Table._render..)safer )r4 r/ r8 r3 r r- c s s | ]}t |V qd S r )rs )r r rA rA rB r : s r )r r1 r4 r- r= c sR r
d}nrd}|dkr* | ||S |dkrB | ||S | ||S )Nr r0 middle) align_top align_middle align_bottom)r r1 r4 r- )_Segment
footer_row
header_row
row_heightrA rB
align_cell< s z!Table._render..align_cellc
s8 g | ]0\}}}} ||j||j |qS rA ) set_shaper1 r- )r r4 _cellr r )r r r~
max_heightr rA rB r M s
z!Table._render..foot)edger rx headmidrow)5r~ r- re r rT rM r r
substituter rZ r_ get_plain_headed_boxr liner` ra rb rc head_left
head_right
head_vertical foot_left
foot_right
foot_verticalmid_left mid_right mid_verticalget_topr r rU r r} r r/ r8 r3 render_linesrR r rs ro r rK get_rowr stripbackground_styleranger rP
get_bottom)%r@ r{ r r table_stylere
_column_cells row_cells_boxnew_linerT r_ r` ra rb rc box_segmentsr r| r r row_cellr rD r4 r r r linesr. r _dividerdividerline_no last_cell
rendered_cellrP rA )
r r r{ r r~ r r r r r@ rB r s
"
z
Table._render)r( r( )+rF rG rH rI r r' rJ rO r
HEAVY_HEADr
rq r
r rK BoxrL r r r ru classmethodrw rN r^ setterry rz r r r r r[ rr r r r r rQ r r r r rA rA rA rB rS s6
A
! : 0 1 @ ' I
) rS __main__)r! )ReprHighlighter)rS )timerz Table renderzStar Wars MovieszRich example tabler )rX rY ri ZReleased bright_cyancyanT)r+ r- r8 ZTitlemagentar z
Box Officegreen)r/ r- z Dec 20, 2019z Star Wars: The Rise of Skywalkerz $952,110,690z May 25, 2018zSolo: A Star Wars Storyz $393,151,347z Dec 15, 2017z!Star Wars Ep. V111: The Last Jediz$1,332,539,889zon blackr z Dec 16, 2016z Rogue One: A Star Wars Storyz$1,332,439,889N)r r= c C s" t t t| t d S r )r{ printrulerj )r rA rA rB r) s r) z
Example TablerW r z expand=True2 zwidth=50FdimrV zrow_styles=['dim', 'none']z%leading=1, row_styles=['dim', 'none']z+show_lines=True, row_styles=['dim', 'none'])J dataclassesr r r typingr r r r r r
r r r
r( r r _loopr r _pickr _ratior r alignr jupyterr measurer r[ r r protocolr segmentr r- r r r r r r{ r! r" r# r$ r% r& r' rO rQ rS rF pip._vendor.rich.consoleZ pip._vendor.rich.highlighterr. pip._vendor.rich.tableZ_timerr/ tablerr r rq r) rj r4 r^ r4 rd rc rb rA rA rA rB s ,
Z