rich.table

class rich.table.Column(header='', footer='', header_style='', footer_style='', style='', justify='left', vertical='top', overflow='ellipsis', width=None, min_width=None, max_width=None, ratio=None, no_wrap=False, _index=0, _cells=<factory>)[ソース]

〜Table 内の列を定義します。

パラメータ

  • title (Union[str, Text], optional) – 上部にレンダリングされるテーブルのタイトル。デフォルトは None です。

  • caption (Union[str, Text], optional) – 下部にレンダリングされるテーブルのキャプション。デフォルトは None です。

  • width (int, optional) – テーブルの文字幅。または自動調整する場合は None。デフォルトは None です。

  • min_width (Optional[int], optional) – テーブルの最小幅。最小値なしの場合は None。デフォルトは None です。

  • box (box.Box, optional) – エッジの描画に使用される box.py の定数の一つ（Box を参照）。またはボックス線なしの場合は None。デフォルトは box.HEAVY_HEAD です。

  • safe_box (Optional[bool], optional) – ラスタ フォントを使用する Windows レガシーターミナルで表示されないボックス文字を無効にします。デフォルトは True です。

  • padding (PaddingDimensions, optional) – セルのパディング（上、右、下、左）。デフォルトは (0, 1) です。

  • collapse_padding (bool, optional) – セル周辺のパディングの折りたたみ機能を有効にします。デフォルトは False です。

  • pad_edge (bool, optional) – エッジセルのパディングを有効にします。デフォルトは True です。

  • expand (bool, optional) – True の場合、テーブルを有効なスペースに合わせて展開します。それ以外の場合、テーブル幅は自動計算されます。デフォルトは False です。

  • show_header (bool, optional) – ヘッダー行を表示します。デフォルトは True です。

  • show_footer (bool, optional) – フッター行を表示します。デフォルトは False です。

  • show_edge (bool, optional) – テーブルの外側にボックスを描画します。デフォルトは True です。

  • show_lines (bool, optional) – すべての行の間に線を描画します。デフォルトは False です。

  • leading (bool, optional) – 行間の空白行数（show_lines を除外）。デフォルトは 0 です。

  • style (Union[str, Style], optional) – テーブルのデフォルトスタイル。デフォルトは "none" です。

  • row_styles (List[Union, str], optional) – 行スタイルのオプションリスト。複数のスタイルが指定されている場合は、スタイルが交互に適用されます。デフォルトは None です。

  • header_style (Union[str, Style], optional) – ヘッダーのスタイル。デフォルトは "table.header" です。

  • footer_style (Union[str, Style], optional) – フッターのスタイル。デフォルトは "table.footer" です。

  • border_style (Union[str, Style], optional) – 枠線のスタイル。デフォルトは None です。

  • title_style (Union[str, Style], optional) – タイトルのスタイル。デフォルトは None です。

  • caption_style (Union[str, Style], optional) – キャプションのスタイル。デフォルトは None です。

  • title_justify (str, optional) – タイトルの配置方法。デフォルトは "center" です。

  • caption_justify (str, optional) – キャプションの配置方法。デフォルトは "center" です。

  • highlight (bool, optional) – セルの内容（文字列の場合）をハイライト表示します。デフォルトは False です。

  • header (RenderableType) –

  • footer (RenderableType) –

  • justify (JustifyMethod) –

  • vertical (VerticalAlignMethod) –

  • overflow (OverflowMethod) –

  • max_width (Optional[int]) –

  • ratio (Optional[int]) –

  • no_wrap (bool) –

  • _index (int) –

  • _cells (List[RenderableType]) –

property cells: Iterable[RenderableType]

ヘッダーを除く、列のすべてのセルを取得します。

copy()[ソース]

この Column のコピーを返します。

戻り値の型

Column

property flexible: bool

この列がフレキシブルかどうかを確認します。

footer: RenderableType = ''

フッターのレンダリング可能要素（通常は文字列）

型

RenderableType

footer_style: Union[str, Style] = ''

フッターのスタイル。

型

StyleType

header: RenderableType = ''

ヘッダーのレンダリング可能要素（通常は文字列）

型

RenderableType

header_style: Union[str, Style] = ''

ヘッダーのスタイル。

型

StyleType

justify: JustifyMethod = 'left'

