bibliotekar.console.prompt.VersionPrompt#

class bibliotekar.console.prompt.VersionPrompt(prompt='', *, console=None, password=False, choices=None, case_sensitive=True, show_default=True, show_choices=True)[source]#

A prompt that returns a valid code shelf version.

__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.

ask_based_on_today(prompt[, existing])

check_choice(value)

Check value is in the list of valid choices.

get_input(console, prompt, password[, stream])

Get input from user.

make_prompt(default)

Make prompt text.

on_validate_error(value, error)

Called to handle validation error.

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.

Attributes

choices

illegal_choice_message

prompt_suffix

validate_error_message

process_response(value)[source]#

Process response from user, convert to prompt type.

Return type:

Version

Args:

value (str): String typed by user.

Raises:

InvalidResponse: If value is invalid.

Returns:

PromptType: The value to be returned from ask method.

response_type#

alias of Version