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>)[源代码]

定义~表中的列。

参数

  • title (Union[str, Text], optional) -- 在顶部呈现的表格的标题。默认为无。

  • caption (Union[str, Text], optional) -- 下面呈现的表格标题。默认为无。

  • width (int, optional) -- 表的宽度(以字符为单位)，或 None 以自动适应。默认为无。

  • min_width (Optional[int], optional) -- 表格的最小宽度，或 None 没有最低要求。默认为无。

  • box (box.Box, optional) -- Box.py中用于绘制边的常量之一(请参见 盒 )，或 None 因为没有盒子线条。默认为box。HEAVY_HEAD。

  • safe_box (Optional[bool], optional) -- 禁用不在Windows传统终端上显示的方框字符 raster 字体。默认为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) -- 表格的默认样式。默认为“无”。

  • row_styles (List[Union, str], optional) -- 可选的行样式列表，如果提供了多个样式，则将交替使用这些样式。默认为无。

  • header_style (Union[str, Style], optional) -- 页眉的样式。默认为“Table.Header”。

  • footer_style (Union[str, Style], optional) -- 页脚的样式。默认为“able.footer”。

  • border_style (Union[str, Style], optional) -- 边框的样式。默认为无。

  • title_style (Union[str, Style], optional) -- 标题的样式。默认为无。

  • caption_style (Union[str, Style], optional) -- 标题的样式。默认为无。

  • title_justify (str, optional) -- 标题的调整方法。默认为“中心”。

  • caption_justify (str, optional) -- 调整标题的方法。默认为“中心”。

  • 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

property flexible: bool

检查该列是否灵活。

footer: RenderableType = ''

可呈现的页脚(通常为字符串)

类型

RenderableType

footer_style: Union[str, Style] = ''

页脚的样式。

类型

StyleType

header: RenderableType = ''

可呈现的标题(通常为字符串)

类型

RenderableType

header_style: Union[str, Style] = ''

页眉的样式。

类型

StyleType

justify: JustifyMethod = 'left'

如何对齐列中的文本(“左”、“中”、“右”或“全”)

类型

应力

max_width: Optional[int] = None

最大列宽，或 None 没有最高限额。默认为无。

类型

任选 [int]

min_width: Optional[int] = None

最小列宽，或 None 没有最低要求。默认为无。

类型

任选 [int]

no_wrap: bool = False

防止列中的文本换行。默认为 False 。

类型

布尔尔

overflow: OverflowMethod = 'ellipsis'

溢出方法。

类型

应力

ratio: Optional[int] = None

计算列宽时使用的比率，或 None (默认)以适应列内容。

类型

任选 [int]

style: Union[str, Style] = ''

柱的样式。

类型

StyleType

vertical: VerticalAlignMethod = 'top'

如何垂直对齐内容(“上”、“中”或“下”)

类型

应力

width: Optional[int] = None

列的宽度，或 None (默认)自动计算宽度。

类型

任选 [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) -- 在顶部呈现的表格的标题。默认为无。

  • caption (Union[str, Text], optional) -- 下面呈现的表格标题。默认为无。

  • width (int, optional) -- 表的宽度(以字符为单位)，或 None 以自动适应。默认为无。

  • min_width (Optional[int], optional) -- 表格的最小宽度，或 None 没有最低要求。默认为无。

  • box (box.Box, optional) -- Box.py中用于绘制边的常量之一(请参见 盒 )，或 None 因为没有盒子线条。默认为box。HEAVY_HEAD。

  • safe_box (Optional[bool], optional) -- 禁用不在Windows传统终端上显示的方框字符 raster 字体。默认为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) -- 表格的默认样式。默认为“无”。

  • row_styles (List[Union, str], optional) -- 可选的行样式列表，如果提供了多个样式，则将交替使用这些样式。默认为无。

  • header_style (Union[str, Style], optional) -- 页眉的样式。默认为“Table.Header”。

  • footer_style (Union[str, Style], optional) -- 页脚的样式。默认为“able.footer”。

  • border_style (Union[str, Style], optional) -- 边框的样式。默认为无。

  • title_style (Union[str, Style], optional) -- 标题的样式。默认为无。

  • caption_style (Union[str, Style], optional) -- 标题的样式。默认为无。

  • title_justify (str, optional) -- 标题的调整方法。默认为“中心”。

  • caption_justify (str, optional) -- 调整标题的方法。默认为“中心”。

  • 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)[源代码]

向表中添加一列。

参数

  • header (RenderableType, optional) -- 页眉的文本或可呈现。默认为“”。

  • footer (RenderableType, optional) -- 页脚的文本或可呈现的。默认为“”。

  • header_style (Union[str, Style], optional) -- 页眉的样式，或默认的无。默认为无。

  • footer_style (Union[str, Style], optional) -- 页脚的样式，或默认的无。默认为无。

  • style (Union[str, Style], optional) -- 列单元格的样式，或默认为无。默认为无。

  • justify (JustifyMethod, optional) -- 单元格对齐方式。默认为“Left”。

  • vertical (VerticalAlignMethod, optional) -- 垂直对齐，“上”、“中”或“下”之一。默认为“top”。

  • overflow (OverflowMethod) -- 溢出方式：“裁剪”、“折叠”、“省略”。默认为“省略号”。

  • width (int, optional) -- 所需的列宽(以字符为单位)，或无以适应内容。默认为无。

  • min_width (Optional[int], optional) -- 最小列宽，或 None 没有最低要求。默认为无。

  • max_width (Optional[int], optional) -- 最大列宽，或 None 没有最高限额。默认为无。

  • ratio (int, optional) -- 列的灵活比率(需要 Table.expand 或 Table.width )。默认为无。

  • no_wrap (bool, optional) -- 设置为 True 若要禁用此列的换行，请执行以下操作。

返回类型

None

add_row(*renderables, style=None, end_section=False)[源代码]

添加一行可渲染对象。

参数

  • *renderables (None or renderable) -- 行中的每个单元格必须是可呈现的对象(包括str)，或者 None 对于空白单元格。

  • style (StyleType, optional) -- 应用于整行的可选样式。默认为无。

  • end_section (bool, optional) -- 结束一段并绘制一条线。默认为False。

抛出

errors.NotRenderableError -- 如果您添加了无法渲染的内容。

返回类型

None

add_section()[源代码]

添加新部分(在当前行之后绘制一条线)。

返回类型

None

property expand: bool

设置一个非None的self.width意味着扩展。

get_row_style(console, index)[源代码]

获取当前的行样式。

参数
返回类型

Union[str, Style]

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

获取一个没有线条、页眉或页脚的表格。

参数

  • *headers (Union[Column, str]) -- 作为字符串的列标题，或 Column 举个例子。

  • padding (PaddingDimensions, optional) -- 在单元格周围填充。默认为0。

  • collapse_padding (bool, optional) -- 启用折叠单元格周围的填充。默认为True。

  • pad_edge (bool, optional) -- 在桌子边缘周围启用填充。默认为False。

  • expand (bool, optional) -- 如果出现以下情况，请展开表格以适应可用空间 True ，否则将自动计算表格宽度。默认为False。

返回

一个表实例。

返回类型

Table

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

拿手机垫子来。

property row_count: int

获取当前行数。