rich.console

class rich.console.Capture(console)[source]

コンソールへの出力結果をキャプチャするためのコンテキストマネージャーです。capture() を参照して使用方法を確認してください。

パラメータ

console (Console) – 出力をキャプチャするコンソールインスタンス。

get()[source]

キャプチャの結果を取得します。

戻り値の型

str

exception rich.console.CaptureError[source]

Captureコンテキストマネージャーのエラー。

class rich.console.Console(*, color_system='auto', force_terminal=None, force_jupyter=None, force_interactive=None, soft_wrap=False, theme=None, stderr=False, file=None, quiet=False, width=None, height=None, style=None, no_color=None, tab_size=8, record=False, markup=True, emoji=True, emoji_variant=None, highlight=True, log_time=True, log_path=True, log_time_format='[%X]', highlighter=<rich.highlighter.ReprHighlighter object>, legacy_windows=None, safe_box=True, get_datetime=None, get_time=None, _environ=None)[source]

高レベルのコンソールインターフェース。

パラメータ

  • color_system (str, optional) – ターミナルでサポートされるカラーシステム。"standard"、"256"、または"truecolor"のいずれか。自動検出するには"auto"のままにしてください。

  • force_terminal (Optional[bool], optional) – ターミナル制御コードを有効/無効にするか、ターミナルを自動検出するにはNoneを指定します。デフォルトはNoneです。

  • force_jupyter (Optional[bool], optional) – Jupyterレンダリングを有効/無効にするか、Jupyterを自動検出するにはNoneを指定します。デフォルトはNoneです。

  • force_interactive (Optional[bool], optional) – 対話モードを有効/無効にするか、自動検出するにはNoneを指定します。デフォルトはNoneです。

  • soft_wrap (Optional[bool], optional) – printメソッドでソフトラップをデフォルトで設定します。デフォルトはFalseです。

  • theme (Theme, optional) – オプションのスタイルテーマオブジェクト、またはデフォルトテーマにはNone。

  • stderr (bool, optional) – fileが指定されていない場合、stdoutではなくstderrを使用します。デフォルトはFalseです。

  • file (IO, optional) – コンソールが書き込むファイルオブジェクト。デフォルトはstdoutです。

  • quiet (bool, Optional) – すべての出力を抑制するブール値。デフォルトはFalseです。

  • width (int, optional) – ターミナルの幅。幅を自動検出するにはデフォルトのままにしてください。

  • height (int, optional) – ターミナルの高さ。高さを自動検出するにはデフォルトのままにしてください。

  • style (StyleType, optional) – すべての出力に適用するスタイル、またはスタイルなしの場合はNone。デフォルトはNoneです。

  • no_color (Optional[bool], optional) – 無彩色モードを有効にするか、自動検出するにはNoneを指定します。デフォルトはNoneです。

  • tab_size (int, optional) – タブ文字を置き換えるために使用されるスペースの数。デフォルトは8です。

  • record (bool, optional) – ターミナル出力を記録するかどうかを指定するブール値。export_html()、export_svg()、およびexport_text()を呼び出すには必要です。デフォルトはFalseです。

  • markup (bool, optional) – Console マークアップを有効にするブール値。デフォルトはTrueです。

  • emoji (bool, optional) – 絵文字コードを有効にします。デフォルトはTrueです。

  • emoji_variant (str, optional) – オプションの絵文字バリアント。「text」または「emoji」のいずれか。デフォルトはNoneです。

  • highlight (bool, optional) – 自動ハイライトを有効にします。デフォルトはTrueです。

  • log_time (bool, optional) – log()メソッドによる時間のログ記録を有効にするブール値。デフォルトはTrueです。

  • log_path (bool, optional) – log()による呼び出し元のログ記録を有効にするブール値。デフォルトはTrueです。

  • log_time_format (Union[str, TimeFormatterCallable], optional) – log_timeが有効になっている場合、strftime用の文字列、または時間をフォーマットする呼び出し可能オブジェクト。デフォルトは“[%X]”です。

  • highlighter (HighlighterType, optional) – デフォルトのハイライター。

  • legacy_windows (bool, optional) – 従来のWindowsモードを有効にするか、自動検出するにはNoneを指定します。デフォルトはNoneです。

  • safe_box (bool, optional) – 従来のWindowsではレンダリングされないボックスオプションを制限します。

  • get_datetime (Callable[[], datetime], optional) – 現在の時刻をdatetime.datetimeオブジェクトとして取得する呼び出し可能オブジェクト（Console.logで使用）、またはdatetime.nowにはNone。

  • get_time (Callable[[], time], optional) – 秒単位の現在時刻を取得する呼び出し可能オブジェクト。デフォルトではtime.monotonicを使用します。

  • _environ (Mapping[str, str]) –

begin_capture()[source]

コンソール出力のキャプチャを開始します。キャプチャモードを終了し、出力を返すには、end_capture() を呼び出してください。

戻り値の型

なし

bell()[source]

(ターミナルでサポートされている場合)「ベル」音を鳴らします。

戻り値の型

なし

capture()[source]

コンソールに書き込むのではなく、print()またはlog()の結果を文字列として*キャプチャ*するコンテキストマネージャーです。

例

>>> from rich.console import Console
>>> console = Console()
>>> with console.capture() as capture:
...     console.print("[bold magenta]Hello World[/]")
>>> print(capture.get())
戻り値

