rich.live

class rich.live.Live(renderable=None, *, console=None, screen=False, auto_refresh=True, refresh_per_second=4, transient=False, redirect_stdout=True, redirect_stderr=True, vertical_overflow='ellipsis', get_renderable=None)

渲染任何给定可渲染对象的自动更新实时显示。

参数

• renderable (RenderableType, 可选) – 要实时显示的可渲染对象。默认为不显示任何内容。

• console (Console, 可选) – 可选的 Console 实例。默认情况下，将创建一个内部 Console 实例，写入 stdout。

• screen (bool, 可选) – 启用备用屏幕模式。默认为 False。

• auto_refresh (bool, 可选) – 启用自动刷新。如果禁用，您将需要使用刷新标志调用 refresh() 或 update()。默认为 True

• refresh_per_second (float, 可选) – 每秒刷新实时显示的次数。默认为 4。

• transient (bool, 可选) – 退出时清除可渲染对象（在 screen=True 时无效）。默认为 False。

• redirect_stdout (bool, 可选) – 启用 stdout 重定向，以便可以使用 print。默认为 True。

• redirect_stderr (bool, 可选) – 启用 stderr 重定向。默认为 True。

• vertical_overflow (VerticalOverflowMethod, 可选) – 可渲染对象过高而无法适应控制台时如何处理。默认为“ellipsis”。

• get_renderable (Callable[[], RenderableType], 可选) – 可选的调用函数以获取可渲染对象。默认为 None。

property is_started: bool

检查实时显示是否已启动。

process_renderables(renderables)

处理可渲染对象以恢复光标并显示进度。

参数

renderables (List[ConsoleRenderable]) –

返回值类型

List[ConsoleRenderable]

refresh()

更新 Live Render 的显示。

返回值类型

无

property renderable: Union[ConsoleRenderable, RichCast, str]

获取正在显示的可渲染对象

返回值

显示的可渲染对象。

返回值类型

RenderableType

start(refresh=False)

启动实时渲染显示。

参数

refresh (bool, 可选) – 也刷新。默认为 False。

返回值类型

无

stop()

停止实时渲染显示。

返回值类型

无

update(renderable, *, refresh=False)

更新正在显示的可渲染对象

参数

• renderable (RenderableType) – 要使用的新的可渲染对象。

• refresh (bool, 可选) – 刷新显示。默认为 False。

返回值类型

无