From 4ab8734d6edd6894757507e70264eddca5429052 Mon Sep 17 00:00:00 2001 From: Zach White Date: Tue, 20 Jul 2021 11:52:14 -0700 Subject: 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 Co-authored-by: Erovia --- lib/python/qmk/cli/format/python.py | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100755 lib/python/qmk/cli/format/python.py (limited to 'lib/python/qmk/cli/format/python.py') diff --git a/lib/python/qmk/cli/format/python.py b/lib/python/qmk/cli/format/python.py new file mode 100755 index 0000000000..00612f97ec --- /dev/null +++ b/lib/python/qmk/cli/format/python.py @@ -0,0 +1,26 @@ +"""Format python code according to QMK's style. +""" +from subprocess import CalledProcessError, DEVNULL + +from milc import cli + + +@cli.argument('-n', '--dry-run', arg_only=True, action='store_true', help="Don't actually format.") +@cli.subcommand("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. + """ + edit = '--diff' if cli.args.dry_run else '--in-place' + yapf_cmd = ['yapf', '-vv', '--recursive', edit, 'bin/qmk', 'lib/python'] + try: + cli.run(yapf_cmd, check=True, capture_output=False, stdin=DEVNULL) + cli.log.info('Python code in `bin/qmk` and `lib/python` is correctly formatted.') + return True + + except CalledProcessError: + 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 -- cgit v1.2.3