questions

Sometimes you need to ask the user a question. MILC provides basic functions for collecting and validating user input. You can find these in the milc.questions module.

yesno

def yesno(prompt: str,
          *args: Any,
          default: Optional[bool] = None,
          **kwargs: Any) -> bool

Displays prompt to the user and gets a yes or no response.

Returns True for a yes and False for a no.

Argument	Description
prompt	The prompt to present to the user. Can include ANSI and format strings like cli.echo().
default	Whether to default to a Yes or No when the user presses enter. None- force the user to enter Y or N True- Default to yes False- Default to no

If you add --yes and --no arguments to your program the user can answer questions by passing command line flags.

@cli.argument('-y', '--yes', action='store_true', arg_only=True, help='Answer yes to all questions.')
@cli.argument('-n', '--no', action='store_true', arg_only=True, help='Answer no to all questions.')

password

def password(prompt: str = 'Enter password:',
             *args: Any,
             confirm: bool = False,
             confirm_prompt: str = 'Confirm password:',
             confirm_limit: int = 3,
             validate: Optional[Callable[[str], bool]] = None,
             **kwargs: Any) -> Optional[str]

Securely receive a password from the user. Returns the password or None.

When running in non-interactive mode this will always return None. Otherwise it will return the confirmed password the user provides.

Argument	Description
prompt	The prompt to present to the user. Can include ANSI and format strings like milc's cli.echo().
confirm	Prompt the user to type the password again and make sure they match.
confirm_prompt	The prompt to present to the user. Can include ANSI and format strings like milc's cli.echo().
confirm_limit	Number of attempts to confirm before giving up. Default: 3
validate	This is an optional function that can be used to validate the password, EG to check complexity. It should return True or False and have the following signature: def function_name(answer):

question

def question(prompt: str,
             *args: Any,
             default: Optional[str] = None,
             confirm: bool = False,
             answer_type: Callable[[str], str] = str,
             validate: Optional[Callable[..., bool]] = None,
             **kwargs: Any) -> Union[str, Any]

Allow the user to type in a free-form string to answer.

Argument	Description
prompt	The prompt to present to the user. Can include ANSI and format strings like milc's cli.echo().
default	The value to return when the user doesn't enter any value. Use None to prompt until they enter a value.
confirm	Present the user with a confirmation dialog before accepting their answer.
answer_type	Specify a type function for the answer. Will re-prompt the user if the function raises any errors. Common choices here include int, float, and decimal.Decimal.
validate	This is an optional function that can be used to validate the answer. It should return True or False and have the following signature: def function_name(answer, *args, **kwargs):

choice

def choice(heading: str,
           options: Sequence[str],
           *args: Any,
           default: Optional[int] = None,
           confirm: bool = False,
           prompt: str = 'Please enter your choice: ',
           **kwargs: Any) -> Optional[str]

Present the user with a list of options and let them select one.

Users can enter either the number or the text of their choice. This will return the value of the item they choose, not the numerical index.

Argument	Description
heading	The text to place above the list of options.
options	A sequence of items to choose from.
default	The index of the item to return when the user doesn't enter any value. Use None to prompt until they enter a value.
confirm	When True present the user with a confirmation dialog before accepting their answer.
prompt	The prompt to present to the user. Can include color and format strings like milc's cli.echo().

Users can enter either the number or the text of their choice.

Warning

This will return the value of the item they choose, not the numerical index.