ターミナルへの書き込みを無効にするコンテキストマネージャー。

戻り値の型

キャプチャ

clear(home=True)[source]

画面をクリアします。

パラメータ

home (bool, オプション) – カーソルを「ホーム」位置にも移動します。デフォルトはTrueです。

戻り値の型

なし

clear_live()[source]

Liveインスタンスをクリアします。

戻り値の型

なし

property color_system: Optional[str]

カラーシステム文字列を取得します。

戻り値

「standard」、「256」、または「truecolor」。

戻り値の型

Optional[str]

control(*control)[source]

非表示の制御コードを挿入します。

パラメータ

  • control_codes (str) – カーソルを移動するなど、制御コード。

  • control (Control) –

戻り値の型

なし

property encoding: str

コンソールファイルのエンコードを取得します (例: "utf-8")。

戻り値

標準的なエンコーディング文字列。

戻り値の型

str

end_capture()[source]

キャプチャモードを終了し、キャプチャされた文字列を返します。

戻り値

コンソール出力。

戻り値の型

str

export_html(*, theme=None, clear=True, code_format=None, inline_styles=False)[source]

コンソールの内容からHTMLを生成します (コンストラクタでrecord=True引数が必要です)。

パラメータ

  • theme (TerminalTheme, オプション) – コンソールの色を含むTerminalThemeオブジェクト。

  • clear (bool, オプション) – エクスポート後に記録バッファをクリアします。デフォルトはTrueです。

  • code_format (str, オプション) – HTMLをレンダリングするためのフォーマット文字列。 ' {foreground} '、' {background} '、および' {code} 'に加えて、inline_stylesがFalseの場合は' {stylesheet} 'を含める必要があります。

  • inline_styles (bool, オプション) – Trueの場合、スタイルはspanにインラインされます。これによりファイルサイズは大きくなりますが、マークアップの切り取りと貼り付けが容易になります。Falseの場合、スタイルはstyleタグに埋め込まれます。デフォルトはFalseです。

戻り値

コンソールの内容をHTMLとして含む文字列。

戻り値の型

str

export_svg(*, title='Rich', theme=None, clear=True, code_format='<svg class="rich-terminal" viewBox="0 0 {width} {height}" xmlns="http://www.w3.org/2000/svg">\n    <!-- Generated with Rich https://www.textualize.io -->\n    <style>\n\n    @font-face {{\n        font-family: "Fira Code";\n        src: local("FiraCode-Regular"),\n                url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"),\n                url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff");\n        font-style: normal;\n        font-weight: 400;\n    }}\n    @font-face {{\n        font-family: "Fira Code";\n        src: local("FiraCode-Bold"),\n                url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"),\n                url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff");\n        font-style: bold;\n        font-weight: 700;\n    }}\n\n    .{unique_id}-matrix {{\n        font-family: Fira Code, monospace;\n        font-size: {char_height}px;\n        line-height: {line_height}px;\n        font-variant-east-asian: full-width;\n    }}\n\n    .{unique_id}-title {{\n        font-size: 18px;\n        font-weight: bold;\n        font-family: arial;\n    }}\n\n    {styles}\n    </style>\n\n    <defs>\n    <clipPath id="{unique_id}-clip-terminal">\n      <rect x="0" y="0" width="{terminal_width}" height="{terminal_height}" />\n    </clipPath>\n    {lines}\n    </defs>\n\n    {chrome}\n    <g transform="translate({terminal_x}, {terminal_y})" clip-path="url(#{unique_id}-clip-terminal)">\n    {backgrounds}\n    <g class="{unique_id}-matrix">\n    {matrix}\n    </g>\n    </g>\n</svg>\n', font_aspect_ratio=0.61, unique_id=None)[source]

コンソールの内容からSVGを生成します (Consoleコンストラクタでrecord=Trueが必要です)。

パラメータ

  • title (str, オプション) – 出力画像のタブのタイトル。

  • theme (TerminalTheme, オプション) – ターミナルのスタイル設定に使用するTerminalThemeオブジェクト。

  • clear (bool, オプション) – エクスポート後に記録バッファをクリアします。デフォルトはTrueです。

  • code_format ( str, optional) – SVGを生成するために使用されるフォーマット文字列。Richは最終的なSVG出力を作成するために、いくつかの変数をこの文字列に挿入します。console.CONSOLE_SVG_FORMAT変数を検査することで、使用されるデフォルトテンプレートとRichによって挿入される変数を確認できます。

  • font_aspect_ratio ( float, optional) – code_format文字列で使用されるフォントの幅と高さの比率。デフォルトは0.61で、これはFira Code（デフォルトフォント）の幅と高さの比率です。code_format内で異なるフォントを指定していない場合は、おそらくこれは必要ありません。

  • unique_id ( str, optional) – さまざまな要素（CSSスタイル、ノードID）のプレフィックスとして使用される一意のID。設定されていない場合、記録されたコンテンツに基づいて計算された値がデフォルトになります。

戻り値の型

str

export_text(*, clear=True, styles=False)[source]

コンソールの内容からテキストを生成します（コンストラクタでrecord=True引数が必要です）。

パラメータ

  • clear (bool, オプション) – エクスポート後に記録バッファをクリアします。デフォルトはTrueです。

  • styles ( bool, optional) – Trueの場合、ANSIエスケープコードが含まれます。Falseの場合、プレーンテキストになります。デフォルトはFalseです。

