Tables

Rich’s Table class offers a variety of ways to render tabular data to the terminal.

To render a table, construct a Table object, add columns with add_column(), and rows with add_row() – then print it to the console.

Here’s an example:

from rich.console import Console
from rich.table import Table

table = Table(title="Star Wars Movies")

table.add_column("Released", justify="right", style="cyan", no_wrap=True)
table.add_column("Title", style="magenta")
table.add_column("Box Office", justify="right", style="green")

table.add_row("Dec 20, 2019", "Star Wars: The Rise of Skywalker", "$952,110,690")
table.add_row("May 25, 2018", "Solo: A Star Wars Story", "$393,151,347")
table.add_row("Dec 15, 2017", "Star Wars Ep. V111: The Last Jedi", "$1,332,539,889")
table.add_row("Dec 16, 2016", "Rogue One: A Star Wars Story", "$1,332,439,889")

console = Console()
console.print(table)

This produces the following output:

                           Star Wars Movies                           
┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓
┃     Released  Title                                  Box Office ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩
│ Dec 20, 2019  Star Wars: The Rise of Skywalker     $952,110,690 │
│ May 25, 2018  Solo: A Star Wars Story              $393,151,347 │
│ Dec 15, 2017  Star Wars Ep. V111: The Last Jedi  $1,332,539,889 │
│ Dec 16, 2016  Rogue One: A Star Wars Story       $1,332,439,889 │
└──────────────┴───────────────────────────────────┴────────────────┘

Rich is quite smart about rendering the table. It will adjust the column widths to fit the contents and will wrap text if it doesn’t fit. You can also add anything that Rich knows how to render as a title or row cell (even another table)!

You can set the border style by importing one of the preset Box objects and setting the box argument in the table constructor. Here’s an example that modifies the look of the Star Wars table:

from rich import box
table = Table(title="Star Wars Movies", box=box.MINIMAL_DOUBLE_HEAD)

See Box for other box styles.

The Table class offers a number of configuration options to set the look and feel of the table, including how borders are rendered and the style and alignment of the columns.

Adding columns

You may also add columns by specifying them in the positional arguments of the Table constructor. For example, we could construct a table with three columns like this:

table = Table("Released", "Title", "Box Office", title="Star Wars Movies")

This allows you to specify the text of the column only. If you want to set other attributes, such as width and style, you can add an Column class. Here’s an example:

from rich.table import Column
table = Table(
    "Released",
    "Title",
    Column(header="Box Office", align="right"),
    title="Star Wars Movies"
)

Grids

The Table class can also make a great layout tool. If you disable headers and borders you can use it to position content within the terminal. The alternative constructor grid() can create such a table for you.

For instance, the following code displays two pieces of text aligned to both the left and right edges of the terminal on a single line:

from rich import print
from rich.table import Table

grid = Table.grid(expand=True)
grid.add_column()
grid.add_column(justify="right")
grid.add_row("Raising shields", "[bold magenta]COMPLETED [green]:heavy_check_mark:")

print(grid)