rich.logging

class rich.logging.RichHandler(level=0, console=None, *, show_time=True, omit_repeated_times=True, show_level=True, show_path=True, enable_link_path=True, highlighter=None, markup=False, rich_tracebacks=False, tracebacks_width=None, tracebacks_extra_lines=3, tracebacks_theme=None, tracebacks_word_wrap=True, tracebacks_show_locals=False, tracebacks_suppress=(), locals_max_length=10, locals_max_string=80, log_time_format='[%x %X]', keywords=None)[源代码]

使用Rich呈现输出的日志记录处理程序。时间/级别/消息和文件以列显示。级别是彩色编码的,消息的语法突出显示。

备注

如果已为不受您控制的库配置了日志记录,则在日志消息中启用控制台标记时要小心。如果依赖项写入包含方括号的消息,则它可能不会生成预期的输出。

参数
  • level (Union[int, str], optional) -- 日志级别。默认为Logging。NOTSET。

  • console (Console, optional) -- 用于写入日志的可选控制台实例。默认情况下,将使用写入标准输出的全局控制台实例。

  • show_time (bool, optional) -- 显示一栏的时间。默认为True。

  • omit_repeated_times (bool, optional) -- 省略相同时间的重复。默认为True。

  • show_level (bool, optional) -- 显示标高的列。默认为True。

  • show_path (bool, optional) -- 显示原始日志调用的路径。默认为True。

  • enable_link_path (bool, optional) -- 启用路径列到文件的终端链接。默认为True。

  • highlighter (Highlighter, optional) -- 高亮显示以设置日志消息的样式,或无以使用ReprHighlight。默认为无。

  • markup (bool, optional) -- 在日志消息中启用控制台标记。默认为False。

  • rich_tracebacks (bool, optional) -- 通过语法突出显示和格式设置实现丰富的回溯。默认为False。

  • tracebacks_width (Optional[int], optional) -- 用于呈现回溯的字符数,或为全角无。默认为无。

  • tracebacks_extra_lines (int, optional) -- 用于呈现回溯的附加代码行,或者不显示全宽代码行。默认为无。

  • tracebacks_theme (str, optional) -- 覆盖回溯中使用的俾格森主题。

  • tracebacks_word_wrap (bool, optional) -- 启用长追溯行的自动换行。默认为True。

  • tracebacks_show_locals (bool, optional) -- 启用回溯中的本地变量显示。默认为False。

  • tracebacks_suppress (Sequence[Union[str, ModuleType]]) -- 要从回溯中排除的模块或路径的可选序列。

  • locals_max_length (int, optional) -- 缩写前容器的最大长度,如果没有缩写,则为无。默认为10。

  • locals_max_string (int, optional) -- 截断前字符串的最大长度,或禁用None。默认为80。

  • log_time_format (Union[str, TimeFormatterCallable], optional) -- 如果 log_time 已启用,可以是StrfTime的字符串,也可以是格式化时间的Callable。默认为“ [%x %X] “。”

  • keywords (List[str], optional) -- 要突出显示的单词列表,而不是 RichHandler.KEYWORDS

HIGHLIGHTER_CLASS

ReprHighlighter 的别名

emit(record)[源代码]

通过日志记录调用。

参数

record (LogRecord) --

返回类型

None

get_level_text(record)[源代码]

从记录中获取关卡名称。

参数

record (LogRecord) -- LogRecord实例。

返回

样式和标高名称的元组。

返回类型

Text

render(*, record, traceback, message_renderable)[源代码]

用于显示的渲染日志。

参数
  • record (LogRecord) -- 记录记录。

  • traceback (Optional[Traceback]) -- 回溯实例或无,表示没有回溯。

  • message_renderable (ConsoleRenderable) -- 包含日志消息内容的可呈现(通常为文本)。

返回

可呈现以显示日志。

返回类型

ConsoleRenderable

render_message(record, message)[源代码]

将消息文本呈现为文本。

参数
  • record (LogRecord) -- 记录记录。

  • message (str) -- 包含日志消息的字符串。

返回

可呈现以显示日志消息。

返回类型

ConsoleRenderable