戻り値

コンソールの内容を含む文字列。

戻り値の型

str

property file: IO[str]

書き込み先のファイルオブジェクトを取得します。

get_style(name, *, default=None)[source]

テーマ名でStyleインスタンスを取得するか、定義を解析します。

パラメータ
戻り値

Styleオブジェクト。

戻り値の型

スタイル

例外発生

MissingStyle – nameからスタイルを解析できなかった場合。

property height: int

コンソールの高さを取得します。

戻り値

コンソールの高さ（行数）。

戻り値の型

int

input(prompt='', *, markup=True, emoji=True, password=False, stream=None)[source]

プロンプトを表示し、ユーザーからの入力を待ちます。プロンプトには色/スタイルを含めることができます。

Pythonの組み込みinput()関数と同じように動作し、Pythonの組み込みreadlineモジュールが事前にロードされている場合は、詳細な行編集と履歴機能を提供します。

パラメータ

  • prompt (Union[str, Text]) – プロンプトに表示するテキスト。

  • markup ( bool, optional) – コンソールマークアップを有効にします（strプロンプトが必要です）。デフォルトはTrueです。

  • emoji ( bool, optional) – 絵文字を有効にします（strプロンプトが必要です）。デフォルトはTrueです。

  • password ( bool) – (bool, optional): 入力されたテキストを非表示にします。デフォルトはFalseです。

  • stream ( Optional[TextIO]) – (TextIO, optional): 入力を読み取るファイル（stdinではなく）。デフォルトはNoneです。

戻り値

stdinから読み取られたテキスト。

戻り値の型

str

property is_alt_screen: bool

代替画面が有効になっているかどうかを確認します。

戻り値

代替画面が有効になっている場合はTrue、それ以外の場合はFalse。

戻り値の型

bool

property is_dumb_terminal: bool

ダミーターミナルを検出します。

戻り値

ダミーターミナルに書き込んでいる場合はTrue、それ以外の場合はFalse。

戻り値の型

bool

property is_terminal: bool

コンソールがターミナルに書き込んでいるかどうかを確認します。

戻り値

コンソールがターミナルコードを理解できるデバイスに書き込んでいる場合はTrue、それ以外の場合はFalse。

戻り値の型

bool

line(count=1)[source]

改行を書き込みます。

パラメータ

count ( int, optional) – 改行の数。デフォルトは1です。

戻り値の型

なし

log(*objects, sep=' ', end='\n', style=None, justify=None, emoji=None, markup=None, highlight=None, log_locals=False, _stack_offset=1)[source]

リッチコンテンツをターミナルにログ出力します。

パラメータ

  • objects (positional args) – ターミナルにログ出力するオブジェクト。

  • sep ( str, optional) – プリントデータ間に書き込む文字列。デフォルトは「 」です。

  • end ( str, optional) – プリントデータの最後に書き込む文字列。デフォルトは「\n」です。

  • style (Union[str, Style], optional) – 出力に適用するスタイル。デフォルトはNone。

  • justify (str, optional) – “left”, “right”, “center”, または “full” のいずれか。デフォルトはNone。

  • emoji (Optional[bool], optional) – 絵文字コードを有効にするか、コンソールのデフォルトを使用するにはNone。デフォルトはNone。

  • markup (Optional[bool], optional) – マークアップを有効にするか、コンソールのデフォルトを使用するにはNone。デフォルトはNone。

  • highlight (Optional[bool], optional) – 自動ハイライトを有効にするか、コンソールのデフォルトを使用するにはNone。デフォルトはNone。

  • log_locals (bool, optional) – log() が呼び出された場所でローカル変数のログを有効にするためのブール値。デフォルトはFalse。

  • _stack_offset (int, optional) – コールスタックの末尾からの呼び出し元のオフセット。デフォルトは1。

戻り値の型

なし

measure(renderable, *, options=None)[source]

レンダラブルを測定します。Measurement オブジェクトを返します。このオブジェクトには、レンダラブルの表示に必要な文字数に関する情報が含まれています。

パラメータ

  • renderable (RenderableType) – 任意のレンダラブルまたは文字列。

  • options (Optional[ConsoleOptions], optional) – 測定時に使用するオプション。デフォルトオプションを使用するにはNone。デフォルトはNone。

戻り値

レンダラブルの測定値。

戻り値の型

Measurement

property options: ConsoleOptions

デフォルトのコンソールオプションを取得します。

out(*objects, sep=' ', end='\n', style=None, highlight=None)[source]

ターミナルに出力します。これはターミナルへの低レベルな書き込み方法であり、print() とは異なり、テキストの整形表示、折り返し、マークアップの適用は行いませんが、ハイライトと基本的なスタイルをオプションで適用します。

パラメータ

  • sep ( str, optional) – プリントデータ間に書き込む文字列。デフォルトは「 」です。

  • end ( str, optional) – プリントデータの最後に書き込む文字列。デフォルトは「\n」です。

  • style (Union[str, Style], optional) – 出力に適用するスタイル。デフォルトはNone。

  • highlight (Optional[bool], optional) – 自動ハイライトを有効にするか、コンソールのデフォルトを使用するにはNone。デフォルトはNone。

  • objects (Any) –

