富有

终端中的富文本和美观的格式。

rich.get_console()[源代码]

获取全球 Console 举个例子。当Rich需要控制台,但尚未显式提供控制台时,使用此函数。

返回

控制台实例。

返回类型

Console

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

检查任何Python对象。

  • 检查(<Object>)以查看摘要信息。

  • 检查(<对象>,方法=True)以查看方法。

  • 检查(<Object>,Help=True)以查看完整(非缩写)帮助。

  • 检查(<Object>,Private=True)以查看私有属性(单下划线)。

  • 检查(<Object>,DUnder=True)以查看以双下划线开头的属性。

  • 检查(<Object>,All=True)以查看所有属性。

参数
  • obj (Any) -- 要检查的对象。

  • title (str, optional) -- 用于显示过检查结果的标题,或无使用类型。默认为无。

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

通过位置参数提供的Print对象(S)。此功能具有与内置打印机相同的签名。有关更多高级功能,请参阅 Console 班级。

参数
  • sep (str, optional) -- 打印对象之间的分隔符。默认为“”。

  • end (str, optional) -- 要在输出结束时写入的字符。默认为“\n”。

  • file (IO[str], optional) -- 要写入的文件,或者标准输出为无。默认为无。

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

漂亮的印花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编码的值的可调用函数。默认为无。

  • sort_keys (bool, optional) -- 对词典关键字进行排序。默认为False。

返回类型

None

rich.reconfigure(*args, **kwargs)[源代码]

通过将全局控制台替换为其他控制台来重新配置全局控制台。

参数
  • *args (Any) -- 替换的位置论据 Console

  • **kwargs (Any) -- 替换的关键字参数 Console

返回类型

None