Improve the functionality of qmk.questions (#8020)
* wip * tested and working * remove unused import * Update lib/python/qmk/questions.py Co-Authored-By: Erovia <Erovia@users.noreply.github.com> * fix flake8 errors Co-authored-by: Erovia <Erovia@users.noreply.github.com>
This commit is contained in:
skullydazed
GitHub
parent
acef512730
commit
5780c94423
1 changed files with 89 additions and 8 deletions
|
|
@ -16,7 +16,7 @@ def yesno(prompt, *args, default=None, **kwargs):
|
|||
|
||||
Arguments:
|
||||
prompt
|
||||
The prompt to present to the user. Can include ANSI and format strings like milc's `cli.print()`.
|
||||
The prompt to present to the user. Can include ANSI and format strings like milc's `cli.echo()`.
|
||||
|
||||
default
|
||||
Whether to default to a Yes or No when the user presses enter.
|
||||
|
|
@ -43,9 +43,9 @@ def yesno(prompt, *args, default=None, **kwargs):
|
|||
prompt = prompt + ' [y/N] '
|
||||
|
||||
while True:
|
||||
print()
|
||||
cli.echo('')
|
||||
answer = input(format_ansi(prompt % args))
|
||||
print()
|
||||
cli.echo('')
|
||||
|
||||
if not answer and prompt is not None:
|
||||
return default
|
||||
|
|
@ -57,17 +57,26 @@ def yesno(prompt, *args, default=None, **kwargs):
|
|||
return False
|
||||
|
||||
|
||||
def question(prompt, *args, default=None, confirm=False, answer_type=str, **kwargs):
|
||||
def question(prompt, *args, default=None, confirm=False, answer_type=str, validate=None, **kwargs):
|
||||
"""Prompt the user to answer a question with a free-form input.
|
||||
|
||||
Arguments:
|
||||
prompt
|
||||
The prompt to present to the user. Can include ANSI and format strings like milc's `cli.print()`.
|
||||
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):
|
||||
"""
|
||||
if not args and kwargs:
|
||||
args = kwargs
|
||||
|
|
@ -76,17 +85,21 @@ def question(prompt, *args, default=None, confirm=False, answer_type=str, **kwar
|
|||
prompt = '%s [%s] ' % (prompt, default)
|
||||
|
||||
while True:
|
||||
print()
|
||||
cli.echo('')
|
||||
answer = input(format_ansi(prompt % args))
|
||||
print()
|
||||
cli.echo('')
|
||||
|
||||
if answer:
|
||||
if confirm:
|
||||
if validate is not None and not validate(answer, *args, **kwargs):
|
||||
continue
|
||||
|
||||
elif confirm:
|
||||
if yesno('Is the answer "%s" correct?', answer, default=True):
|
||||
try:
|
||||
return answer_type(answer)
|
||||
except Exception as e:
|
||||
cli.log.error('Could not convert answer (%s) to type %s: %s', answer, answer_type.__name__, str(e))
|
||||
|
||||
else:
|
||||
try:
|
||||
return answer_type(answer)
|
||||
|
|
@ -95,3 +108,71 @@ def question(prompt, *args, default=None, confirm=False, answer_type=str, **kwar
|
|||
|
||||
elif default is not None:
|
||||
return default
|
||||
|
||||
|
||||
def choice(heading, options, *args, default=None, confirm=False, prompt='Please enter your choice: ', **kwargs):
|
||||
"""Present the user with a list of options and let them pick 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.
|
||||
|
||||
Arguments:
|
||||
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
|
||||
Present the user with a confirmation dialog before accepting their answer.
|
||||
|
||||
prompt
|
||||
The prompt to present to the user. Can include ANSI and format strings like milc's `cli.echo()`.
|
||||
"""
|
||||
if not args and kwargs:
|
||||
args = kwargs
|
||||
|
||||
if prompt and default:
|
||||
prompt = prompt + ' [%s] ' % (default + 1,)
|
||||
|
||||
while True:
|
||||
# Prompt for an answer.
|
||||
cli.echo('')
|
||||
cli.echo(heading % args)
|
||||
cli.echo('')
|
||||
for i, option in enumerate(options, 1):
|
||||
cli.echo('\t{fg_cyan}%d.{fg_reset} %s', i, option)
|
||||
|
||||
cli.echo('')
|
||||
answer = input(format_ansi(prompt))
|
||||
cli.echo('')
|
||||
|
||||
# If the user types in one of the options exactly use that
|
||||
if answer in options:
|
||||
return answer
|
||||
|
||||
# Massage the answer into a valid integer
|
||||
if answer == '' and default:
|
||||
answer = default
|
||||
else:
|
||||
try:
|
||||
answer = int(answer) - 1
|
||||
except Exception:
|
||||
# Normally we would log the exception here, but in the interest of clean UI we do not.
|
||||
cli.log.error('Invalid choice: %s', answer + 1)
|
||||
continue
|
||||
|
||||
# Validate the answer
|
||||
if answer >= len(options) or answer < 0:
|
||||
cli.log.error('Invalid choice: %s', answer + 1)
|
||||
continue
|
||||
|
||||
if confirm and not yesno('Is the answer "%s" correct?', answer + 1, default=True):
|
||||
continue
|
||||
|
||||
# Return the answer they chose.
|
||||
return options[answer]
|
||||
|
|
|
|||
Loading…
Reference in a new issue