rich¶

终端中的富文本和漂亮格式。

rich.get_console()[source]¶

获取全局 Console 实例。当 Rich 需要一个 Console，但尚未明确提供时，将使用此函数。

返回值: 一个控制台实例。
返回类型: Console

rich.inspect(obj, *, console=None, title=None, help=False, methods=False, docs=True, private=False, dunder=False, sort=True, all=False, value=True)[source]¶

检查任何 Python 对象。

inspect(<OBJECT>) 以查看摘要信息。
inspect(<OBJECT>, methods=True) 以查看方法。
inspect(<OBJECT>, help=True) 以查看完整（非缩写）帮助。
inspect(<OBJECT>, private=True) 以查看私有属性（单个下划线）。
inspect(<OBJECT>, dunder=True) 以查看以双下划线开头的属性。
inspect(<OBJECT>, all=True) 以查看所有属性。

参数

obj (Any) – 要检查的对象。
title (str, optional) – 在检查结果上显示的标题，或使用 None 使用类型。默认为 None。
help (bool, optional) – 显示完整帮助文本，而不是只显示第一段。默认为 False。
methods (bool, optional) – 启用对可调用对象的检查。默认为 False。
docs (bool, optional) – 还渲染文档字符串。默认为 True。
private (bool, optional) – 显示私有属性（以下划线开头）。默认为 False。
dunder (bool, optional) – 显示以双下划线开头的属性。默认为 False。
sort (bool, optional) – 按字母顺序排序属性。默认为 True。
all (bool, optional) – 显示所有属性。默认为 False。
value (bool, optional) – 漂亮打印值。默认为 True。
console (Optional[Console]) –

返回类型

None

rich.print(*objects, sep=' ', end='\n', file=None, flush=False)[source]¶

打印通过位置参数提供的对象。此函数具有与内置 print 相同的签名。有关更高级的功能，请参阅 Console 类。

参数

sep (str, optional) – 打印对象之间的分隔符。默认为 ” “。
end (str, optional) – 在输出末尾写入的字符。默认为 “\n”。
file (IO[str], optional) – 要写入的文件，或 None 代表 stdout。默认为 None。
flush (bool, optional) – 没有效果，因为 Rich 总是刷新输出。默认为 False。
objects (Any) –

返回类型

None

rich.print_json(json=None, *, data=None, indent=2, highlight=True, skip_keys=False, ensure_ascii=False, check_circular=True, allow_nan=True, default=None, sort_keys=False)[source]¶

漂亮打印 JSON。输出将是有效的 JSON。

参数

json (str) – 包含 JSON 的字符串。
data (Any) – 如果 json 未提供，则对该数据进行编码。
indent (int, optional) – 要缩进的空格数。默认为 2。
highlight (bool, optional) – 启用输出高亮显示：默认为 True。
skip_keys (bool, optional) – 跳过不是基本类型的键。默认为 False。
ensure_ascii (bool, optional) – 逃逸所有非 ASCII 字符。默认为 False。
check_circular (bool, optional) – 检查循环引用。默认为 True。
allow_nan (bool, optional) – 允许 NaN 和 Infinity 值。默认为 True。
default (Callable, optional) – 一个可调用对象，它将无法编码的值转换为可以 JSON 编码的值。默认为 None。
sort_keys (bool, optional) – 对字典键进行排序。默认为 False。

返回类型

None

rich.reconfigure(*args, **kwargs)[source]¶

通过使用另一个控制台替换全局控制台来重新配置。

参数

*args (Any) – 替换 Console 的位置参数。
**kwargs (Any) – 替换 Console 的关键字参数。

返回类型

None