display#

This module contains functions to convert a DataFrame into a Rich Table.

The to_rich_table function takes a DataFrame and converts it into a Rich Table. It allows specifying styles, justification, and text wrapping for each column. It also supports truncating the DataFrame with a maximum number of lines and

The print_rich_table is this module’s main function. It takes a DataFrame and prints it as a Rich Table in the console.

wip.datatools.display.add_columns(table: Table, df: DataFrame, justify: dict, style: dict, no_wrap: bool = True, max_columns: int = 15)[source]#

Add columns from a DataFrame to a Rich Table with specified formatting.

This function takes a Rich Table and a DataFrame and adds the column names of the DataFrame to the table. Formatting options like justification, style, and wrapping can be specified for each column. Optionally, you can include the DataFrame index as a column.

Parameters

table (Table) – The Rich Table to add the columns to.
df (DataFrame) – A pandas.DataFrame containing the data to add to the table.
justify (dict) – A dictionary mapping column names to their justification (‘left’, ‘right’, etc.).
style (dict) – A dictionary mapping column names to their style (color, font weight, etc.).
no_wrap (bool, default True) – Whether text wrapping should be disabled.
max_columns (int, default 15) – Maximum number of columns to display.

wip.datatools.display.create_row_data(df: DataFrame, max_lines: int, max_columns: int) → list[source]#

Create row data for the table.

The row data is created by converting the pandas.DataFrame rows values into a string data type and then converting these values into a list of lists.

If the number of rows in the DataFrame is greater than the max_lines parameter, then the rows are truncated and an ellipsis is added in the middle.

Parameters

df (DataFrame) – The DataFrame from which to create the rows.
max_lines (int) – Maximum number of lines to display.
max_columns (int) – Maximum number of columns to display.

Returns

A list of rows to be added to the table.

Return type

list

wip.datatools.display.print_rich_table(df: DataFrame, index: bool = False, **kwargs)[source]#

Print a DataFrame as a formatted Rich Table in the console.

This function takes a DataFrame and prints it as a Rich Table in the console. It supports various formatting options including styles, justification, and text wrapping for columns, and allows truncation of the DataFrame with a maximum number of lines. The DataFrame index can also be included as a column in the table.

Parameters

df (DataFrame) – The pandas.DataFrame to print.
index (bool, default False) – Whether to include the DataFrame index as a separate column.
style (str | dict | None) – Styling information for the table’s columns. It can be a single style applied to all columns, a dictionary mapping column names to styles, or None for default style.
no_wrap (bool, default True) – Whether to disable text wrapping in the table.
justify (JustifyMethod | dict, default 'right') – Justification for the table’s columns. Can be a single justification for all columns or a dictionary mapping column names to justifications.
max_lines (int | None, default 10) – The maximum number of lines to display from the DataFrame. If None, all lines are displayed.
max_columns (int | None, default 15) – The maximum number of columns to display from the DataFrame. If None, up to 15 columns are displayed.

Examples

>>> df = pd.DataFrame(
...     {
...         'ID': [1, 2, 3],
...         'Name': ['Julius', 'Albert', 'Newton'],
...         'Date of Birth': ['1904-04-22', '1879-03-14', '1643-01-04']
...     }
... )
>>> print_rich_table(df)
┏━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃ ID ┃   Name ┃ Date of Birth ┃
┡━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━┩
│  1 │ Julius │    1904-04-22 │
│  2 │ Albert │    1879-03-14 │
│  3 │ Newton │    1643-01-04 │
└────┴────────┴───────────────┘

>>> print_rich_table(df, index=True)
┏━━━━━━━┳━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃ index ┃ ID ┃   Name ┃ Date of Birth ┃
┡━━━━━━━╇━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ 0     │  1 │ Julius │    1904-04-22 │
│ 1     │  2 │ Albert │    1879-03-14 │
│ 2     │  3 │ Newton │    1643-01-04 │
└───────┴────┴────────┴───────────────┘

>>> print_rich_table(df, index=True, max_lines=2)
┏━━━━━━━┳━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃ index ┃  ID ┃   Name ┃ Date of Birth ┃
┡━━━━━━━╇━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ 0     │   1 │ Julius │    1904-04-22 │
│ ...   │ ... │    ... │           ... │
│ 2     │   3 │ Newton │    1643-01-04 │
└───────┴─────┴────────┴───────────────┘

>>> print_rich_table(df, max_columns=3)
┏━━━━┳━━━━━┳━━━━━━━━┓
┃ ID ┃ ... ┃  Name9 ┃
┡━━━━╇━━━━━╇━━━━━━━━┩
│  1 │ ... │ Julius │
│  2 │ ... │ Albert │
│  3 │ ... │ Newton │
└────┴─────┴────────┘