戻り値の型

なし

pager(pager=None, styles=False, links=False)[source]

「ページャ」内で表示されるものを表示するためのコンテキストマネージャ。ページャアプリケーションはシステムによって定義され、通常は少なくともキーを押してスクロールできます。

パラメータ

  • pager (Pager, optional) – ページャオブジェクト、またはSystemPager を使用する場合はNone。デフォルトはNone。

  • styles (bool, optional) – ページャにスタイルを表示する。デフォルトはFalse。

  • links (bool, optional) – ページャにリンクを表示する。デフォルトはFalse。

戻り値の型

PagerContext

例

>>> from rich.console import Console
>>> from rich.__main__ import make_test_card
>>> console = Console()
>>> with console.pager():
        console.print(make_test_card())
戻り値

コンテキストマネージャ。

戻り値の型

PagerContext

パラメータ
pop_render_hook()[source]

スタックから最後のrenderhookをポップします。

戻り値の型

なし

pop_theme()[source]

スタックの一番上のテーマを削除し、前のテーマを復元します。

戻り値の型

なし

print(*objects, sep=' ', end='\n', style=None, justify=None, overflow=None, no_wrap=None, emoji=None, markup=None, highlight=None, width=None, height=None, crop=True, soft_wrap=None, new_line_start=False)[source]

コンソールに出力します。

パラメータ

  • objects (positional args) – ターミナルにログ出力するオブジェクト。

  • sep ( str, optional) – プリントデータ間に書き込む文字列。デフォルトは「 」です。

  • end ( str, optional) – プリントデータの最後に書き込む文字列。デフォルトは「\n」です。

  • style (Union[str, Style], optional) – 出力に適用するスタイル。デフォルトはNone。

  • justify (str, optional) – 整形方法: “default”, “left”, “right”, “center”, または “full”。デフォルトはNone。

  • overflow (str, optional) – オーバーフロー方法: “ignore”, “crop”, “fold”, または “ellipsis”。デフォルトはNone。

  • no_wrap (Optional[bool], optional) – ワードラップを無効にする。デフォルトはNone。

  • emoji (Optional[bool], optional) – 絵文字コードを有効にするか、コンソールのデフォルトを使用するにはNone。デフォルトはNone。

  • markup (オプション[bool], オプション) – マークアップを有効化するか、コンソールのデフォルトを使用するにはNone を使用します。デフォルトはNoneです。

  • highlight (Optional[bool], optional) – 自動ハイライトを有効にするか、コンソールのデフォルトを使用するにはNone。デフォルトはNone。

  • width (オプション[int], オプション) – 出力の幅、または自動検出するにはNone を使用します。デフォルトはNoneです。

  • crop (オプション[bool], オプション) – 出力をターミナルの幅に切り取ります。デフォルトはTrueです。

  • soft_wrap (bool, オプション) – ワードラップとテキストの切り取りを無効にするソフトラップモードを有効化するか、コンソールのデフォルトにはNone を使用します。デフォルトはNoneです。

  • new_line_start (bool, False) – 出力が複数行を含む場合、先頭に改行を挿入します。デフォルトはFalseです。

  • height (オプション[int]) –

戻り値の型

なし

print_exception(*, width=100, extra_lines=3, theme=None, word_wrap=False, show_locals=False, suppress=(), max_frames=100)[source]

直近の例外とトレースバックの豊富なレンダリングを出力します。

パラメータ

  • width (オプション[int], オプション) – コードをレンダリングするために使用する文字数。デフォルトは100です。

  • extra_lines (int, オプション) – レンダリングする追加のコード行数。デフォルトは3です。

  • theme (str, オプション) – トレースバックで使用されるPygmentsテーマをオーバーライドします。

  • word_wrap (bool, オプション) – 長い行のワードラップを有効にします。デフォルトはFalseです。

  • show_locals (bool, オプション) – ローカル変数の表示を有効にします。デフォルトはFalseです。

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

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

戻り値の型

なし

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 (Union[None, int, str], オプション) – インデントするスペースの数。デフォルトは2です。

  • highlight (bool, オプション) – 出力のハイライトを有効にします。デフォルトはTrueです。

  • skip_keys (bool, オプション) – 基本的な型以外のキーをスキップします。デフォルトはFalseです。

  • ensure_ascii (bool, オプション) – すべての非ASCII文字をエスケープします。デフォルトはFalseです。

  • check_circular (bool, オプション) – 循環参照をチェックします。デフォルトはTrueです。

  • allow_nan (bool, オプション) – NaNとInfinityの値を許可します。デフォルトはTrueです。

  • default (Callable, オプション) – エンコードできない値をJSONエンコード可能なものに変換する呼び出し可能オブジェクト。デフォルトはNoneです。

  • sort_keys (bool, オプション) – 辞書のキーをソートします。デフォルトはFalseです。

戻り値の型

なし

push_render_hook(hook)[source]

スタックに新しいレンダリングフックを追加します。

パラメータ

hook (RenderHook) – RenderHookインスタンス。

戻り値の型

なし

push_theme(theme, *, inherit=True)[source]

スタックの一番上に新しいテーマをプッシュし、前のテーマのスタイルを置き換えます。一般的に、このメソッドを直接呼び出すのではなく、use_theme() を使用してコンテキストマネージャーを取得する必要があります。

