Testing Table Component Rendering and Styling in Textualize/rich
This test suite validates the Rich library’s Table component functionality, focusing on table rendering, formatting, and styling capabilities. It verifies core features like column management, row handling, and visual presentation across different configurations.
Test Coverage Overview
Implementation Analysis
Technical Details
Best Practices Demonstrated
textualize/rich
tests/test_table.py
# encoding=utf-8
import io
from textwrap import dedent
import pytest
from rich import box, errors
from rich.console import Console
from rich.measure import Measurement
from rich.style import Style
from rich.table import Column, Table
from rich.text import Text
def render_tables():
console = Console(
width=60,
force_terminal=True,
file=io.StringIO(),
legacy_windows=False,
color_system=None,
_environ={},
)
table = Table(title="test table", caption="table caption", expand=False)
table.add_column("foo", footer=Text("total"), no_wrap=True, overflow="ellipsis")
table.add_column("bar", justify="center")
table.add_column("baz", justify="right")
table.add_row("Averlongwordgoeshere", "banana pancakes", None)
assert Measurement.get(console, console.options, table) == Measurement(41, 48)
table.expand = True
assert Measurement.get(console, console.options, table) == Measurement(41, 48)
for width in range(10, 60, 5):
console.print(table, width=width)
table.expand = False
console.print(table, justify="left")
console.print(table, justify="center")
console.print(table, justify="right")
assert table.row_count == 1
table.row_styles = ["red", "yellow"]
table.add_row("Coffee")
table.add_row("Coffee", "Chocolate", None, "cinnamon")
assert table.row_count == 3
console.print(table)
table.show_lines = True
console.print(table)
table.show_footer = True
console.print(table)
table.show_edge = False
console.print(table)
table.padding = 1
console.print(table)
table.width = 20
assert Measurement.get(console, console.options, table) == Measurement(20, 20)
table.expand = False
assert Measurement.get(console, console.options, table) == Measurement(20, 20)
table.expand = True
console.print(table)
table.columns[0].no_wrap = True
table.columns[1].no_wrap = True
table.columns[2].no_wrap = True
console.print(table)
table.padding = 0
table.width = 60
table.leading = 1
console.print(table)
return console.file.getvalue()
def test_render_table():
expected = "test table
┏━━━━━━┳┳┓
┃ foo ┃┃┃
┡━━━━━━╇╇┩
│ Ave… │││
└──────┴┴┘
table
caption
test table
┏━━━━━━━━━━━┳┳┓
┃ foo ┃┃┃
┡━━━━━━━━━━━╇╇┩
│ Averlong… │││
└───────────┴┴┘
table caption
test table
┏━━━━━━━━━━━━━━━━┳┳┓
┃ foo ┃┃┃
┡━━━━━━━━━━━━━━━━╇╇┩
│ Averlongwordg… │││
└────────────────┴┴┘
table caption
test table
┏━━━━━━━━━━━━━━━━━━━━━┳┳┓
┃ foo ┃┃┃
┡━━━━━━━━━━━━━━━━━━━━━╇╇┩
│ Averlongwordgoeshe… │││
└─────────────────────┴┴┘
table caption
test table
┏━━━━━━━━━━━━━━━━━━━━━━┳━━┳━━┓
┃ foo ┃ ┃ ┃
┡━━━━━━━━━━━━━━━━━━━━━━╇━━╇━━┩
│ Averlongwordgoeshere │ │ │
└──────────────────────┴──┴──┘
table caption
test table
┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━┳━━━━┓
┃ foo ┃ bar ┃ b… ┃
┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━╇━━━━┩
│ Averlongwordgoeshere │ ba… │ │
│ │ pa… │ │
└──────────────────────┴─────┴────┘
table caption
test table
┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━┓
┃ foo ┃ bar ┃ baz ┃
┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━┩
│ Averlongwordgoeshere │ banana │ │
│ │ pancak… │ │
└──────────────────────┴─────────┴─────┘
table caption
test table
┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━┓
┃ foo ┃ bar ┃ baz ┃
┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━┩
│ Averlongwordgoeshere │ banana │ │
│ │ pancakes │ │
└──────────────────────┴──────────────┴─────┘
table caption
test table
┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━┓
┃ foo ┃ bar ┃ baz ┃
┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━┩
│ Averlongwordgoeshere │ banana pancakes │ │
└───────────────────────┴──────────────────┴─────┘
table caption
test table
┏━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━┓
┃ foo ┃ bar ┃ baz ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━┩
│ Averlongwordgoeshere │ banana pancakes │ │
└──────────────────────────┴────────────────────┴─────┘
table caption
test table
┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━┓
┃ foo ┃ bar ┃ baz ┃
┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━┩
│ Averlongwordgoeshere │ banana pancakes │ │
└──────────────────────┴─────────────────┴─────┘
table caption
test table
┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━┓
┃ foo ┃ bar ┃ baz ┃
┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━┩
│ Averlongwordgoeshere │ banana pancakes │ │
└──────────────────────┴─────────────────┴─────┘
table caption
test table
┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━┓
┃ foo ┃ bar ┃ baz ┃
┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━┩
│ Averlongwordgoeshere │ banana pancakes │ │
└──────────────────────┴─────────────────┴─────┘
table caption
test table
┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━┳━━━━━━━━━━┓
┃ foo ┃ bar ┃ baz ┃ ┃
┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━╇━━━━━━━━━━┩
│ Averlongwordgoeshere │ banana pancakes │ │ │
│ Coffee │ │ │ │
│ Coffee │ Chocolate │ │ cinnamon │
└──────────────────────┴─────────────────┴─────┴──────────┘
table caption
test table
┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━┳━━━━━━━━━━┓
┃ foo ┃ bar ┃ baz ┃ ┃
┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━╇━━━━━━━━━━┩
│ Averlongwordgoeshere │ banana pancakes │ │ │
├──────────────────────┼─────────────────┼─────┼──────────┤
│ Coffee │ │ │ │
├──────────────────────┼─────────────────┼─────┼──────────┤
│ Coffee │ Chocolate │ │ cinnamon │
└──────────────────────┴─────────────────┴─────┴──────────┘
table caption
test table
┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━┳━━━━━━━━━━┓
┃ foo ┃ bar ┃ baz ┃ ┃
┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━╇━━━━━━━━━━┩
│ Averlongwordgoeshere │ banana pancakes │ │ │
├──────────────────────┼─────────────────┼─────┼──────────┤
│ Coffee │ │ │ │
├──────────────────────┼─────────────────┼─────┼──────────┤
│ Coffee │ Chocolate │ │ cinnamon │
├──────────────────────┼─────────────────┼─────┼──────────┤
│ total │ │ │ │
└──────────────────────┴─────────────────┴─────┴──────────┘
table caption
test table
foo ┃ bar ┃ baz ┃
━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━╇━━━━━━━━━━
Averlongwordgoeshere │ banana pancakes │ │
──────────────────────┼─────────────────┼─────┼──────────
Coffee │ │ │
──────────────────────┼─────────────────┼─────┼──────────
Coffee │ Chocolate │ │ cinnamon
──────────────────────┼─────────────────┼─────┼──────────
total │ │ │
table caption
test table
┃ ┃ ┃
foo ┃ bar ┃ baz ┃
┃ ┃ ┃
━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━╇━━━━━━━━━━
│ │ │
Averlongwordgoeshere │ banana pancakes │ │
│ │ │
──────────────────────┼─────────────────┼─────┼──────────
│ │ │
Coffee │ │ │
│ │ │
──────────────────────┼─────────────────┼─────┼──────────
│ │ │
Coffee │ Chocolate │ │ cinnamon
│ │ │
──────────────────────┼─────────────────┼─────┼──────────
│ │ │
total │ │ │
│ │ │
table caption
test table
┃┃┃
foo ┃┃┃
┃┃┃
━━━━━━━━━━━━━━━━━╇╇╇
│││
Averlongwordgo… │││
│││
─────────────────┼┼┼
│││
Coffee │││
│││
─────────────────┼┼┼
│││
Coffee │││
│││
─────────────────┼┼┼
│││
total │││
│││
table caption
test table
┃ ┃┃
foo ┃ bar ┃┃
┃ ┃┃
━━━━━━━━━━╇━━━━━━━━━╇╇
│ ││
Averlon… │ banana… ││
│ ││
──────────┼─────────┼┼
│ ││
Coffee │ ││
│ ││
──────────┼─────────┼┼
│ ││
Coffee │ Chocol… ││
│ ││
──────────┼─────────┼┼
│ ││
total │ ││
│ ││
table caption
test table
foo ┃ bar ┃ baz┃
━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━╇━━━━━━━━━
Averlongwordgoeshere │ banana pancakes │ │
│ │ │
Coffee │ │ │
│ │ │
Coffee │ Chocolate │ │cinnamon
─────────────────────────┼───────────────────┼────┼─────────
total │ │ │
table caption
"
result = render_tables()
print(repr(result))
assert result == expected
def test_not_renderable():
class Foo:
pass
table = Table()
with pytest.raises(errors.NotRenderableError):
table.add_row(Foo())
def test_init_append_column():
header_names = ["header1", "header2", "header3"]
test_columns = [
Column(_index=index, header=header) for index, header in enumerate(header_names)
]
# Test appending of strings for header names
assert Table(*header_names).columns == test_columns
# Test directly passing a Table Column objects
assert Table(*test_columns).columns == test_columns
def test_rich_measure():
console = Console()
assert Table("test_header", width=-1).__rich_measure__(
console, console.options
) == Measurement(0, 0)
# Check __rich_measure__() for a positive width passed as an argument
assert Table("test_header", width=None).__rich_measure__(
console, console.options.update_width(10)
) == Measurement(10, 10)
def test_min_width():
table = Table("foo", min_width=30)
table.add_row("bar")
console = Console()
assert table.__rich_measure__(
console, console.options.update_width(100)
) == Measurement(30, 30)
console = Console(color_system=None)
console.begin_capture()
console.print(table)
output = console.end_capture()
print(output)
assert all(len(line) == 30 for line in output.splitlines())
def test_no_columns():
console = Console(color_system=None)
console.begin_capture()
console.print(Table())
output = console.end_capture()
print(repr(output))
assert output == "
"
def test_get_row_style():
console = Console()
table = Table()
table.add_row("foo")
table.add_row("bar", style="on red")
assert table.get_row_style(console, 0) == Style.parse("")
assert table.get_row_style(console, 1) == Style.parse("on red")
def test_vertical_align_top():
console = Console(_environ={})
def make_table(vertical_align):
table = Table(show_header=False, box=box.SQUARE)
table.add_column(vertical=vertical_align)
table.add_row("foo", "
".join(["bar"] * 5))
return table
with console.capture() as capture:
console.print(make_table("top"))
console.print()
console.print(make_table("middle"))
console.print()
console.print(make_table("bottom"))
console.print()
result = capture.get()
print(repr(result))
expected = "┌─────┬─────┐
│ foo │ bar │
│ │ bar │
│ │ bar │
│ │ bar │
│ │ bar │
└─────┴─────┘
┌─────┬─────┐
│ │ bar │
│ │ bar │
│ foo │ bar │
│ │ bar │
│ │ bar │
└─────┴─────┘
┌─────┬─────┐
│ │ bar │
│ │ bar │
│ │ bar │
│ │ bar │
│ foo │ bar │
└─────┴─────┘
"
assert result == expected
@pytest.mark.parametrize(
"box,result",
[
(None, " 1 2
3 4
"),
(box.HEAVY_HEAD, "┌───┬───┐
│ 1 │ 2 │
│ 3 │ 4 │
└───┴───┘
"),
(box.SQUARE_DOUBLE_HEAD, "┌───┬───┐
│ 1 │ 2 │
│ 3 │ 4 │
└───┴───┘
"),
(box.MINIMAL_DOUBLE_HEAD, " ╷
1 │ 2
3 │ 4
╵
"),
(box.MINIMAL_HEAVY_HEAD, " ╷
1 │ 2
3 │ 4
╵
"),
(box.ASCII_DOUBLE_HEAD, "+---+---+
| 1 | 2 |
| 3 | 4 |
+---+---+
"),
],
)
def test_table_show_header_false_substitution(box, result):
"""When the box style is one with a custom header edge, it should be substituted for
the equivalent box that does not have a custom header when show_header=False"""
table = Table(show_header=False, box=box)
table.add_column()
table.add_column()
table.add_row("1", "2")
table.add_row("3", "4")
console = Console(record=True)
console.print(table)
output = console.export_text()
assert output == result
def test_section():
table = Table("foo")
table.add_section() # Null-op
table.add_row("row1")
table.add_row("row2", end_section=True)
table.add_row("row3")
table.add_row("row4")
table.add_section()
table.add_row("row5")
table.add_section() # Null-op
console = Console(
width=80,
force_terminal=True,
color_system="truecolor",
legacy_windows=False,
record=True,
)
console.print(table)
output = console.export_text()
print(repr(output))
expected = "┏━━━━━━┓
┃ foo ┃
┡━━━━━━┩
│ row1 │
│ row2 │
├──────┤
│ row3 │
│ row4 │
├──────┤
│ row5 │
└──────┘
"
assert output == expected
@pytest.mark.parametrize(
"show_header,show_footer,expected",
[
(
False,
False,
dedent(
"""
abbbbbcbbbbbbbbbcbbbbcbbbbbd
1Dec 2Skywalker2275M2375M 3
4May 5Solo 5275M5393M 6
ijjjjjkjjjjjjjjjkjjjjkjjjjjl
7Dec 8Last Jedi8262M81333M9
qrrrrrsrrrrrrrrrsrrrrsrrrrrt
"""
).lstrip(),
),
(
True,
False,
dedent(
"""
abbbbbcbbbbbbbbbcbbbbcbbbbbd
1Month2Nickname 2Cost2Gross3
efffffgfffffffffgffffgfffffh
4Dec 5Skywalker5275M5375M 6
4May 5Solo 5275M5393M 6
ijjjjjkjjjjjjjjjkjjjjkjjjjjl
7Dec 8Last Jedi8262M81333M9
qrrrrrsrrrrrrrrrsrrrrsrrrrrt
"""
).lstrip(),
),
(
False,
True,
dedent(
"""
abbbbbcbbbbbbbbbcbbbbcbbbbbd
1Dec 2Skywalker2275M2375M 3
4May 5Solo 5275M5393M 6
ijjjjjkjjjjjjjjjkjjjjkjjjjjl
4Dec 5Last Jedi5262M51333M6
mnnnnnonnnnnnnnnonnnnonnnnnp
7MONTH8NICKNAME 8COST8GROSS9
qrrrrrsrrrrrrrrrsrrrrsrrrrrt
"""
).lstrip(),
),
(
True,
True,
dedent(
"""
abbbbbcbbbbbbbbbcbbbbcbbbbbd
1Month2Nickname 2Cost2Gross3
efffffgfffffffffgffffgfffffh
4Dec 5Skywalker5275M5375M 6
4May 5Solo 5275M5393M 6
ijjjjjkjjjjjjjjjkjjjjkjjjjjl
4Dec 5Last Jedi5262M51333M6
mnnnnnonnnnnnnnnonnnnonnnnnp
7MONTH8NICKNAME 8COST8GROSS9
qrrrrrsrrrrrrrrrsrrrrsrrrrrt
"""
).lstrip(),
),
],
)
def test_placement_table_box_elements(show_header, show_footer, expected):
"""Ensure box drawing characters correctly positioned."""
table = Table(
box=box.ASCII, show_header=show_header, show_footer=show_footer, padding=0
)
# content rows indicated by numerals, pure dividers by letters
table.box.__dict__.update(
top_left="a",
top="b",
top_divider="c",
top_right="d",
head_left="1",
head_vertical="2",
head_right="3",
head_row_left="e",
head_row_horizontal="f",
head_row_cross="g",
head_row_right="h",
mid_left="4",
mid_vertical="5",
mid_right="6",
row_left="i",
row_horizontal="j",
row_cross="k",
row_right="l",
foot_left="7",
foot_vertical="8",
foot_right="9",
foot_row_left="m",
foot_row_horizontal="n",
foot_row_cross="o",
foot_row_right="p",
bottom_left="q",
bottom="r",
bottom_divider="s",
bottom_right="t",
)
# add content - note headers title case, footers upper case
table.add_column("Month", "MONTH", width=5)
table.add_column("Nickname", "NICKNAME", width=9)
table.add_column("Cost", "COST", width=4)
table.add_column("Gross", "GROSS", width=5)
table.add_row("Dec", "Skywalker", "275M", "375M")
table.add_row("May", "Solo", "275M", "393M")
table.add_section()
table.add_row("Dec", "Last Jedi", "262M", "1333M")
console = Console(record=True, width=28)
console.print(table)
output = console.export_text()
print(repr(output))
assert output == expected
def test_columns_highlight_added_by_add_row() -> None:
"""Regression test for https://github.com/Textualize/rich/issues/3517"""
table = Table(show_header=False, highlight=True)
table.add_row("1", repr("FOO"))
assert table.columns[0].highlight == table.highlight
assert table.columns[1].highlight == table.highlight
console = Console(record=True)
console.print(table)
output = console.export_text(styles=True)
print(repr(output))
expected = (
"┌───┬───────┐
│ \x1b[1;36m1\x1b[0m │ \x1b[32m'FOO'\x1b[0m │
└───┴───────┘
"
)
assert output == expected
if __name__ == "__main__":
render = render_tables()
print(render)
print(repr(render))