rich.prompt

class rich.prompt.Confirm(prompt='', *, console=None, password=False, choices=None, show_default=True, show_choices=True)

はい/いいえ確認プロンプト。

例

>>> if Confirm.ask("Continue"):
        run_job()

process_response(value)

選択肢をboolに変換します。

パラメータ

value (str) –

戻り値の型

bool

render_default(default)

デフォルト値をTrue/Falseではなく(y)または(n)としてレンダリングします。

パラメータ

default (DefaultType) –

戻り値の型

テキスト

response_type

bool のエイリアス

class rich.prompt.FloatPrompt(prompt='', *, console=None, password=False, choices=None, show_default=True, show_choices=True)

浮動小数点数を受け取るプロンプト。

例

>>> temperature = FloatPrompt.ask("Enter desired temperature")

response_type

float のエイリアス

class rich.prompt.IntPrompt(prompt='', *, console=None, password=False, choices=None, show_default=True, show_choices=True)

整数を返すプロンプト。

例

>>> burrito_count = IntPrompt.ask("How many burritos do you want to order")

response_type

int のエイリアス

exception rich.prompt.InvalidResponse(message)

応答が無効であることを示す例外。エラーを示し、エラーメッセージを提供するには、process_response()内でこれを発生させます。

パラメータ

message (Union[str, Text]) – エラーメッセージ。

戻り値の型

なし

class rich.prompt.Prompt(prompt='', *, console=None, password=False, choices=None, show_default=True, show_choices=True)

strを返すプロンプト。

例

>>> name = Prompt.ask("Enter your name")

response_type

str のエイリアス

class rich.prompt.PromptBase(prompt='', *, console=None, password=False, choices=None, show_default=True, show_choices=True)

有効な応答が受信されるまで、ユーザーからの入力を求めます。これは基底クラスであり、具体的なクラスのいずれかの例を参照してください。

パラメータ

• prompt (TextType, optional) – プロンプトテキスト。デフォルトは""。

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

• password (bool, optional) – パスワード入力を有効にします。デフォルトはFalse。

• choices (List[str], optional) – 有効な選択肢のリスト。デフォルトはNone。

• show_default (bool, optional) – プロンプトにデフォルト値を表示します。デフォルトはTrue。

• show_choices (bool, optional) – プロンプトに選択肢を表示します。デフォルトはTrue。

classmethod ask(prompt: Union[str, Text] = '', *, console: Optional[Console] = None, password: bool = False, choices: Optional[List[str]] = None, show_default: bool = True, show_choices: bool = True, default: DefaultType, stream: Optional[TextIO] = None) → Union[DefaultType, PromptType]

classmethod ask(prompt: Union[str, Text] = '', *, console: Optional[Console] = None, password: bool = False, choices: Optional[List[str]] = None, show_default: bool = True, show_choices: bool = True, stream: Optional[TextIO] = None) → PromptType

プロンプトループを作成して実行し、結果を返すショートカットです。

例

>>> filename = Prompt.ask("Enter a filename")

パラメータ

• prompt (TextType, optional) – プロンプトテキスト。デフォルトは""。

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

• password (bool, optional) – パスワード入力を有効にします。デフォルトはFalse。

• choices (List[str], optional) – 有効な選択肢のリスト。デフォルトはNone。

• show_default (bool, optional) – プロンプトにデフォルト値を表示します。デフォルトはTrue。

• show_choices (bool, optional) – プロンプトに選択肢を表示します。デフォルトはTrue。

• stream (TextIO, optional) – 入力を受け取るために読み込み用に開かれているオプションのテキストファイルです。デフォルトはNoneです。

check_choice(value)

値が有効な選択肢のリスト内にあるかどうかを確認します。

パラメータ

value (str) – ユーザーが入力した値。

戻り値

選択肢が有効な場合はTrue、そうでない場合はFalse。

戻り値の型

bool

classmethod get_input(console, prompt, password, stream=None)

ユーザーからの入力を取得します。

パラメータ

• console (Console) – Consoleインスタンス。

• prompt (TextType) – プロンプトテキスト。

• password (bool) – パスワード入力を有効にする。

• stream (Optional[TextIO]) –

戻り値

ユーザーからの文字列。

戻り値の型

str

make_prompt(default)

プロンプトテキストを作成します。

パラメータ

default (DefaultType) – デフォルト値。

戻り値

プロンプトに表示するテキスト。

戻り値の型

テキスト

on_validate_error(value, error)

検証エラーを処理するために呼び出されます。

パラメータ

• value (str) – ユーザーが入力した文字列。

• error (InvalidResponse) – エラーを開始した例外インスタンス。

戻り値の型

なし

pre_prompt()

プロンプトの前に何かを表示するためのフックです。

戻り値の型

なし

process_response(value)

ユーザーからの応答を処理し、プロンプトの種類に変換します。

パラメータ

value (str) – ユーザーが入力した文字列。

例外発生時

InvalidResponse – valueが無効な場合。

戻り値

askメソッドから返される値。

戻り値の型

プロンプトタイプ

render_default(default)

指定されたデフォルト値をTextインスタンスに変換します。

パラメータ

default (DefaultType) – デフォルト値。

戻り値

デフォルト値のレンダリングを含むText。

戻り値の型

テキスト

response_type

str のエイリアス

exception rich.prompt.PromptError

プロンプト関連エラーの例外基底クラス。