mloq.config.custom_click#

This is mostly a copy paste from https://github.com/pallets/click/blob/2fc486c880eda9fdb746ed8baa49416acab9ea6d/src/click/termui.py

Modified to allow prompt input that has a different color than the prompt text, while keeping the color of the default prompt values the same as the prompt text color.

Module Contents#

Functions#

hidden_prompt_func(prompt)

Input hidden text from the user.

_build_prompt(text, suffix[, show_default, default, ...])

_format_default(default)

prompt(text[, default, hide_input, ...])

Prompts a user for input. This is a convenience function that can be used to prompt a user for input later.

confirm(text[, default, abort, prompt_suffix, ...])

Prompts for confirmation (yes/no question).

Attributes#

visible_prompt_func

_ansi_reset_all

mloq.config.custom_click.visible_prompt_func#
mloq.config.custom_click._ansi_reset_all = #
mloq.config.custom_click.hidden_prompt_func(prompt)[source]#

Input hidden text from the user.

mloq.config.custom_click._build_prompt(text, suffix, show_default=False, default=None, show_choices=True, type=None)[source]#
mloq.config.custom_click._format_default(default)[source]#
mloq.config.custom_click.prompt(text, default=None, hide_input=False, confirmation_prompt=False, type=None, value_proc=None, prompt_suffix=': ', show_default=True, err=False, show_choices=True)[source]#

Prompts a user for input. This is a convenience function that can be used to prompt a user for input later.

If the user aborts the input by sending a interrupt signal, this function will catch it and raise a Abort exception.

New in version 7.0: Added the show_choices parameter.

New in version 6.0: Added unicode support for cmd.exe on Windows.

New in version 4.0: Added the err parameter.

Parameters

  • text – the text to show for the prompt.

  • default – the default value to use if no input happens. If this is not given it will prompt until it’s aborted.

  • hide_input – if this is set to true then the input value will be hidden.

  • confirmation_prompt – asks for confirmation for the value.

  • type – the type to use to check the value against.

  • value_proc – if this parameter is provided it’s a function that is invoked instead of the type conversion to convert a value.

  • prompt_suffix – a suffix that should be added to the prompt.

  • show_default – shows or hides the default value in the prompt.

  • err – if set to true the file defaults to stderr instead of stdout, the same as with echo.

  • show_choices – Show or hide choices if the passed type is a Choice. For example if type is a Choice of either day or week, show_choices is true and text is “Group by” then the prompt will be “Group by (day, week): “.

Returns

None

Return type

None

mloq.config.custom_click.confirm(text, default=False, abort=False, prompt_suffix=': ', show_default=True, err=False)[source]#

Prompts for confirmation (yes/no question).

If the user aborts the input by sending a interrupt signal this function will catch it and raise a Abort exception.

New in version 4.0: Added the err parameter.

Parameters

  • text – the question to ask.

  • default – the default for the prompt.

  • abort – if this is set to True a negative answer aborts the exception by raising Abort.

  • prompt_suffix – a suffix that should be added to the prompt.

  • show_default – shows or hides the default value in the prompt.

  • err – if set to true the file defaults to stderr instead of stdout, the same as with echo.

Returns

User’s decision.

Return type

bool