mirrors/keychron_qmk_firmware
mirrors/keychron_qmk_firmware
0
0
Fork 0
mirror of https://github.com/Keychron/qmk_firmware.git synced 2024-11-22 00:16:41 +06:00
Code Issues Packages Projects Releases Wiki Activity

Strip API specific output from qmk info (#20234)

Browse Source
This commit is contained in:
Joel Challis 2023-03-23 11:19:30 +00:00 committed by GitHub
parent ad625e7c06
commit fa4dfb542f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
lib/python/qmk/cli/info.py
View File

@ -18,6 +18,29 @@ from qmk.path import is_keyboard
UNICODE_SUPPORT = sys.stdout.encoding.lower().startswith('utf')
def _strip_api_content(info_json):
# Ideally this would only be added in the API pathway.
info_json.pop('platform', None)
info_json.pop('platform_key', None)
info_json.pop('processor_type', None)
info_json.pop('protocol', None)
info_json.pop('config_h_features', None)
info_json.pop('keymaps', None)
info_json.pop('keyboard_folder', None)
info_json.pop('parse_errors', None)
info_json.pop('parse_warnings', None)
for layout in info_json.get('layouts', {}).values():
layout.pop('filename', None)
layout.pop('c_macro', None)
layout.pop('json_layout', None)
if 'matrix_pins' in info_json:
info_json.pop('matrix_size', None)
return info_json
def show_keymap(kb_info_json, title_caps=True):
"""Render the keymap in ascii art.
"""
@ -141,6 +164,7 @@ def print_parsed_rules_mk(keyboard_name):
@cli.argument('-f', '--format', default='friendly', arg_only=True, help='Format to display the data in (friendly, text, json) (Default: friendly).')
@cli.argument('--ascii', action='store_true', default=not UNICODE_SUPPORT, help='Render layout box drawings in ASCII only.')
@cli.argument('-r', '--rules-mk', action='store_true', help='Render the parsed values of the keyboard\'s rules.mk file.')
@cli.argument('-a', '--api', action='store_true', help='Show fully processed info intended for API consumption.')
@cli.subcommand('Keyboard information.')
@automagic_keyboard
@automagic_keymap
@ -171,6 +195,9 @@ def info(cli):
else:
kb_info_json = info_json(cli.config.info.keyboard)
if not cli.args.api:
kb_info_json = _strip_api_content(kb_info_json)
# Output in the requested format
if cli.args.format == 'json':
print(json.dumps(kb_info_json, cls=InfoJSONEncoder))