diff options
author | Zach White <skullydazed@gmail.com> | 2021-07-20 11:52:14 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-07-20 11:52:14 -0700 |
commit | 4ab8734d6edd6894757507e70264eddca5429052 (patch) | |
tree | b43ad3f47426d3c194b05d02ae5ff34d6b0c1301 /lib/python/qmk/cli/format/python.py | |
parent | c4db9f7fb2a359abb1db06e3d74a52dce8bdf68c (diff) | |
download | qmk_firmware-4ab8734d6edd6894757507e70264eddca5429052.tar.gz qmk_firmware-4ab8734d6edd6894757507e70264eddca5429052.zip |
Move all our CLI file formatters to the format dir (#13296)
* move all our file formatters to the format dir
* Apply suggestions from code review
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
Diffstat (limited to 'lib/python/qmk/cli/format/python.py')
-rwxr-xr-x | lib/python/qmk/cli/format/python.py | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/lib/python/qmk/cli/format/python.py b/lib/python/qmk/cli/format/python.py new file mode 100755 index 000000000..00612f97e --- /dev/null +++ b/lib/python/qmk/cli/format/python.py | |||
@@ -0,0 +1,26 @@ | |||
1 | """Format python code according to QMK's style. | ||
2 | """ | ||
3 | from subprocess import CalledProcessError, DEVNULL | ||
4 | |||
5 | from milc import cli | ||
6 | |||
7 | |||
8 | @cli.argument('-n', '--dry-run', arg_only=True, action='store_true', help="Don't actually format.") | ||
9 | @cli.subcommand("Format python code according to QMK's style.", hidden=False if cli.config.user.developer else True) | ||
10 | def format_python(cli): | ||
11 | """Format python code according to QMK's style. | ||
12 | """ | ||
13 | edit = '--diff' if cli.args.dry_run else '--in-place' | ||
14 | yapf_cmd = ['yapf', '-vv', '--recursive', edit, 'bin/qmk', 'lib/python'] | ||
15 | try: | ||
16 | cli.run(yapf_cmd, check=True, capture_output=False, stdin=DEVNULL) | ||
17 | cli.log.info('Python code in `bin/qmk` and `lib/python` is correctly formatted.') | ||
18 | return True | ||
19 | |||
20 | except CalledProcessError: | ||
21 | if cli.args.dry_run: | ||
22 | cli.log.error('Python code in `bin/qmk` and `lib/python` incorrectly formatted!') | ||
23 | else: | ||
24 | cli.log.error('Error formatting python code!') | ||
25 | |||
26 | return False | ||