summaryrefslogtreecommitdiff
path: root/lib/python/qmk
diff options
context:
space:
mode:
authorZach White <skullydazed@users.noreply.github.com>2020-05-27 00:43:22 -0700
committerDrashna Jael're <drashna@live.com>2020-08-08 20:33:17 -0700
commit51912a8efcc5aa1e73dc67addb7c2ac9a5f651f8 (patch)
tree85aabf0dbca3ce7453895f638f48ff8d142fa46c /lib/python/qmk
parentea0abec564ede7612eb4335aec88dff6bd0a6324 (diff)
Fix running qmk info without any arguments (#9218)
Diffstat (limited to 'lib/python/qmk')
-rwxr-xr-xlib/python/qmk/cli/info.py93
-rw-r--r--lib/python/qmk/path.py7
2 files changed, 59 insertions, 41 deletions
diff --git a/lib/python/qmk/cli/info.py b/lib/python/qmk/cli/info.py
index 6977673e29..5e4b391411 100755
--- a/lib/python/qmk/cli/info.py
+++ b/lib/python/qmk/cli/info.py
@@ -72,6 +72,53 @@ def show_matrix(info_json, title_caps=True):
print(render_layout(info_json['layouts'][layout_name]['layout'], labels))
+def print_friendly_output(info_json):
+ """Print the info.json in a friendly text format.
+ """
+ cli.echo('{fg_blue}Keyboard Name{fg_reset}: %s', info_json.get('keyboard_name', 'Unknown'))
+ cli.echo('{fg_blue}Manufacturer{fg_reset}: %s', info_json.get('manufacturer', 'Unknown'))
+ if 'url' in info_json:
+ cli.echo('{fg_blue}Website{fg_reset}: %s', info_json.get('url', ''))
+ if info_json.get('maintainer', 'qmk') == 'qmk':
+ cli.echo('{fg_blue}Maintainer{fg_reset}: QMK Community')
+ else:
+ cli.echo('{fg_blue}Maintainer{fg_reset}: %s', info_json['maintainer'])
+ cli.echo('{fg_blue}Keyboard Folder{fg_reset}: %s', info_json.get('keyboard_folder', 'Unknown'))
+ cli.echo('{fg_blue}Layouts{fg_reset}: %s', ', '.join(sorted(info_json['layouts'].keys())))
+ if 'width' in info_json and 'height' in info_json:
+ cli.echo('{fg_blue}Size{fg_reset}: %s x %s' % (info_json['width'], info_json['height']))
+ cli.echo('{fg_blue}Processor{fg_reset}: %s', info_json.get('processor', 'Unknown'))
+ cli.echo('{fg_blue}Bootloader{fg_reset}: %s', info_json.get('bootloader', 'Unknown'))
+
+ if cli.config.info.layouts:
+ show_layouts(info_json, True)
+
+ if cli.config.info.matrix:
+ show_matrix(info_json, True)
+
+ if cli.config_source.info.keymap and cli.config_source.info.keymap != 'config_file':
+ show_keymap(info_json, True)
+
+
+def print_text_output(info_json):
+ """Print the info.json in a plain text format.
+ """
+ for key in sorted(info_json):
+ if key == 'layouts':
+ cli.echo('{fg_blue}layouts{fg_reset}: %s', ', '.join(sorted(info_json['layouts'].keys())))
+ else:
+ cli.echo('{fg_blue}%s{fg_reset}: %s', key, info_json[key])
+
+ if cli.config.info.layouts:
+ show_layouts(info_json, False)
+
+ if cli.config.info.matrix:
+ show_matrix(info_json, False)
+
+ if cli.config_source.info.keymap and cli.config_source.info.keymap != 'config_file':
+ show_keymap(info_json, False)
+
+
@cli.argument('-kb', '--keyboard', help='Keyboard to show info for.')
@cli.argument('-km', '--keymap', help='Show the layers for a JSON keymap too.')
@cli.argument('-l', '--layouts', action='store_true', help='Render the layouts.')
@@ -84,8 +131,13 @@ def info(cli):
"""Compile an info.json for a particular keyboard and pretty-print it.
"""
# Determine our keyboard(s)
+ if not cli.config.info.keyboard:
+ cli.log.error('Missing paramater: --keyboard')
+ cli.subcommands['info'].print_help()
+ exit(1)
+
if not is_keyboard(cli.config.info.keyboard):
- cli.log.error('Invalid keyboard: %s!', cli.config.info.keyboard)
+ cli.log.error('Invalid keyboard: "%s"', cli.config.info.keyboard)
exit(1)
# Build the info.json file
@@ -97,45 +149,10 @@ def info(cli):
exit()
if cli.args.format == 'text':
- for key in sorted(kb_info_json):
- if key == 'layouts':
- cli.echo('{fg_blue}layouts{fg_reset}: %s', ', '.join(sorted(kb_info_json['layouts'].keys())))
- else:
- cli.echo('{fg_blue}%s{fg_reset}: %s', key, kb_info_json[key])
-
- if cli.config.info.layouts:
- show_layouts(kb_info_json, False)
-
- if cli.config.info.matrix:
- show_matrix(kb_info_json, False)
-
- if cli.config_source.info.keymap and cli.config_source.info.keymap != 'config_file':
- show_keymap(kb_info_json, False)
+ print_text_output(kb_info_json)
elif cli.args.format == 'friendly':
- cli.echo('{fg_blue}Keyboard Name{fg_reset}: %s', kb_info_json.get('keyboard_name', 'Unknown'))
- cli.echo('{fg_blue}Manufacturer{fg_reset}: %s', kb_info_json.get('manufacturer', 'Unknown'))
- if 'url' in kb_info_json:
- cli.echo('{fg_blue}Website{fg_reset}: %s', kb_info_json['url'])
- if kb_info_json.get('maintainer') == 'qmk':
- cli.echo('{fg_blue}Maintainer{fg_reset}: QMK Community')
- else:
- cli.echo('{fg_blue}Maintainer{fg_reset}: %s', kb_info_json.get('maintainer', 'qmk'))
- cli.echo('{fg_blue}Keyboard Folder{fg_reset}: %s', kb_info_json.get('keyboard_folder', 'Unknown'))
- cli.echo('{fg_blue}Layouts{fg_reset}: %s', ', '.join(sorted(kb_info_json['layouts'].keys())))
- if 'width' in kb_info_json and 'height' in kb_info_json:
- cli.echo('{fg_blue}Size{fg_reset}: %s x %s' % (kb_info_json['width'], kb_info_json['height']))
- cli.echo('{fg_blue}Processor{fg_reset}: %s', kb_info_json.get('processor', 'Unknown'))
- cli.echo('{fg_blue}Bootloader{fg_reset}: %s', kb_info_json.get('bootloader', 'Unknown'))
-
- if cli.config.info.layouts:
- show_layouts(kb_info_json, True)
-
- if cli.config.info.matrix:
- show_matrix(kb_info_json, True)
-
- if cli.config_source.info.keymap and cli.config_source.info.keymap != 'config_file':
- show_keymap(kb_info_json, True)
+ print_friendly_output(kb_info_json)
else:
cli.log.error('Unknown format: %s', cli.args.format)
diff --git a/lib/python/qmk/path.py b/lib/python/qmk/path.py
index 8df6f0e915..591fad034b 100644
--- a/lib/python/qmk/path.py
+++ b/lib/python/qmk/path.py
@@ -11,9 +11,10 @@ from qmk.errors import NoSuchKeyboardError
def is_keyboard(keyboard_name):
"""Returns True if `keyboard_name` is a keyboard we can compile.
"""
- keyboard_path = QMK_FIRMWARE / 'keyboards' / keyboard_name
- rules_mk = keyboard_path / 'rules.mk'
- return rules_mk.exists()
+ if keyboard_name:
+ keyboard_path = QMK_FIRMWARE / 'keyboards' / keyboard_name
+ rules_mk = keyboard_path / 'rules.mk'
+ return rules_mk.exists()
def under_qmk_firmware():