列内のテキストの配置方法 ("left", "center", "right", "full")

型

str

max_width: Optional[int] = None

列の最大幅。最大値がない場合は None。デフォルトは None。

型

Optional[int]

min_width: Optional[int] = None

列の最小幅。最小値がない場合は None。デフォルトは None。

型

Optional[int]

no_wrap: bool = False

列内のテキストの折り返しを禁止します。デフォルトは False です。

型

bool

overflow: OverflowMethod = 'ellipsis'

オーバーフロー処理方法。

型

str

ratio: Optional[int] = None

列幅の計算に使用する比率。列の内容に合わせて調整する場合は None (デフォルト)。

型

Optional[int]

style: Union[str, Style] = ''

列のスタイル。

型

StyleType

vertical: VerticalAlignMethod = 'top'

コンテンツの垂直方向の配置方法 ("top", "middle", "bottom")

型

str

width: Optional[int] = None

列の幅。幅を自動計算する場合は None (デフォルト)。

型

Optional[int]

class rich.table.Row(style=None, end_section=False)[ソース]

行に関する情報。

パラメータ
end_section: bool = False

セクションの末尾を示す。この行の下に線が強制的に引かれます。

style: Optional[Union[str, Style]] = None

行に適用するスタイル。

class rich.table.Table(*headers, title=None, caption=None, width=None, min_width=None, box=Box(...), safe_box=None, padding=(0, 1), collapse_padding=False, pad_edge=True, expand=False, show_header=True, show_footer=False, show_edge=True, show_lines=False, leading=0, style='none', row_styles=None, header_style='table.header', footer_style='table.footer', border_style=None, title_style=None, caption_style=None, title_justify='center', caption_justify='center', highlight=False)[ソース]

コンソールでテーブルを描画するためのレンダリング可能なオブジェクト。

パラメータ

  • *headers (Union[Column, str]) – 列ヘッダー。文字列または Column インスタンスのいずれか。

  • title (Union[str, Text], optional) – 上部にレンダリングされるテーブルのタイトル。デフォルトは None です。

  • caption (Union[str, Text], optional) – 下部にレンダリングされるテーブルのキャプション。デフォルトは None です。

  • width (int, optional) – テーブルの文字幅。または自動調整する場合は None。デフォルトは None です。

  • min_width (Optional[int], optional) – テーブルの最小幅。最小値なしの場合は None。デフォルトは None です。

  • box (box.Box, optional) – エッジの描画に使用される box.py の定数の一つ（Box を参照）。またはボックス線なしの場合は None。デフォルトは box.HEAVY_HEAD です。

  • safe_box (Optional[bool], optional) – ラスタ フォントを使用する Windows レガシーターミナルで表示されないボックス文字を無効にします。デフォルトは True です。

  • padding (PaddingDimensions, optional) – セルのパディング（上、右、下、左）。デフォルトは (0, 1) です。

  • collapse_padding (bool, optional) – セル周辺のパディングの折りたたみ機能を有効にします。デフォルトは False です。

  • pad_edge (bool, optional) – エッジセルのパディングを有効にします。デフォルトは True です。

  • expand (bool, optional) – True の場合、テーブルを有効なスペースに合わせて展開します。それ以外の場合、テーブル幅は自動計算されます。デフォルトは False です。

  • show_header (bool, optional) – ヘッダー行を表示します。デフォルトは True です。

  • show_footer (bool, optional) – フッター行を表示します。デフォルトは False です。

  • show_edge (bool, optional) – テーブルの外側にボックスを描画します。デフォルトは True です。

  • show_lines (bool, optional) – すべての行の間に線を描画します。デフォルトは False です。

  • leading (bool, optional) – 行間の空白行数（show_lines を除外）。デフォルトは 0 です。

  • style (Union[str, Style], optional) – テーブルのデフォルトスタイル。デフォルトは "none" です。

  • row_styles (List[Union, str], optional) – 行スタイルのオプションリスト。複数のスタイルが指定されている場合は、スタイルが交互に適用されます。デフォルトは None です。

  • header_style (Union[str, Style], optional) – ヘッダーのスタイル。デフォルトは "table.header" です。

  • footer_style (Union[str, Style], optional) – フッターのスタイル。デフォルトは "table.footer" です。

  • border_style (Union[str, Style], optional) – 枠線のスタイル。デフォルトは None です。

  • title_style (Union[str, Style], optional) – タイトルのスタイル。デフォルトは None です。

  • caption_style (Union[str, Style], optional) – キャプションのスタイル。デフォルトは None です。

  • title_justify (str, optional) – タイトルの配置方法。デフォルトは "center" です。

  • caption_justify (str, optional) – キャプションの配置方法。デフォルトは "center" です。

  • highlight (bool, optional) – セルの内容（文字列の場合）をハイライト表示します。デフォルトは False です。