パラメータ

  • theme (Theme) – テーマインスタンス。

  • inherit (bool, オプション) – 既存のスタイルを継承します。デフォルトはTrueです。

戻り値の型

なし

render(renderable, options=None)[source]

オブジェクトをSegmentインスタンスのイテラブルにレンダリングします。

このメソッドには、コンソールプロトコルを使用してオブジェクトをレンダリングするためのロジックが含まれています。ライブラリを拡張する場合を除き、直接使用することはほとんどありません。

パラメータ

  • renderable (RenderableType) – コンソールプロトコルをサポートするオブジェクト、または文字列に変換できるオブジェクト。

  • options (ConsoleOptions, オプション) – オプションオブジェクト、またはself.optionsを使用するにはNone。デフォルトはNoneです。

戻り値

レンダリングできるセグメントのイテラブル。

戻り値の型

Iterable[Segment]

render_lines(renderable, options=None, *, style=None, pad=True, new_lines=False)[source]

オブジェクトを行のリストにレンダリングします。

render_linesの出力は、レンダリングされたコンソールテキストのさらなるフォーマットが必要な場合（たとえば、レンダリング可能なオブジェクトの周りにボーダーを描画するPanelクラスなど）に役立ちます。

引数

renderable (RenderableType): コンソールでレンダリング可能な任意のオブジェクト。 options (Optional[ConsoleOptions], optional): コンソールオプション、または self.options を使用する場合は None。デフォルトはNone。 style (Style, optional): レンダリング可能なオブジェクトに適用するオプションのスタイル。デフォルトはNone。 pad (bool, optional): レンダリング幅より短い行をパディングするかどうか。デフォルトはTrue。 new_lines (bool, optional): 行の最後に“

”文字を含めるかどうか。

戻り値

List[List[Segment]]: 行のリスト。各行は Segment オブジェクトのリストです。

パラメータ
戻り値の型

List[List[Segment]]

render_str(text, *, style='', justify=None, overflow=None, emoji=None, markup=None, highlight=None, highlighter=None)[source]

文字列を Text インスタンスに変換します。文字列を出力またはログ出力する場合、自動的に呼び出されます。

パラメータ

  • text (str) – レンダリングするテキスト。

  • style (Union[str, Style], optional) – レンダリングされたテキストに適用するスタイル。

  • justify (str, optional) – ジャスティファイの方法："default"、"left"、"center"、"full"、または "right"。デフォルトはNone。

  • overflow (str, optional) – オーバーフローの方法："crop"、"fold"、または "ellipsis"。デフォルトはNone。

  • emoji (Optional[bool], optional) – 絵文字を有効にするか、Console のデフォルトを使用する場合はNone。

  • markup (Optional[bool], optional) – マークアップを有効にするか、Console のデフォルトを使用する場合はNone。

  • highlight (Optional[bool], optional) – ハイライトを有効にするか、Console のデフォルトを使用する場合はNone。

  • highlighter (HighlighterType, optional) – 適用するオプションのハイライター。

戻り値

レンダリング可能なオブジェクト。

戻り値の型

ConsoleRenderable

rule(title='', *, characters='─', style='rule.line', align='center')[source]

オプションで中央揃えのタイトル付きの線を引きます。

パラメータ

  • title (str, optional) – ルールの上にレンダリングするテキスト。デフォルトは ""。

  • characters (str, optional) – 線を形成する文字。デフォルトは "─"。

  • style (str, optional) – 線のスタイル。デフォルトは "rule.line"。

  • align (str, optional) – タイトルの揃え方。"left"、"center"、または "right" のいずれか。デフォルトは "center"。

戻り値の型

なし

save_html(path, *, theme=None, clear=True, code_format='<!DOCTYPE html>\n<html>\n<head>\n<meta charset="UTF-8">\n<style>\n{stylesheet}\nbody {{\n    color: {foreground};\n    background-color: {background};\n}}\n</style>\n</head>\n<body>\n    <pre style="font-family:Menlo,\'DejaVu Sans Mono\',consolas,\'Courier New\',monospace"><code>{code}</code></pre>\n</body>\n</html>\n', inline_styles=False)[source]

コンソールの内容から HTML を生成し、ファイルに書き込みます（コンストラクタで record=True 引数が必要です）。

パラメータ

  • path (str) – html ファイルを書き込むパス。

  • theme (TerminalTheme, オプション) – コンソールの色を含むTerminalThemeオブジェクト。

  • clear (bool, オプション) – エクスポート後に記録バッファをクリアします。デフォルトはTrueです。

  • code_format (str, オプション) – HTMLをレンダリングするためのフォーマット文字列。 ' {foreground} '、' {background} '、および' {code} 'に加えて、inline_stylesがFalseの場合は' {stylesheet} 'を含める必要があります。

  • inline_styles (bool, オプション) – Trueの場合、スタイルはspanにインラインされます。これによりファイルサイズは大きくなりますが、マークアップの切り取りと貼り付けが容易になります。Falseの場合、スタイルはstyleタグに埋め込まれます。デフォルトはFalseです。

戻り値の型

なし

