bibliotekar.console.testing.TestPrompt

class bibliotekar.console.testing.TestPrompt(prompt='', *, console=None, password=False, choices=None, case_sensitive=True, show_default=True, show_choices=True)

__init__(prompt='', *, console=None, password=False, choices=None, case_sensitive=True, show_default=True, show_choices=True)

Methods

__init__([prompt, console, password, ...])
ask([prompt, console, password, choices, ...])	Shortcut to construct and run a prompt loop and return the result.
check_choice(value)	Check value is in the list of valid choices.
get_input(*args, **kwargs)	Get input from user.
make_prompt(default)	Make prompt text.
on_validate_error(value, error)	Called to handle validation error.
patch(monkeypatch)
pre_prompt()	Hook to display something before the prompt.
process_response(value)	Process response from user, convert to prompt type.
render_default(default)	Turn the supplied default in to a Text instance.
set_value(value)

Attributes

choices
illegal_choice_message
prompt_suffix
validate_error_message

classmethod get_input(*args, **kwargs)

Get input from user.

Return type:

str

Args:

console (Console): Console instance. prompt (TextType): Prompt text. password (bool): Enable password entry.

Returns:

str: String from user.