a IDg6@sdZddlZddlZddlmZddlmZmZmZm Z m Z m Z dZ e dZddZdd d Zd dZdddZdddZddZdS)a Functions that render ASCII tables. Some generic notes about the table formatting functions in this module: - These functions were not written with performance in mind (*at all*) because they're intended to format tabular data to be presented on a terminal. If someone were to run into a performance problem using these functions, they'd be printing so much tabular data to the terminal that a human wouldn't be able to digest the tabular data anyway, so the point is moot :-). - These functions ignore ANSI escape sequences (at least the ones generated by the :mod:`~humanfriendly.terminal` module) in the calculation of columns widths. On reason for this is that column names are highlighted in color when connected to a terminal. It also means that you can use ANSI escape sequences to highlight certain column's values if you feel like it (for example to highlight deviations from the norm in an overview of calculated values). N) coerce_string) ansi_strip ansi_width ansi_wrapterminal_supports_colorsfind_terminal_sizeHIGHLIGHT_COLOR)format_pretty_tableformat_robust_tableformat_rst_tableformat_smart_tablez ^\d+(\.\d+)?$cCsddd|D}t|}tdd|DsZt||}ttt|}t\}}||krZ|St||S)a7 Render tabular data using the most appropriate representation. :param data: An iterable (e.g. a :func:`tuple` or :class:`list`) containing the rows of the table, where each row is an iterable containing the columns of the table (strings). :param column_names: An iterable of column names (strings). :returns: The rendered table (a string). If you want an easy way to render tabular data on a terminal in a human friendly format then this function is for you! It works as follows: - If the input data doesn't contain any line breaks the function :func:`format_pretty_table()` is used to render a pretty table. If the resulting table fits in the terminal without wrapping the rendered pretty table is returned. - If the input data does contain line breaks or if a pretty table would wrap (given the width of the terminal) then the function :func:`format_robust_table()` is used to render a more robust table that can deal with data containing line breaks and long text. cSsg|] }t|qSnormalize_columns.0rr r e/mounts/lovelace/software/anaconda3/envs/paleomix/lib/python3.9/site-packages/humanfriendly/tables.py Wz&format_smart_table..css |]}tdd|DVqdS)css|]}d|vVqdS Nr )rcr r r [rz/format_smart_table...N)anyrr r rr[rz%format_smart_table..) rrr maxmapr splitlinesrr )data column_namesZ pretty_table table_widthnum_rows num_columnsr r rr >s  r -|c Csdd|D}|durBt|}|rBtr6dd|D}|d|tt}tt}t|D]X\}}t|D]F\}} t||t | ||<|r|dksn|| t t t| qnq^|t|t|dd} | g} t|D]\}}|g} t|D]b\}} d||t | } t||r>| d| | dn| d| | d| |q| d | |r|dkr| | q| | d | S) af Render a table using characters like dashes and vertical bars to emulate borders. :param data: An iterable (e.g. a :func:`tuple` or :class:`list`) containing the rows of the table, where each row is an iterable containing the columns of the table (strings). :param column_names: An iterable of column names (strings). :param horizontal_bar: The character used to represent a horizontal bar (a string). :param vertical_bar: The character used to represent a vertical bar (a string). :returns: The rendered table (a string). Here's an example: >>> from humanfriendly.tables import format_pretty_table >>> column_names = ['Version', 'Uploaded on', 'Downloads'] >>> humanfriendly_releases = [ ... ['1.23', '2015-05-25', '218'], ... ['1.23.1', '2015-05-26', '1354'], ... ['1.24', '2015-05-26', '223'], ... ['1.25', '2015-05-26', '4319'], ... ['1.25.1', '2015-06-02', '197'], ... ] >>> print(format_pretty_table(humanfriendly_releases, column_names)) ------------------------------------- | Version | Uploaded on | Downloads | ------------------------------------- | 1.23 | 2015-05-25 | 218 | | 1.23.1 | 2015-05-26 | 1354 | | 1.24 | 2015-05-26 | 223 | | 1.25 | 2015-05-26 | 4319 | | 1.25.1 | 2015-06-02 | 197 | ------------------------------------- Notes about the resulting table: - If a column contains numeric data (integer and/or floating point numbers) in all rows (ignoring column names of course) then the content of that column is right-aligned, as can be seen in the example above. The idea here is to make it easier to compare the numbers in different columns to each other. - The column names are highlighted in color so they stand out a bit more (see also :data:`.HIGHLIGHT_COLOR`). The following screen shot shows what that looks like (my terminals are always set to white text on a black background): .. image:: images/pretty-table.png cSsg|]}t|ddqS)T) expandtabsrrr r rrrz'format_pretty_table..NcSsg|] }t|qSr highlight_column_namernr r rrrr r)rrinsert collections defaultdictintlist enumeraterrappendboolNUMERIC_DATA_PATTERNmatchrsumvalueslenalljoin)rrZhorizontal_barZ vertical_barwidthsZ numeric_dataZ row_indexrow column_indexcolumnZline_delimiterlineslinepaddingr r rr hs:4          r c Csg}ddt|D}tr*dd|D}|D]p}g}tt|D]P\}}|}d|vrr|d|||fqB|||||qB||q.t\}} t dd|D} dd t | | } | d d |d | d d|DS) a Render tabular data with one column per line (allowing columns with line breaks). :param data: An iterable (e.g. a :func:`tuple` or :class:`list`) containing the rows of the table, where each row is an iterable containing the columns of the table (strings). :param column_names: An iterable of column names (strings). :returns: The rendered table (a string). Here's an example: >>> from humanfriendly.tables import format_robust_table >>> column_names = ['Version', 'Uploaded on', 'Downloads'] >>> humanfriendly_releases = [ ... ['1.23', '2015-05-25', '218'], ... ['1.23.1', '2015-05-26', '1354'], ... ['1.24', '2015-05-26', '223'], ... ['1.25', '2015-05-26', '4319'], ... ['1.25.1', '2015-06-02', '197'], ... ] >>> print(format_robust_table(humanfriendly_releases, column_names)) ----------------------- Version: 1.23 Uploaded on: 2015-05-25 Downloads: 218 ----------------------- Version: 1.23.1 Uploaded on: 2015-05-26 Downloads: 1354 ----------------------- Version: 1.24 Uploaded on: 2015-05-26 Downloads: 223 ----------------------- Version: 1.25 Uploaded on: 2015-05-26 Downloads: 4319 ----------------------- Version: 1.25.1 Uploaded on: 2015-06-02 Downloads: 197 ----------------------- The column names are highlighted in bold font and color so they stand out a bit more (see :data:`.HIGHLIGHT_COLOR`). cSsg|] }d|qS)z%s:r r(r r rrrz'format_robust_table..cSsg|] }t|qSr r&r(r r rrrrz%s %scss|]}ttt|VqdSN)rrr)rrAr r rrrz&format_robust_table..z %s r#rr-css|]}d|VqdSrr<)rbr r rrr) rrr3stripr4extendrstriprrrminr.r<) rrblocksr>rAr?Z column_textZstripped_columnr!r"Z longest_line delimiterr r rr s&/    r cCsdd|D}|r"|dt|tt}|D],}t|D]\}}t||t|||<q>> from humanfriendly.tables import format_rst_table >>> column_names = ['Version', 'Uploaded on', 'Downloads'] >>> humanfriendly_releases = [ ... ['1.23', '2015-05-25', '218'], ... ['1.23.1', '2015-05-26', '1354'], ... ['1.24', '2015-05-26', '223'], ... ['1.25', '2015-05-26', '4319'], ... ['1.25.1', '2015-06-02', '197'], ... ] >>> print(format_rst_table(humanfriendly_releases, column_names)) ======= =========== ========= Version Uploaded on Downloads ======= =========== ========= 1.23 2015-05-25 218 1.23.1 2015-05-26 1354 1.24 2015-05-26 223 1.25 2015-05-26 4319 1.25.1 2015-06-02 197 ======= =========== ========= .. _reStructuredText: https://en.wikipedia.org/wiki/ReStructuredText cSsg|] }t|qSr rrr r rr3rz$format_rst_table..rr+cSsg|]\}}d|qS)=r )riwr r rrArrcss|]}d|VqdS)z NrErr r rrGrz#format_rst_table..) r.rr/r0r1r3rr:ljustsorteditemsr4r<)rrr=r>indexr@rLr r rr s""    r FcCs0g}|D]"}t|}|r |}||q|SrD)rr%r4)r>r%resultsvaluetextr r rrJs rcCst|dtdS)NT)boldcolor)rr)namer r rr'Tsr')Nr#r$)N)F)__doc__r/reZhumanfriendly.compatrZhumanfriendly.terminalrrrrrr__all__compiler6r r r r rr'r r r rs   * ZO 9