rich.prompt¶

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

是/否确认提示。

示例

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

process_response(value)[source]¶

将选项转换为布尔值。

参数: value (str) –
返回类型: bool

render_default(default)[source]¶

将默认值渲染为 (y) 或 (n)，而不是 True/False。

参数: default (DefaultType) –
返回类型: 文本

response_type¶: 别名 bool

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

返回浮点数的提示。

示例

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

返回整数的提示。

示例

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

response_type¶: 别名 int

exception rich.prompt.InvalidResponse(message)[source]¶

表示响应无效的异常。在 process_response() 中引发此异常以指示错误并提供错误消息。

参数: message (Union[str, Text]) – 错误消息。
返回类型: None

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

返回字符串的提示。

示例

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

询问用户输入，直到收到有效响应。这是基类，请参阅具体类以获取示例。

参数

prompt (TextType, optional) – 提示文本。默认为 “”。
console (Console, optional) – 控制台实例或 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][source]¶

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) – 控制台实例或 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)[source]¶

检查值是否在有效的选项列表中。

参数: value (str) – 用户输入的值。
返回值: 如果选项有效，则返回 True，否则返回 False。
返回类型: bool

classmethod get_input(console, prompt, password, stream=None)[source]¶

从用户获取输入。

参数

console (Console) – 控制台实例。
prompt (TextType) – 提示文本。
password (bool) – 启用密码输入。
stream (Optional[TextIO]) –

返回值

用户的字符串。

返回类型

str

make_prompt(default)[source]¶

创建提示文本。

参数: default (DefaultType) – 默认值。
返回值: 要在提示中显示的文本。
返回类型: 文本

on_validate_error(value, error)[source]¶

用于处理验证错误。

参数

value (str) – 用户输入的字符串。
error (InvalidResponse) – 导致错误的异常实例。

返回类型

None

pre_prompt()[source]¶

钩子，用于在显示提示之前显示一些内容。

返回类型: None

process_response(value)[source]¶

处理来自用户的响应，将其转换为提示类型。

参数: value (str) – 用户输入的字符串。
引发异常: InvalidResponse – 如果value 无效。
返回值: 要从 ask 方法返回的值。
返回类型: PromptType

render_default(default)[source]¶

将提供的默认值转换为 Text 实例。

参数: default (DefaultType) – 默认值。
返回值: 包含默认值渲染的 Text。
返回类型: 文本

response_type¶: 别名 str

exception rich.prompt.PromptError[source]¶: 与提示相关的错误的异常基类。