nip.utils.io.yes_no_user_prompt

nip.utils.io.yes_no_user_prompt(query_message: str, initial_message: str | None = None, default_answer: Literal['y', 'n'] | None = None) → bool

Prompt the user with a yes or no questions.

This function will keep prompting the user until a valid response is provided.

Parameters:

• query_message (str) – The message to ask the user each time.

• initial_message (str) – An initial message to print before the query loop.

• default_answer (Literal["y", "n"], optional) – The default answer, which will be used if the user just presses <return>.

Returns:

selected_yes (bool) – True if the user answered ‘y’, False if the user answered ‘n’.