rich.prompt

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

A是/否确认提示。

示例

>>> if Confirm.ask("Continue"):
        run_job()
参数
process_response(value)[源代码]

将选项转换为布尔值。

参数

value (str) --

返回类型

bool

render_default(default)[源代码]

将默认值呈现为(Y)或(N)，而不是True/False。

参数

default (DefaultType) --

返回类型

Text

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]) -- 错误消息。

返回类型

None

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

返回字符串的提示。

示例

>>> 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) -- 一个控制台实例或无，以使用全局控制台。默认为无。

  • password (bool, optional) -- 启用密码输入。默认为False。

  • choices (List[str], optional) -- 有效选择的列表。默认为无。

  • 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) -- 一个控制台实例或无，以使用全局控制台。默认为无。

  • password (bool, optional) -- 启用密码输入。默认为False。

  • choices (List[str], optional) -- 有效选择的列表。默认为无。

  • show_default (bool, optional) -- 在提示中显示默认设置。默认为True。

  • show_choices (bool, optional) -- 在提示中显示选项。默认为True。

  • stream (TextIO, optional) -- 可选的文本文件打开以供阅读以获取输入。默认为无。

check_choice(value)[源代码]

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

参数

value (str) -- 用户输入的值。

返回

如果选项有效，则为True，否则为False。

返回类型

bool

classmethod get_input(console, prompt, password, stream=None)[源代码]

从用户获取输入。

参数

  • console (Console) -- 控制台实例。

  • prompt (TextType) -- 提示文本。

  • password (bool) -- 启用密码输入。

  • stream (Optional[TextIO]) --

返回

来自用户的字符串。

返回类型

str

make_prompt(default)[源代码]

制作提示文本。

参数

default (DefaultType) -- 默认值。

返回

要在提示中显示的文本。

返回类型

Text

on_validate_error(value, error)[源代码]

调用以处理验证错误。

参数

  • value (str) -- 用户输入的字符串。

  • error (InvalidResponse) -- 启动错误的异常实例。

返回类型

None

pre_prompt()[源代码]

挂钩以在提示之前显示某些内容。

返回类型

None

process_response(value)[源代码]

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

参数

value (str) -- 用户键入的字符串。

抛出

InvalidResponse -- 如果 value 是无效的。

返回

要从Ask方法返回的值。

返回类型

PromptType

render_default(default)[源代码]

将提供的默认设置转换为文本实例。

参数

default (DefaultType) -- 默认值。

返回

包含缺省值呈现形式的文本。

返回类型

Text

response_type

str 的别名

exception rich.prompt.PromptError[源代码]

提示相关错误的异常基类。