rich.pretty

class rich.pretty.Node(key_repr='', value_repr='', open_brace='', close_brace='', empty='', last=False, is_tuple=False, is_namedtuple=False, children=None, key_separator=': ', separator=', ')

reprツリーのノード。アトミックまたはコンテナの可能性があります。

パラメータ

• key_repr (str) –

• value_repr (str) –

• open_brace (str) –

• close_brace (str) –

• empty (str) –

• last (bool) –

• is_tuple (bool) –

• is_namedtuple (bool) –

• children (Optional[List[Node]]) –

• key_separator (str) –

• separator (str) –

check_length(start_length, max_length)

長さが制限内に収まるか確認します。

パラメータ

• start_length (int) – 行の開始長（インデント、プレフィックス、サフィックス）。

• max_length (int) – 最大長。

戻り値

ノードが最大長以内にレンダリングできる場合はTrue、そうでない場合はFalse。

戻り値の型

bool

iter_tokens()

このノードのトークンを生成します。

戻り値の型

Iterable[str]

render(max_width=80, indent_size=4, expand_all=False)

ノードをプリティreprにレンダリングします。

パラメータ

• max_width (int, オプション) – reprの最大幅。デフォルトは80です。

• indent_size (int, オプション) – インデントのサイズ。デフォルトは4です。

• expand_all (bool, オプション) – すべてのレベルを展開します。デフォルトはFalseです。

戻り値

元のオブジェクトのrepr文字列。

戻り値の型

str

class rich.pretty.Pretty(_object, highlighter=None, *, indent_size=4, justify=None, overflow=None, no_wrap=False, indent_guides=False, max_length=None, max_string=None, max_depth=None, expand_all=False, margin=0, insert_line=False)

オブジェクトをプリティプリントするリッチレンダリング可能オブジェクト。

パラメータ

• _object (Any) – プリティプリントするオブジェクト。

• highlighter (HighlighterType, オプション) – 結果に適用するハイライターオブジェクト。ReprHighlighterの場合はNone。デフォルトはNoneです。

• indent_size (int, オプション) – インデント内のスペース数。デフォルトは4です。

• justify (JustifyMethod, オプション) – ジャスティファイメソッド。デフォルトの場合はNone。デフォルトはNoneです。

• overflow (OverflowMethod, オプション) – オーバーフローメソッド。デフォルトの場合はNone。デフォルトはNoneです。

• no_wrap (Optional[bool], オプション) – ワードラップを無効にします。デフォルトはFalseです。

• indent_guides (bool, オプション) – インデントガイドを有効にします。デフォルトはFalseです。

• max_length (int, オプション) – コンテナが省略される前の最大長。省略しない場合はNone。デフォルトはNoneです。

• max_string (int, オプション) – 文字列が切り捨てられる前の最大長。無効にする場合はNone。デフォルトはNoneです。

• max_depth (int, オプション) – ネストされたデータ構造の最大深度。最大値がない場合はNone。デフォルトはNoneです。

• expand_all (bool, オプション) – すべてのコンテナを展開します。デフォルトはFalseです。

• margin (int, オプション) – コンテナをより早く展開させるために、幅からマージンを引きます。デフォルトは0です。

• insert_line (bool, オプション) – 出力に複数の改行がある場合に、新しい行を挿入します。デフォルトはFalseです。

rich.pretty.install(console=None, overflow='ignore', crop=False, indent_guides=False, max_length=None, max_string=None, max_depth=None, expand_all=False)

Python REPLに自動的なプリティプリントをインストールします。

パラメータ

• console (Console, オプション) – コンソールインスタンス、またはグローバルコンソールを使用する場合はNone。デフォルトはNoneです。

• overflow (Optional[OverflowMethod], オプション) – オーバーフローメソッド。デフォルトは "ignore" です。

• crop (Optional[bool], オプション) – 長い行の切り抜きを有効にする。デフォルトはFalseです。

• indent_guides (bool, オプション) – インデントガイドを有効にします。デフォルトはFalseです。

• max_length (int, オプション) – コンテナが省略される前の最大長。省略しない場合はNone。デフォルトはNoneです。

• max_string (int, オプション) – 文字列が切り捨てられる前の最大長。無効にする場合はNone。デフォルトはNoneです。

• max_depth (int, オプション) – ネストされたデータ構造の最大深度。最大値がない場合はNone。デフォルトはNoneです。

• expand_all (bool, オプション) – すべてのコンテナを展開します。デフォルトはFalseです。

• max_frames (int) – トレースバックに表示する最大フレーム数。最大値を設定しない場合は0。デフォルトは100です。

戻り値の型

なし

rich.pretty.is_expandable(obj)

オブジェクトがプリティプリントで展開可能かどうかを確認します。

パラメータ

obj (Any) –

戻り値の型

bool

rich.pretty.pprint(_object, *, console=None, indent_guides=True, max_length=None, max_string=None, max_depth=None, expand_all=False)

プリティプリントを行うための便利な関数。

パラメータ

• _object (Any) – プリティプリントするオブジェクト。

• console (Console, オプション) – コンソールインスタンス。デフォルトを使用する場合はNone。デフォルトはNoneです。

• max_length (int, オプション) – コンテナが省略される前の最大長。省略しない場合はNone。デフォルトはNoneです。

• max_string (int, オプション) – 文字列を切り詰める前の最大長。無効にする場合はNone。デフォルトはNoneです。

• max_depth (int, オプション) – ネストされたデータ構造の最大深度。無制限の場合はNone。デフォルトはNoneです。

• indent_guides (bool, オプション) – インデントガイドを有効にする。デフォルトはTrueです。

• expand_all (bool, オプション) – すべてのコンテナを展開します。デフォルトはFalseです。

戻り値の型

なし

rich.pretty.pretty_repr(_object, *, max_width=80, indent_size=4, max_length=None, max_string=None, max_depth=None, expand_all=False)

与えられた幅内に収まるように、改行してrepr文字列をプリティ表示します。

パラメータ

• _object (Any) – reprするオブジェクト。

• max_width (int, オプション) – repr文字列の希望する最大幅。デフォルトは80です。

• indent_size (int, オプション) – インデントするスペースの数。デフォルトは4です。

• max_length (int, オプション) – コンテナが省略される前の最大長。省略しない場合はNone。デフォルトはNoneです。

• max_string (int, オプション) – 文字列を切り詰める前の最大長。切り詰めを無効にする場合はNone。デフォルトはNoneです。

• max_depth (int, オプション) – ネストされたデータ構造の最大深度。深度を設定しない場合はNone。デフォルトはNoneです。

• expand_all (bool, オプション) – 利用可能な幅に関係なく、すべてのコンテナを展開します。デフォルトはFalseです。

戻り値

オブジェクトの複数行になる可能性のある表現。

戻り値の型

str

rich.pretty.traverse(_object, max_length=None, max_string=None, max_depth=None)

オブジェクトをトラバースしてツリーを生成します。

パラメータ

• _object (Any) – トラバースするオブジェクト。

• max_length (int, オプション) – コンテナが省略される前の最大長。省略しない場合はNone。デフォルトはNoneです。

• max_string (int, オプション) – 文字列を切り詰める前の最大長。切り詰めを無効にする場合はNone。デフォルトはNoneです。

• max_depth (int, オプション) – データ構造の最大深度。最大値を設定しない場合はNone。デフォルトはNoneです。

戻り値

プリティreprのレンダリングに使用できるツリー構造のルート。

戻り値の型

ノード