mirror of
https://github.com/Stone-Red-Code/dvc.git
synced 2026-11-07 15:28:28 +01:00
Saugat Pachhai
dba0aaeab7
I found that it's harder to style a header with the list using index, they are to be applied by header name. Otherwise, we might end up using a different header for coloring, or worse throw some error because the header name and style don't match. Row does have it's property of index, so it makes sense there.
125 lines
3.1 KiB
Python
125 lines
3.1 KiB
Python
from collections import abc
|
|
from contextlib import contextmanager
|
|
from itertools import zip_longest
|
|
from typing import TYPE_CHECKING, Dict, Iterator, Sequence, Union
|
|
|
|
from dvc.types import DictStrAny
|
|
|
|
if TYPE_CHECKING:
|
|
from rich.console import Console as RichConsole
|
|
from rich.table import Table
|
|
from rich.text import Text
|
|
|
|
from dvc.ui import Console
|
|
|
|
|
|
SHOW_MAX_WIDTH = 1024
|
|
|
|
|
|
CellT = Union[str, "Text"] # Text is mostly compatible with str
|
|
Row = Sequence[CellT]
|
|
TableData = Sequence[Row]
|
|
Headers = Sequence[str]
|
|
Styles = DictStrAny
|
|
|
|
|
|
def plain_table(
|
|
ui: "Console",
|
|
data: TableData,
|
|
headers: Headers = None,
|
|
markdown: bool = False,
|
|
pager: bool = False,
|
|
force: bool = True,
|
|
) -> None:
|
|
from tabulate import tabulate
|
|
|
|
text: str = tabulate(
|
|
data,
|
|
headers if headers is not None else (),
|
|
tablefmt="github" if markdown else "plain",
|
|
disable_numparse=True,
|
|
# None will be shown as "" by default, overriding
|
|
missingval="-",
|
|
)
|
|
if markdown:
|
|
# NOTE: md table is incomplete without the trailing newline
|
|
text += "\n"
|
|
|
|
if pager:
|
|
from dvc.utils.pager import pager as _pager
|
|
|
|
_pager(text)
|
|
else:
|
|
ui.write(text, force=force)
|
|
|
|
|
|
@contextmanager
|
|
def console_width(
|
|
table: "Table", console: "RichConsole", val: int
|
|
) -> Iterator[None]:
|
|
# NOTE: rich does not have native support for unlimited width
|
|
# via pager. we override rich table compression by setting
|
|
# console width to the full width of the table
|
|
# pylint: disable=protected-access
|
|
|
|
console_options = console.options
|
|
original = console_options.max_width
|
|
con_width = console._width
|
|
|
|
try:
|
|
console_options.max_width = val
|
|
measurement = table.__rich_measure__(console, console_options)
|
|
console._width = measurement.maximum
|
|
|
|
yield
|
|
finally:
|
|
console_options.max_width = original
|
|
console._width = con_width
|
|
|
|
|
|
def rich_table(
|
|
ui: "Console",
|
|
data: TableData,
|
|
headers: Headers = None,
|
|
pager: bool = False,
|
|
header_styles: Union[Dict[str, Styles], Sequence[Styles]] = None,
|
|
row_styles: Sequence[Styles] = None,
|
|
borders: Union[bool, str] = False,
|
|
) -> None:
|
|
from rich import box
|
|
|
|
from dvc.utils.table import Table
|
|
|
|
border_style = {
|
|
True: box.HEAVY_HEAD, # is a default in rich,
|
|
False: None,
|
|
"simple": box.SIMPLE,
|
|
"minimal": box.MINIMAL,
|
|
}
|
|
|
|
table = Table(box=border_style[borders])
|
|
|
|
if isinstance(header_styles, abc.Sequence):
|
|
hs: Dict[str, Styles] = dict(zip(headers or [], header_styles))
|
|
else:
|
|
hs = header_styles or {}
|
|
|
|
for header in headers or []:
|
|
table.add_column(header, **hs.get(header, {}))
|
|
|
|
rs: Sequence[Styles] = row_styles or []
|
|
for row, style in zip_longest(data, rs):
|
|
table.add_row(*row, **(style or {}))
|
|
|
|
console = ui.rich_console
|
|
|
|
if not pager:
|
|
console.print(table)
|
|
return
|
|
|
|
from dvc.utils.pager import DvcPager
|
|
|
|
with console_width(table, console, SHOW_MAX_WIDTH):
|
|
with console.pager(pager=DvcPager(), styles=True):
|
|
console.print(table)
|