save_svg(path, *, title='Rich', theme=None, clear=True, code_format='<svg class="rich-terminal" viewBox="0 0 {width} {height}" xmlns="http://www.w3.org/2000/svg">\n    <!-- Generated with Rich https://www.textualize.io -->\n    <style>\n\n    @font-face {{\n        font-family: "Fira Code";\n        src: local("FiraCode-Regular"),\n                url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"),\n                url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff");\n        font-style: normal;\n        font-weight: 400;\n    }}\n    @font-face {{\n        font-family: "Fira Code";\n        src: local("FiraCode-Bold"),\n                url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"),\n                url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff");\n        font-style: bold;\n        font-weight: 700;\n    }}\n\n    .{unique_id}-matrix {{\n        font-family: Fira Code, monospace;\n        font-size: {char_height}px;\n        line-height: {line_height}px;\n        font-variant-east-asian: full-width;\n    }}\n\n    .{unique_id}-title {{\n        font-size: 18px;\n        font-weight: bold;\n        font-family: arial;\n    }}\n\n    {styles}\n    </style>\n\n    <defs>\n    <clipPath id="{unique_id}-clip-terminal">\n      <rect x="0" y="0" width="{terminal_width}" height="{terminal_height}" />\n    </clipPath>\n    {lines}\n    </defs>\n\n    {chrome}\n    <g transform="translate({terminal_x}, {terminal_y})" clip-path="url(#{unique_id}-clip-terminal)">\n    {backgrounds}\n    <g class="{unique_id}-matrix">\n    {matrix}\n    </g>\n    </g>\n</svg>\n', font_aspect_ratio=0.61, unique_id=None)[source]

コンソールの内容からSVGファイルを生成します（Consoleコンストラクタでrecord=Trueが必要です）。

パラメータ

  • path (str) – SVGを書き込むパス。

  • title (str, オプション) – 出力画像のタブのタイトル。

  • theme (TerminalTheme, オプション) – ターミナルのスタイル設定に使用するTerminalThemeオブジェクト。

  • clear (bool, オプション) – エクスポート後に記録バッファをクリアします。デフォルトはTrueです。

  • code_format ( str, optional) – SVGを生成するために使用されるフォーマット文字列。Richは最終的なSVG出力を作成するために、いくつかの変数をこの文字列に挿入します。console.CONSOLE_SVG_FORMAT変数を検査することで、使用されるデフォルトテンプレートとRichによって挿入される変数を確認できます。

  • font_aspect_ratio ( float, optional) – code_format文字列で使用されるフォントの幅と高さの比率。デフォルトは0.61で、これはFira Code（デフォルトフォント）の幅と高さの比率です。code_format内で異なるフォントを指定していない場合は、おそらくこれは必要ありません。

  • unique_id ( str, optional) – さまざまな要素（CSSスタイル、ノードID）のプレフィックスとして使用される一意のID。設定されていない場合、記録されたコンテンツに基づいて計算された値がデフォルトになります。

戻り値の型

なし

save_text(path, *, clear=True, styles=False)[source]

コンソールからテキストを生成し、指定された場所に保存します（コンストラクタでrecord=True引数が必要です）。

パラメータ

  • path (str) – テキストファイルを書き込むパス。

  • clear (bool, オプション) – エクスポート後に記録バッファをクリアします。デフォルトはTrueです。

  • styles (bool, optional) – Trueの場合、ANSIスタイルコードが含まれます。Falseの場合はプレーンテキストになります。デフォルトはFalseです。

戻り値の型

なし

screen(hide_cursor=True, style=None)[source]

「代替スクリーン」モードを有効化および無効化するコンテキストマネージャー。

パラメータ

  • hide_cursor (bool, optional) – カーソルも非表示にします。デフォルトはFalse。

  • style (Style, optional) – 画面のオプションスタイル。デフォルトはNone。

戻り値

実行時に代替スクリーンを有効化し、終了時に無効化するコンテキスト。

戻り値の型

~ScreenContext

set_alt_screen(enable=True)[source]

代替スクリーンモードを有効にします。

このモードを有効にした場合は、アプリケーションの終了前に無効にする必要があります。screen() を参照してください。これはコンテキストマネージャーで処理されます。

パラメータ

enable (bool, optional) – 代替スクリーンを有効化（True）または無効化（False）します。デフォルトはTrue。

戻り値

制御コードが書き込まれた場合はTrue。

戻り値の型

bool

set_live(live)[source]

Liveインスタンスを設定します。Liveコンテキストマネージャーで使用されます。

パラメータ

live (Live) – このConsoleを使用するLiveインスタンス。

例外発生

errors.LiveError – このConsoleに現在Liveコンテキストがアクティブな場合。

戻り値の型

なし

set_window_title(title)[source]

コンソールターミナルウィンドウのタイトルを設定します。

警告：Richにはウィンドウタイトルを以前の値に「リセット」する手段がないため、設定したタイトルはアプリケーションの終了後も保持されます。

fish シェルは、デフォルトで各コマンドの前後にウィンドウタイトルをリセットするため、この問題は発生しません。Windowsターミナルとコマンドプロンプトもタイトルをリセットします。ただし、ほとんどの他のシェルとターミナルではこれは行われません。

一部のターミナルでは、タイトルを設定する前に設定の変更が必要になる場合があります。一部のターミナルでは、タイトルの設定自体がサポートされていない場合があります。

他のソフトウェア（ターミナル自体、シェル、カスタムプロンプト、プラグインなど）もターミナルウィンドウのタイトルを設定する場合があります。これにより、このメソッドを使用して書き込んだ値が上書きされる可能性があります。

