diff options
author | skullydazed <[email protected]> | 2020-01-24 11:31:16 -0800 |
---|---|---|
committer | Erovia <[email protected]> | 2020-01-24 20:31:16 +0100 |
commit | 5e65af3a76252bea6556d26add3061dea4918cc2 (patch) | |
tree | f44089f3f95e53e1b67d34db3c922a04b0a942f7 /lib/python/qmk/questions.py | |
parent | e4a0f841e19b4ddf86711cf79dc521d2f6f5e4ae (diff) | |
download | qmk_firmware-5e65af3a76252bea6556d26add3061dea4918cc2.tar.gz qmk_firmware-5e65af3a76252bea6556d26add3061dea4918cc2.zip |
Beef up how `qmk doctor` works. (#7375)0.7.119
* Beef up how `qmk doctor` works.
* improve the `git submodule status` parsing. h/t @erovia
* Fix whitespace and imports
* yapf
* Add documentation for the new doctor functionality
* Replace type_unchanged() with str()
* remove unused modules
* Update lib/python/qmk/cli/doctor.py
Co-Authored-By: Erovia <[email protected]>
Co-authored-by: Erovia <[email protected]>
Diffstat (limited to 'lib/python/qmk/questions.py')
-rw-r--r-- | lib/python/qmk/questions.py | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/lib/python/qmk/questions.py b/lib/python/qmk/questions.py new file mode 100644 index 0000000000..34b0b43bc8 --- /dev/null +++ b/lib/python/qmk/questions.py @@ -0,0 +1,97 @@ +"""Functions to collect user input. +""" + +from milc import cli, format_ansi + + +def yesno(prompt, *args, default=None, **kwargs): + """Displays prompt to the user and gets a yes or no response. + + Returns True for a yes and False for a no. + + If you add `--yes` and `--no` arguments to your program the user can answer questions by passing command line flags. + + @add_argument('-y', '--yes', action='store_true', arg_only=True, help='Answer yes to all questions.') + @add_argument('-n', '--no', action='store_true', arg_only=True, help='Answer no to all questions.') + + Arguments: + prompt + The prompt to present to the user. Can include ANSI and format strings like milc's `cli.print()`. + + 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 not args and kwargs: + args = kwargs + + if 'no' in cli.args and cli.args.no: + return False + + if 'yes' in cli.args and cli.args.yes: + return True + + if default is not None: + if default: + prompt = prompt + ' [Y/n] ' + else: + prompt = prompt + ' [y/N] ' + + while True: + print() + answer = input(format_ansi(prompt % args)) + print() + + if not answer and prompt is not None: + return default + + elif answer.lower() in ['y', 'yes']: + return True + + elif answer.lower() in ['n', 'no']: + return False + + +def question(prompt, *args, default=None, confirm=False, answer_type=str, **kwargs): + """Prompt the user to answer a question with a free-form input. + + prompt + The prompt to present to the user. Can include ANSI and format strings like milc's `cli.print()`. + + default + The value to return when the user doesn't enter any value. Use None to prompt until they enter a value. + + 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. + """ + if not args and kwargs: + args = kwargs + + if default is not None: + prompt = '%s [%s] ' % (prompt, default) + + while True: + print() + answer = input(format_ansi(prompt % args)) + print() + + if answer: + if 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) + except Exception as e: + cli.log.error('Could not convert answer (%s) to type %s: %s', answer, answer_type.__name__, str(e)) + + elif default is not None: + return default |