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, ...)

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) – ログメッセージをスタイル化するハイライター、またはReprHighlighterを使用する場合はNone。デフォルトはNone。

• markup (bool, optional) – ログメッセージでコンソールマークアップを有効にする。デフォルトはFalse。

• rich_tracebacks (bool, optional) – シンタックスハイライトとフォーマットを備えたリッチトレースバックを有効にする。デフォルトはFalse。

• tracebacks_width (Optional[int], optional) – トレースバックのレンダリングに使用される文字数、または全幅の場合はNone。デフォルトはNone。

• tracebacks_extra_lines (int, optional) – トレースバックをレンダリングするための追加のコード行数、または全幅の場合は None。デフォルトはNoneです。

• tracebacks_theme (str, optional) – トレースバックで使用されるpygmentsテーマをオーバーライドする。

• tracebacks_word_wrap (bool, optional) – 長いトレースバック行のワードラップを有効にする。デフォルトはTrue。

• tracebacks_show_locals (bool, optional) – トレースバックでローカル変数の表示を有効にする。デフォルトはFalse。

• tracebacks_suppress (Sequence[Union[str, ModuleType]]) – トレースバックから除外するモジュールまたはパスのオプションのシーケンス。

• locals_max_length (int, optional) – 省略する前のコンテナの最大長、省略しない場合はNone。デフォルトは10。

• locals_max_string (int, optional) – 切り捨てる前の文字列の最大長、無効にする場合はNone。デフォルトは80。

• log_time_format (Union[str, TimeFormatterCallable], optional) – log_time が有効な場合、strftime の文字列または時刻を書式設定する呼び出し可能オブジェクト。デフォルトは "[%x %X]" です。

• keywords (List[str], optional) – RichHandler.KEYWORDS の代わりに強調表示する単語のリスト。

HIGHLIGHTER_CLASS

ReprHighlighter のエイリアス

emit(record)

ロギングによって呼び出されます。

パラメータ

record (LogRecord) –

戻り値の型

なし

get_level_text(record)

レコードからレベル名を取得します。

パラメータ

record (LogRecord) – LogRecordインスタンス。

戻り値

スタイルとレベル名のタプル。

戻り値の型

テキスト

render(*, record, traceback, message_renderable)

表示用にログをレンダリングします。

パラメータ

• record (LogRecord) – ロギングレコード。

• traceback (オプション[Traceback]) – Traceback インスタンス、または Traceback を表示しない場合は None。

• message_renderable (ConsoleRenderable) – ログメッセージの内容を含むレンダリング可能なオブジェクト（通常は Text）。

戻り値

ログを表示するためのレンダリング可能なオブジェクト。

戻り値の型

ConsoleRenderable

render_message(record, message)

メッセージテキストを Text にレンダリングします。

パラメータ

• record (LogRecord) – ロギングレコード。

• message (str) – ログメッセージを含む文字列。

戻り値

ログメッセージを表示するためのレンダリング可能なオブジェクト。

戻り値の型

ConsoleRenderable