Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Strip API specific output from qmk info #20234

Merged
merged 2 commits into from
Mar 23, 2023
Merged

Strip API specific output from qmk info #20234

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4824ca0
Strip API specific output from `qmk info`
zvecr Mar 22, 2023
1bfec8c
tidy
zvecr Mar 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions lib/python/qmk/cli/info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,29 @@
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.
"""
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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))
Expand Down