Beef up how `qmk doctor` works. (#7375)
* 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 <Erovia@users.noreply.github.com> Co-authored-by: Erovia <Erovia@users.noreply.github.com>arm_split 0.7.119
skullydazed
5 years ago
committed by
Erovia
parent
e4a0f841e1
commit
5e65af3a76
@ -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
|
||||
@ -0,0 +1,71 @@
|
||||
"""Functions for working with QMK's submodules.
|
||||
"""
|
||||
|
||||
import subprocess
|
||||
|
||||
|
||||
def status():
|
||||
"""Returns a dictionary of submodules.
|
||||
|
||||
Each entry is a dict of the form:
|
||||
|
||||
{
|
||||
'name': 'submodule_name',
|
||||
'status': None/False/True,
|
||||
'githash': '<sha-1 hash for the submodule>
|
||||
}
|
||||
|
||||
status is None when the submodule doesn't exist, False when it's out of date, and True when it's current
|
||||
"""
|
||||
submodules = {}
|
||||
git_cmd = subprocess.run(['git', 'submodule', 'status'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, timeout=30, universal_newlines=True)
|
||||
|
||||
for line in git_cmd.stdout.split('\n'):
|
||||
if not line:
|
||||
continue
|
||||
|
||||
status = line[0]
|
||||
githash, submodule = line[1:].split()[:2]
|
||||
submodules[submodule] = {'name': submodule, 'githash': githash}
|
||||
|
||||
if status == '-':
|
||||
submodules[submodule]['status'] = None
|
||||
elif status == '+':
|
||||
submodules[submodule]['status'] = False
|
||||
elif status == ' ':
|
||||
submodules[submodule]['status'] = True
|
||||
else:
|
||||
raise ValueError('Unknown `git submodule status` sha-1 prefix character: "%s"' % status)
|
||||
|
||||
return submodules
|
||||
|
||||
|
||||
def update(submodules=None):
|
||||
"""Update the submodules.
|
||||
|
||||
submodules
|
||||
A string containing a single submodule or a list of submodules.
|
||||
"""
|
||||
git_sync_cmd = ['git', 'submodule', 'sync']
|
||||
git_update_cmd = ['git', 'submodule', 'update', '--init']
|
||||
|
||||
if submodules is None:
|
||||
# Update everything
|
||||
git_sync_cmd.append('--recursive')
|
||||
git_update_cmd.append('--recursive')
|
||||
subprocess.run(git_sync_cmd, check=True)
|
||||
subprocess.run(git_update_cmd, check=True)
|
||||
|
||||
else:
|
||||
if isinstance(submodules, str):
|
||||
# Update only a single submodule
|
||||
git_sync_cmd.append(submodules)
|
||||
git_update_cmd.append(submodules)
|
||||
subprocess.run(git_sync_cmd, check=True)
|
||||
subprocess.run(git_update_cmd, check=True)
|
||||
|
||||
else:
|
||||
# Update submodules in a list
|
||||
for submodule in submodules:
|
||||
subprocess.run(git_sync_cmd + [submodule], check=True)
|
||||
subprocess.run(git_update_cmd + [submodule], check=True)
|
||||
Loading…
Reference in New Issue