rich

ターミナルでリッチテキストと美しいフォーマットを実現します。

rich.get_console()[source]

グローバルなConsoleインスタンスを取得します。この関数は、RichがConsoleを必要とし、明示的にConsoleが渡されていない場合に使用されます。

戻り値

コンソールインスタンス。

戻り値の型

Console

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

任意のPythonオブジェクトを検査します。

  • 要約情報を表示するにはinspect(<OBJECT>)を使用します。

  • メソッドを表示するにはinspect(<OBJECT>, methods=True)を使用します。

  • 完全な（省略されていない）ヘルプを表示するにはinspect(<OBJECT>, help=True)を使用します。

  • プライベート属性（アンダースコアで始まる属性）を表示するにはinspect(<OBJECT>, private=True)を使用します。

  • ダブルアンダースコアで始まる属性を表示するにはinspect(<OBJECT>, dunder=True)を使用します。

  • すべての属性を表示するにはinspect(<OBJECT>, all=True)を使用します。

パラメータ

  • **obj** (Any) – 検査するオブジェクト。

  • **title** (str, optional) – 検査結果の上に表示するタイトル、またはNoneの場合、型を使用します。デフォルトはNone。

  • **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)[source]

位置引数で指定されたオブジェクトを出力します。この関数は、組み込みのprint関数と同じシグネチャを持っています。より高度な機能については、Consoleクラスを参照してください。

パラメータ

  • **sep** (str, optional) – 出力オブジェクト間のセパレータ。デフォルトは” “。

  • **end** (str, optional) – 出力の最後に書き込む文字。デフォルトは“\n”。

  • **file** (IO[str], optional) – 書き込むファイル、またはstdoutの場合はNone。デフォルトはNone。

  • **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)[source]

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でエンコードできない値を、JSONでエンコードできる値に変換する関数。デフォルトはNone。

  • sort_keys (bool, optional) – 辞書のキーをソートします。デフォルトはFalse。

戻り値の型

None

rich.reconfigure(*args, **kwargs)[source]

グローバルコンソールを別のコンソールに置き換えることで再構成します。

パラメータ

  • *args (Any) – 置換するConsoleのための位置引数。

  • **kwargs (Any) – 置換するConsoleのためのキーワード引数。

戻り値の型

None