add_column(header='', footer='', *, header_style=None, footer_style=None, style=None, justify='left', vertical='top', overflow='ellipsis', width=None, min_width=None, max_width=None, ratio=None, no_wrap=False)[source]

テーブルに列を追加します。

パラメータ

  • header (RenderableType, optional) – ヘッダーのテキストまたはレンダリング可能なオブジェクト。デフォルトは "" です。

  • footer (RenderableType, optional) – フッターのテキストまたはレンダリング可能なオブジェクト。デフォルトは "" です。

  • header_style (Union[str, Style], optional) – ヘッダーのスタイル。デフォルトは None です。

  • footer_style (Union[str, Style], optional) – フッターのスタイル。デフォルトは None です。

  • style (Union[str, Style], optional) – 列のセルのスタイル。デフォルトは None です。

  • justify (JustifyMethod, optional) – セルの配置。デフォルトは "left" です。

  • vertical (VerticalAlignMethod, optional) – 垂直方向の配置。 "top"、"middle"、または "bottom" のいずれか。デフォルトは "top" です。

  • overflow (OverflowMethod) – オーバーフロー処理の方法: "crop"、"fold"、"ellipsis"。デフォルトは "ellipsis" です。

  • width (int, optional) – 列の幅（文字数）。コンテンツに合わせて調整する場合は None です。デフォルトは None です。

  • min_width (Optional[int], optional) – 列の最小幅。最小幅を設けない場合は None。デフォルトは None です。

  • max_width (Optional[int], optional) – 列の最大幅。最大幅を設けない場合は None。デフォルトは None です。

  • ratio (int, optional) – 列の柔軟な比率（Table.expand または Table.width が必要）。デフォルトは None です。

  • no_wrap (bool, optional) – この列の折り返しを無効にする場合は True に設定します。

戻り値の型

None

add_row(*renderables, style=None, end_section=False)[source]

レンダリング可能なオブジェクトの行を追加します。

パラメータ

  • *renderables (None または renderable) – 行の各セルは、レンダリング可能なオブジェクト（strを含む）である必要があります。空白のセルの場合は None を指定します。

  • style (StyleType, optional) – 行全体に適用するオプションのスタイル。デフォルトは None です。

  • end_section (bool, optional) – セクションを終了し、線を描画します。デフォルトは False です。

Raises

errors.NotRenderableError – レンダリングできないオブジェクトを追加した場合。

戻り値の型

None

add_section()[source]

新しいセクションを追加します（現在の行の後に線を描画します）。

戻り値の型

None

property expand: bool

self.width に None 以外の値を設定すると、expand が有効になります。

get_row_style(console, index)[source]

現在の行のスタイルを取得します。

パラメータ
戻り値の型

Union[str, Style]

classmethod grid(*headers, padding=0, collapse_padding=True, pad_edge=False, expand=False)[source]

線、ヘッダー、フッターのないテーブルを取得します。

パラメータ

  • *headers (Union[Column, str]) – 列ヘッダー。文字列または Column インスタンスのいずれか。

  • padding (PaddingDimensions, optional) – セルの周囲のパディングを設定します。デフォルトは 0 です。

  • collapse_padding (bool, optional) – セルの周囲のパディングの折りたたみを有効にします。デフォルトは True です。

  • pad_edge (bool, optional) – テーブルの端の周囲のパディングを有効にします。デフォルトは False です。

  • expand (bool, optional) – True の場合、テーブルを有効なスペースに合わせて展開します。それ以外の場合、テーブル幅は自動計算されます。デフォルトは False です。

Returns

テーブルのインスタンス。

戻り値の型

Table

property padding: Tuple[int, int, int, int]

セルのパディングを取得します。

property row_count: int

現在の行数を取得します。