diff options
| author | Drashna Jael're <[email protected]> | 2021-11-19 09:48:23 -0800 | 
|---|---|---|
| committer | Drashna Jael're <[email protected]> | 2021-11-19 09:48:23 -0800 | 
| commit | 4be9919e9fd7c54c2e046b82e82f5fbc2fdd44e6 (patch) | |
| tree | 5a56b18bd8aff40ec480833f8ba2f7c48ef3279a /lib/python | |
| parent | a5155b98fb29ad4ea6de73f39a0d413d79883356 (diff) | |
| parent | 94b535024642bab6705f1e08ec62680d8e49b62b (diff) | |
| download | qmk_firmware-4be9919e9fd7c54c2e046b82e82f5fbc2fdd44e6.tar.gz qmk_firmware-4be9919e9fd7c54c2e046b82e82f5fbc2fdd44e6.zip | |
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'lib/python')
| -rwxr-xr-x | lib/python/qmk/cli/format/python.py | 66 | ||||
| -rw-r--r-- | lib/python/qmk/cli/list/keymaps.py | 5 | ||||
| -rw-r--r-- | lib/python/qmk/cli/list/layouts.py | 5 | ||||
| -rw-r--r-- | lib/python/qmk/tests/test_cli_commands.py | 4 | 
4 files changed, 66 insertions, 14 deletions
| diff --git a/lib/python/qmk/cli/format/python.py b/lib/python/qmk/cli/format/python.py index b32a726401..95868d18a0 100755 --- a/lib/python/qmk/cli/format/python.py +++ b/lib/python/qmk/cli/format/python.py @@ -4,23 +4,65 @@ from subprocess import CalledProcessError, DEVNULL  from milc import cli +from qmk.path import normpath [email protected]('-n', '--dry-run', arg_only=True, action='store_true', help="Don't actually format.") [email protected]("Format python code according to QMK's style.", hidden=False if cli.config.user.developer else True) -def format_python(cli): -    """Format python code according to QMK's style. -    """ +py_file_suffixes = ('py',) +py_dirs = ['lib/python'] + + +def yapf_run(files):      edit = '--diff' if cli.args.dry_run else '--in-place' -    yapf_cmd = ['yapf', '-vv', '--recursive', edit, 'lib/python'] +    yapf_cmd = ['yapf', '-vv', '--recursive', edit, *files]      try:          cli.run(yapf_cmd, check=True, capture_output=False, stdin=DEVNULL) -        cli.log.info('Python code in `lib/python` is correctly formatted.') -        return True +        cli.log.info('Successfully formatted the python code.')      except CalledProcessError: -        if cli.args.dry_run: -            cli.log.error('Python code in `lib/python` is incorrectly formatted!') +        cli.log.error(f'Python code in {",".join(py_dirs)} incorrectly formatted!') +        return False + + +def filter_files(files): +    """Yield only files to be formatted and skip the rest +    """ + +    for file in files: +        if file and file.name.split('.')[-1] in py_file_suffixes: +            yield file          else: -            cli.log.error('Error formatting python code!') +            cli.log.debug('Skipping file %s', file) + + [email protected]('-n', '--dry-run', arg_only=True, action='store_true', help="Don't actually format.") [email protected]('-b', '--base-branch', default='origin/master', help='Branch to compare to diffs to.') [email protected]('-a', '--all-files', arg_only=True, action='store_true', help='Format all files.') [email protected]('files', nargs='*', arg_only=True, type=normpath, help='Filename(s) to format.') [email protected]("Format python code according to QMK's style.", hidden=False if cli.config.user.developer else True) +def format_python(cli): +    """Format python code according to QMK's style. +    """ +    # Find the list of files to format +    if cli.args.files: +        files = list(filter_files(cli.args.files)) + +        if not files: +            cli.log.error('No Python files in filelist: %s', ', '.join(map(str, cli.args.files))) +            exit(0) + +        if cli.args.all_files: +            cli.log.warning('Filenames passed with -a, only formatting: %s', ','.join(map(str, files))) + +    elif cli.args.all_files: +        files = py_dirs + +    else: +        git_diff_cmd = ['git', 'diff', '--name-only', cli.args.base_branch, *py_dirs] +        git_diff = cli.run(git_diff_cmd, stdin=DEVNULL) +        files = list(filter(None, git_diff.stdout.split('\n'))) + +    # Sanity check +    if not files: +        cli.log.error('No changed files detected. Use "qmk format-python -a" to format all files') +        return False -    return False +    return yapf_run(files) diff --git a/lib/python/qmk/cli/list/keymaps.py b/lib/python/qmk/cli/list/keymaps.py index d79ab75b58..d2ef136c06 100644 --- a/lib/python/qmk/cli/list/keymaps.py +++ b/lib/python/qmk/cli/list/keymaps.py @@ -13,5 +13,10 @@ from qmk.keyboard import keyboard_completer, keyboard_folder  def list_keymaps(cli):      """List the keymaps for a specific keyboard      """ +    if not cli.config.list_keymaps.keyboard: +        cli.log.error('Missing required arguments: --keyboard') +        cli.subcommands['list-keymaps'].print_help() +        return False +      for name in qmk.keymap.list_keymaps(cli.config.list_keymaps.keyboard):          print(name) diff --git a/lib/python/qmk/cli/list/layouts.py b/lib/python/qmk/cli/list/layouts.py index 8e07afeeca..df593dc390 100644 --- a/lib/python/qmk/cli/list/layouts.py +++ b/lib/python/qmk/cli/list/layouts.py @@ -13,6 +13,11 @@ from qmk.info import info_json  def list_layouts(cli):      """List the layouts for a specific keyboard      """ +    if not cli.config.list_layouts.keyboard: +        cli.log.error('Missing required arguments: --keyboard') +        cli.subcommands['list-layouts'].print_help() +        return False +      info_data = info_json(cli.config.list_layouts.keyboard)      for name in sorted(info_data.get('community_layouts', [])):          print(name) diff --git a/lib/python/qmk/tests/test_cli_commands.py b/lib/python/qmk/tests/test_cli_commands.py index 9f2c258ab4..1e3c64e735 100644 --- a/lib/python/qmk/tests/test_cli_commands.py +++ b/lib/python/qmk/tests/test_cli_commands.py @@ -81,9 +81,9 @@ def test_hello():  def test_format_python(): -    result = check_subcommand('format-python', '--dry-run') +    result = check_subcommand('format-python', '-n', '-a')      check_returncode(result) -    assert 'Python code in `lib/python` is correctly formatted.' in result.stdout +    assert 'Successfully formatted the python code.' in result.stdout  def test_list_keyboards(): | 
