summaryrefslogtreecommitdiffstats
path: root/lib/python/qmk/cli/pyformat.py
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-05-10 18:19:15 +0000
committerQMK Bot <hello@qmk.fm>2021-05-10 18:19:15 +0000
commit911b45ce3bcc2cf4c7e12ccf8df7da9621173e32 (patch)
tree1e01136ad436175dc74f9502e63dfeba21364380 /lib/python/qmk/cli/pyformat.py
parentcfc6e4bfac6b677b2f1249552c9e95d063f9d459 (diff)
parenta3e7f3e7c58ee98596ead5c213f3a9ed8340cd80 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'lib/python/qmk/cli/pyformat.py')
-rwxr-xr-xlib/python/qmk/cli/pyformat.py15
1 files changed, 12 insertions, 3 deletions
diff --git a/lib/python/qmk/cli/pyformat.py b/lib/python/qmk/cli/pyformat.py
index 1464443804..02581f0d85 100755
--- a/lib/python/qmk/cli/pyformat.py
+++ b/lib/python/qmk/cli/pyformat.py
@@ -5,13 +5,22 @@ from milc import cli
import subprocess
+@cli.argument('-n', '--dry-run', arg_only=True, action='store_true', help="Flag only, don't automatically format.")
@cli.subcommand("Format python code according to QMK's style.", hidden=False if cli.config.user.developer else True)
def pyformat(cli):
"""Format python code according to QMK's style.
"""
+ edit = '--diff' if cli.args.dry_run else '--in-place'
+ yapf_cmd = ['yapf', '-vv', '--recursive', edit, 'bin/qmk', 'lib/python']
try:
- subprocess.run(['yapf', '-vv', '-ri', 'bin/qmk', 'lib/python'], check=True)
- cli.log.info('Successfully formatted the python code in `bin/qmk` and `lib/python`.')
+ cli.run(yapf_cmd, check=True, capture_output=False)
+ cli.log.info('Python code in `bin/qmk` and `lib/python` is correctly formatted.')
+ return True
except subprocess.CalledProcessError:
- cli.log.error('Error formatting python code!')
+ if cli.args.dry_run:
+ cli.log.error('Python code in `bin/qmk` and `lib/python` incorrectly formatted!')
+ else:
+ cli.log.error('Error formatting python code!')
+
+ return False