rich.status

class rich.status.Status(status, *, console=None, spinner='dots', spinner_style='status.spinner', speed=1.0, refresh_per_second=12.5)[ソース]

「スピナー」アニメーション付きのステータスインジケーターを表示します。

パラメータ
  • status (RenderableType) – ステータスレンダリング可能オブジェクト(通常はstrまたはText)。

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

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

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

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

  • refresh_per_second (float, オプション) – 1秒あたりのリフレッシュ回数。デフォルトは12.5です。

property console: Console

Statusオブジェクトで使用されるコンソールを取得します。

start()[ソース]

ステータスアニメーションを開始します。

戻り値の型

なし

stop()[ソース]

スピナーアニメーションを停止します。

戻り値の型

なし

update(status=None, *, spinner=None, spinner_style=None, speed=None)[ソース]

ステータスを更新します。

パラメータ
  • status (Optional[RenderableType], オプション) – 新しいステータスレンダリング可能オブジェクト、変更なしの場合はNone。デフォルトはNoneです。

  • spinner (Optional[str], オプション) – 新しいスピナー、変更なしの場合はNone。デフォルトはNoneです。

  • spinner_style (Optional[StyleType], オプション) – 新しいスピナースタイル、変更なしの場合はNone。デフォルトはNoneです。

  • **speed** (*Optional*[*float*]*, * optional*) – スピナーアニメーションの速度係数、変更なしの場合はNone。デフォルトはNoneです。

戻り値の型

なし