パラメータ

title (str) – ターミナルウィンドウの新しいタイトル。

戻り値

ターミナルタイトルを変更する制御コードが書き込まれた場合はTrue、そうでない場合はFalse。Trueを返しても、ウィンドウタイトルが実際に変更されたことが保証されるわけではありません。一部のターミナルでは、この機能がサポートされていない/無効になっている可能性があるためです。

written, otherwise False. Note that a return value of True does not guarantee that the window title has actually changed, since the feature may be unsupported/disabled in some terminals.

戻り値の型

bool

show_cursor(show=True)[source]

カーソルを表示または非表示にします。

パラメータ

show (bool, optional) – カーソルの表示状態を設定します。

戻り値の型

bool

property size: ConsoleDimensions

コンソールのサイズを取得します。

戻り値

寸法を含む名前付きタプル。

戻り値の型

ConsoleDimensions

status(status, *, spinner='dots', spinner_style='status.spinner', speed=1.0, refresh_per_second=12.5)[source]

ステータスとスピナーを表示します。

パラメータ

  • status (RenderableType) – ステータスレンダラブル（通常はstrまたはText）。

  • spinner (str, optional) – スピンアニメーションの名前（python -m rich.spinnerを参照）。デフォルトは「dots」。

  • spinner_style (StyleType, オプション) – スピナーのスタイル。デフォルトは "status.spinner"。

  • speed (float, オプション) – スピナーアニメーションの速度係数。デフォルトは 1.0。

  • refresh_per_second (float, オプション) – 1秒あたりの更新回数。デフォルトは 12.5。

戻り値

コンテキストマネージャーとして使用できる Status オブジェクト。

戻り値の型

Status

update_screen(renderable, *, region=None, options=None)[source]

指定されたオフセットで画面を更新します。

パラメータ

  • renderable (RenderableType) – Richでレンダリング可能なオブジェクト。

  • region (Region, オプション) – 更新する画面領域、または画面全体を指定する場合はNone。デフォルトはNone。

  • x (int, オプション) – xオフセット。デフォルトは0。

  • y (int, オプション) – yオフセット。デフォルトは0。

  • options (Optional[ConsoleOptions]) –

例外発生

errors.NoAltScreen – コンソールが代替画面モードでない場合。

戻り値の型

なし

update_screen_lines(lines, x=0, y=0)[source]

指定されたオフセットで画面の行を更新します。

パラメータ

  • lines (List[List[Segment]]) – レンダリングされた行（render_lines()によって生成されたもの）。

  • x (int, オプション) – xオフセット（列番号）。デフォルトは0。

  • y (int, オプション) – yオフセット（行番号）。デフォルトは0。

例外発生

errors.NoAltScreen – コンソールが代替画面モードでない場合。

戻り値の型

なし

use_theme(theme, *, inherit=True)[source]

コンテキストマネージャーの期間中、異なるテーマを使用します。

パラメータ

  • theme (Theme) – 使用するテーマインスタンス。

  • inherit (bool, オプション) – 既存のコンソールスタイルを継承します。デフォルトはTrue。

戻り値

[説明]

戻り値の型

ThemeContext

property width: int

コンソールの幅を取得します。

戻り値

コンソールの幅（文字数）。

戻り値の型

int

class rich.console.ConsoleDimensions(width, height)[source]

ターミナルのサイズ。

パラメータ

  • width (int) –

  • height (int) –

property height

コンソールの高さ（行数）。

property width

コンソールの幅（セル数）。

class rich.console.ConsoleOptions(size, legacy_windows, min_width, max_width, is_terminal, encoding, max_height, justify=None, overflow=None, no_wrap=False, highlight=None, markup=None, height=None)[source]

__rich_console__メソッドのオプション。

パラメータ
property ascii_only: bool

レンダリング可能オブジェクトがASCIIのみを使用する必要があるかどうかをチェックします。

copy()[source]

オプションのコピーを返します。

戻り値

selfのコピー。

戻り値の型

ConsoleOptions

encoding: str

ターミナルのエンコーディング。

highlight: Optional[bool] = None

render_strのハイライト上書き。

is_terminal: bool

ターゲットがターミナルの場合はTrue、それ以外の場合はFalse。

justify: Optional[typing_extensions.Literal[default, left, center, right, full]] = None

レンダリング対象のジャスティファイ値の上書き。

legacy_windows: bool

レガシーWindows用のフラグ。

型

legacy_windows

markup: Optional[bool] = None

文字列のレンダリング時にマークアップを有効にする。

max_height: int

コンテナの高さ（最初はターミナルサイズ）。

max_width: int

レンダリング対象の最大幅。

min_width: int

レンダリング対象の最小幅。

no_wrap: Optional[bool] = False

テキストの折り返しを無効にする。

overflow: Optional[typing_extensions.Literal[fold, crop, ellipsis, ignore]] = None

レンダリング対象のオーバーフロー値の上書き。

reset_height()[source]

高さを`None`に設定したオプションのコピーを返します。

戻り値

新しいコンソールオプションインスタンス。

戻り値の型

~ConsoleOptions

size: ConsoleDimensions

コンソールのサイズ。

