rich.traceback¶

class rich.traceback.Traceback(trace=None, *, width=100, extra_lines=3, theme=None, word_wrap=False, show_locals=False, locals_max_length=10, locals_max_string=80, locals_hide_dunder=True, locals_hide_sunder=False, indent_guides=True, suppress=(), max_frames=100)[ソース]¶

トレースバックをレンダリングするConsoleレンダラブル。

パラメータ

trace (Trace, オプション) – extract から生成された Trace オブジェクト。デフォルトは None で、最後のエラーを使用します。
width (Optional[int], オプション) – トレースバックに使用する文字数。デフォルトは 100 です。
extra_lines (int, オプション) – レンダリングする追加のコード行数。デフォルトは 3 です。
theme (str, オプション) – トレースバックで使用する pygments のテーマをオーバーライドします。
word_wrap (bool, オプション) – 長い行のワードラップを有効にします。デフォルトは False です。
show_locals (bool, オプション) – ローカル変数の表示を有効にします。デフォルトは False です。
indent_guides (bool, オプション) – コードとローカル変数でインデントガイドを有効にします。デフォルトは True です。
locals_max_length (int, オプション) – 省略する前のコンテナの最大長、または省略しない場合は None。デフォルトは 10 です。
locals_max_string (int, オプション) – 切り詰める前の文字列の最大長、または無効にする場合は None。デフォルトは 80 です。
locals_hide_dunder (bool, オプション) – ダブルアンダースコアで始まるローカル変数を非表示にします。デフォルトは True です。
locals_hide_sunder (bool, オプション) – シングルアンダースコアで始まるローカル変数を非表示にします。デフォルトは False です。
suppress (Sequence[Union[str, ModuleType]]) – トレースバックから除外するモジュールまたはパスのオプションのシーケンス。
max_frames (int) – トレースバックに表示するフレームの最大数。最大値がない場合は 0。デフォルトは 100 です。

classmethod extract(exc_type, exc_value, traceback, *, show_locals=False, locals_max_length=10, locals_max_string=80, locals_hide_dunder=True, locals_hide_sunder=False)[ソース]¶

トレースバック情報を抽出します。

パラメータ

exc_type (Type[BaseException]) – 例外のタイプ。
exc_value (BaseException) – 例外の値。
traceback (TracebackType) – Python トレースバックオブジェクト。
show_locals (bool, オプション) – ローカル変数の表示を有効にします。デフォルトは False です。
locals_max_length (int, オプション) – 省略する前のコンテナの最大長、または省略しない場合は None。デフォルトは 10 です。
locals_max_string (int, オプション) – 切り詰める前の文字列の最大長、または無効にする場合は None。デフォルトは 80 です。
locals_hide_dunder (bool, オプション) – ダブルアンダースコアで始まるローカル変数を非表示にします。デフォルトは True です。
locals_hide_sunder (bool, オプション) – シングルアンダースコアで始まるローカル変数を非表示にします。デフォルトは False です。

戻り値

Traceback の構築に使用できる Trace インスタンス。

戻り値の型

Trace

classmethod from_exception(exc_type, exc_value, traceback, *, width=100, extra_lines=3, theme=None, word_wrap=False, show_locals=False, locals_max_length=10, locals_max_string=80, locals_hide_dunder=True, locals_hide_sunder=False, indent_guides=True, suppress=(), max_frames=100)[ソース]¶

例外情報からトレースバックを作成します

パラメータ

exc_type (Type[BaseException]) – 例外のタイプ。
exc_value (BaseException) – 例外の値。
traceback (TracebackType) – Python トレースバックオブジェクト。
width (Optional[int], オプション) – トレースバックに使用する文字数。デフォルトは 100 です。
extra_lines (int, オプション) – レンダリングする追加のコード行数。デフォルトは 3 です。
theme (str, オプション) – トレースバックで使用する pygments のテーマをオーバーライドします。
word_wrap (bool, オプション) – 長い行のワードラップを有効にします。デフォルトは False です。
show_locals (bool, オプション) – ローカル変数の表示を有効にします。デフォルトは False です。
indent_guides (bool, オプション) – コードとローカル変数でインデントガイドを有効にします。デフォルトは True です。
locals_max_length (int, オプション) – 省略する前のコンテナの最大長、または省略しない場合は None。デフォルトは 10 です。
locals_max_string (int, オプション) – 切り詰める前の文字列の最大長、または無効にする場合は None。デフォルトは 80 です。
locals_hide_dunder (bool, オプション) – ダブルアンダースコアで始まるローカル変数を非表示にします。デフォルトは True です。
locals_hide_sunder (bool, オプション) – シングルアンダースコアで始まるローカル変数を非表示にします。デフォルトは False です。
suppress (Iterable[Union[str, ModuleType]]) – トレースバックから除外するモジュールまたはパスのオプションのシーケンス。
max_frames (int) – トレースバックに表示するフレームの最大数。最大値がない場合は 0。デフォルトは 100 です。

戻り値

印刷可能な Traceback インスタンス。

戻り値の型

トレースバック

rich.traceback.install(*, console=None, width=100, extra_lines=3, theme=None, word_wrap=False, show_locals=False, locals_max_length=10, locals_max_string=80, locals_hide_dunder=True, locals_hide_sunder=None, indent_guides=True, suppress=(), max_frames=100)[source]¶

リッチなトレースバックハンドラーをインストールします。

インストールされると、すべてのトレースバックは構文強調とリッチフォーマットで出力されます。

パラメータ

console (Optional[Console], optional) – 例外を書き込むコンソール。デフォルトは内部の Console インスタンスを使用します。
width (Optional[int], optional) – トレースバックの幅（文字数）。デフォルトは 100 です。
extra_lines (int, optional) – コードの追加行数。デフォルトは 3 です。
theme (Optional[str], optional) – トレースバックで使用する Pygments のテーマ。デフォルトは None で、プラットフォームに適したテーマが選択されます。
word_wrap (bool, オプション) – 長い行のワードラップを有効にします。デフォルトは False です。
show_locals (bool, オプション) – ローカル変数の表示を有効にします。デフォルトは False です。
locals_max_length (int, オプション) – 省略する前のコンテナの最大長、または省略しない場合は None。デフォルトは 10 です。
locals_max_string (int, オプション) – 切り詰める前の文字列の最大長、または無効にする場合は None。デフォルトは 80 です。
locals_hide_dunder (bool, オプション) – ダブルアンダースコアで始まるローカル変数を非表示にします。デフォルトは True です。
locals_hide_sunder (bool, オプション) – シングルアンダースコアで始まるローカル変数を非表示にします。デフォルトは False です。
indent_guides (bool, オプション) – コードとローカル変数でインデントガイドを有効にします。デフォルトは True です。
suppress (Sequence[Union[str, ModuleType]]) – トレースバックから除外するモジュールまたはパスのオプションのシーケンス。
max_frames (int) –

戻り値

置き換えられた以前の例外ハンドラー。

戻り値の型

呼び出し可能オブジェクト