update(*, width=<rich.console.NoChange object>, min_width=<rich.console.NoChange object>, max_width=<rich.console.NoChange object>, justify=<rich.console.NoChange object>, overflow=<rich.console.NoChange object>, no_wrap=<rich.console.NoChange object>, highlight=<rich.console.NoChange object>, markup=<rich.console.NoChange object>, height=<rich.console.NoChange object>)[source]

値を更新し、コピーを返します。

パラメータ

  • **width** (Union[int, NoChange]) –

  • **min_width** (Union[int, NoChange]) –

  • **max_width** (Union[int, NoChange]) –

  • **justify** (Union[typing_extensions.Literal[default, left, center, right, full], None, NoChange]) –

  • **overflow** (Union[typing_extensions.Literal[fold, crop, ellipsis, ignore], None, NoChange]) –

  • **no_wrap** (Union[bool, None, NoChange]) –

  • **highlight** (Union[bool, None, NoChange]) –

  • **markup** (Union[bool, None, NoChange]) –

  • **height** (Union[int, None, NoChange]) –

戻り値の型

ConsoleOptions

update_dimensions(width, height)[source]

幅と高さを更新し、コピーを返します。

パラメータ

  • **width** (int) – 新しい幅（min_widthとmax_widthの両方を設定します）。

  • **height** (int) – 新しい高さ。

戻り値

新しいコンソールオプションインスタンス。

戻り値の型

~ConsoleOptions

update_height(height)[source]

高さを更新し、コピーを返します。

パラメータ

**height** (int) – 新しい高さ

戻り値

新しいコンソールオプションインスタンス。

戻り値の型

~ConsoleOptions

update_width(width)[source]

幅のみを更新し、コピーを返します。

パラメータ

**width** (int) – 新しい幅（min_widthとmax_widthの両方を設定します）

戻り値

新しいコンソールオプションインスタンス。

戻り値の型

~ConsoleOptions

class rich.console.ConsoleRenderable(*args, **kwds)[source]

コンソールプロトコルをサポートするオブジェクト。

class rich.console.ConsoleThreadLocals(theme_stack, buffer=<factory>, buffer_index=0)[source]

コンソールのコンテキストに対するスレッドローカル値。

パラメータ

  • theme_stack (ThemeStack) –

  • buffer (List[Segment]) –

  • buffer_index (int) –

class rich.console.Group(*renderables, fit=True)[source]

レンダラブルオブジェクトのグループを受け取り、そのグループをレンダリングするレンダラブルオブジェクトを返します。

パラメータ

  • renderables (Iterable[RenderableType]) – レンダラブルオブジェクトのイテラブル。

  • fit (bool, optional) – グループのサイズをコンテンツに合わせて調整するか、利用可能なスペースを埋めます。デフォルトはTrue。

class rich.console.NewLine(count=1)[source]

改行を生成するレンダラブルオブジェクト。

パラメータ

count (int) –

class rich.console.PagerContext(console, pager=None, styles=False, links=False)[source]

コンテンツを「ページング」するコンテキストマネージャーです。pager() を参照してください。

パラメータ
class rich.console.RenderHook[source]

レンダリングプロセスへのフックを提供します。

abstract process_renderables(renderables)[source]

レンダリングするオブジェクトのリストを引数として呼び出されます。

このメソッドは、新しいレンダラブルオブジェクトのリストを返すか、同じリストを変更して返すことができます。

パラメータ

renderables (List[ConsoleRenderable]) – いくつかのレンダラブルオブジェクト。

戻り値

レンダラブルオブジェクトの置換リスト。

戻り値の型

List[ConsoleRenderable]

rich.console.RenderableType

Richによってレンダリングできる文字列または任意のオブジェクト。

Union[ConsoleRenderable, RichCast, str]のエイリアス

class rich.console.RichCast(*args, **kwds)[source]

コンソールレンダラブルに「キャスト」できるオブジェクト。

class rich.console.ScreenContext(console, hide_cursor, style='')[source]

代替スクリーンを有効にするコンテキストマネージャーです。screen() を参照してください。

パラメータ
update(*renderables, style=None)[source]

スクリーンを更新します。

パラメータ

  • renderable (RenderableType, optional) – 現在のレンダラブルを置き換えるレンダラブル（オプション）、または変更なしの場合はNone。デフォルトはNone。

  • style (Optional[Union[str, Style]]) – (Style, optional): 置換スタイル、または変更なしの場合はNone。デフォルトはNone。

  • renderables (Union[ConsoleRenderable, RichCast, str]) –

戻り値の型

なし

class rich.console.ScreenUpdate(lines, x, y)[source]

指定されたオフセットでラインのリストをレンダリングします。

パラメータ
class rich.console.ThemeContext(console, theme, inherit=True)[source]

一時的なテーマを使用するためのコンテキストマネージャーです。使用方法については、use_theme() を参照してください。

パラメータ

  • console (Console) –

  • theme (Theme) – テーマ

  • inherit (bool) – 親テーマを継承するかどうか

rich.console.detect_legacy_windows()[source]

レガシーWindowsを検出します。

戻り値の型

bool

rich.console.group(fit=True)[source]

レンダリング可能な要素のイテラブルをグループに変換するデコレータです。

パラメータ

fit (bool, optional) – グループのサイズをコンテンツに合わせて調整するか、利用可能なスペースを埋めます。デフォルトはTrue。

戻り値の型

Callable[[…], Callable[[…], Group]]