From 962bc8d9dd413690dbeadeaac971a5389697210f Mon Sep 17 00:00:00 2001
From: Zach White <skullydazed@gmail.com>
Date: Sat, 9 Jan 2021 13:34:14 -0800
Subject: Use the schema to eliminate custom code (#11108)
* use the schema to eliminate custom code
* Update docs/reference_info_json.md
Co-authored-by: Ryan <fauxpark@gmail.com>
* make flake8 happy
* bugfix
* do not overwrite make vars from json
Co-authored-by: Ryan <fauxpark@gmail.com>
---
lib/python/qmk/cli/generate/info_json.py | 48 +++++++++++++++++++++-----------
lib/python/qmk/cli/generate/layouts.py | 4 +++
lib/python/qmk/cli/generate/rules_mk.py | 10 +++----
3 files changed, 41 insertions(+), 21 deletions(-)
(limited to 'lib/python/qmk/cli/generate')
diff --git a/lib/python/qmk/cli/generate/info_json.py b/lib/python/qmk/cli/generate/info_json.py
index fba4b1c014..f3fc54ddcf 100755
--- a/lib/python/qmk/cli/generate/info_json.py
+++ b/lib/python/qmk/cli/generate/info_json.py
@@ -4,14 +4,41 @@ Compile an info.json for a particular keyboard and pretty-print it.
"""
import json
+from jsonschema import Draft7Validator, validators
from milc import cli
-from qmk.info_json_encoder import InfoJSONEncoder
from qmk.decorators import automagic_keyboard, automagic_keymap
-from qmk.info import info_json
+from qmk.info import info_json, _jsonschema
+from qmk.info_json_encoder import InfoJSONEncoder
from qmk.path import is_keyboard
+def pruning_validator(validator_class):
+ """Extends Draft7Validator to remove properties that aren't specified in the schema.
+ """
+ validate_properties = validator_class.VALIDATORS["properties"]
+
+ def remove_additional_properties(validator, properties, instance, schema):
+ for prop in list(instance.keys()):
+ if prop not in properties:
+ del instance[prop]
+
+ for error in validate_properties(validator, properties, instance, schema):
+ yield error
+
+ return validators.extend(validator_class, {"properties": remove_additional_properties})
+
+
+def strip_info_json(kb_info_json):
+ """Remove the API-only properties from the info.json.
+ """
+ pruning_draft_7_validator = pruning_validator(Draft7Validator)
+ schema = _jsonschema('keyboard')
+ validator = pruning_draft_7_validator(schema).validate
+
+ return validator(kb_info_json)
+
+
@cli.argument('-kb', '--keyboard', help='Keyboard to show info for.')
@cli.argument('-km', '--keymap', help='Show the layers for a JSON keymap too.')
@cli.subcommand('Generate an info.json file for a keyboard.', hidden=False if cli.config.user.developer else True)
@@ -22,7 +49,7 @@ def generate_info_json(cli):
"""
# Determine our keyboard(s)
if not cli.config.generate_info_json.keyboard:
- cli.log.error('Missing paramater: --keyboard')
+ cli.log.error('Missing parameter: --keyboard')
cli.subcommands['info'].print_help()
return False
@@ -32,18 +59,7 @@ def generate_info_json(cli):
# Build the info.json file
kb_info_json = info_json(cli.config.generate_info_json.keyboard)
- pared_down_json = {}
-
- for key in ('manufacturer', 'maintainer', 'usb', 'keyboard_name', 'width', 'height', 'debounce', 'diode_direction', 'features', 'community_layouts', 'layout_aliases', 'matrix_pins', 'rgblight', 'url'):
- if key in kb_info_json:
- pared_down_json[key] = kb_info_json[key]
-
- pared_down_json['layouts'] = {}
- if 'layouts' in kb_info_json:
- for layout_name, layout in kb_info_json['layouts'].items():
- pared_down_json['layouts'][layout_name] = {}
- pared_down_json['layouts'][layout_name]['key_count'] = layout.get('key_count', len(layout['layout']))
- pared_down_json['layouts'][layout_name]['layout'] = layout['layout']
+ strip_info_json(kb_info_json)
# Display the results
- print(json.dumps(pared_down_json, indent=2, cls=InfoJSONEncoder))
+ print(json.dumps(kb_info_json, indent=2, cls=InfoJSONEncoder))
diff --git a/lib/python/qmk/cli/generate/layouts.py b/lib/python/qmk/cli/generate/layouts.py
index 273870e15c..b7baae0651 100755
--- a/lib/python/qmk/cli/generate/layouts.py
+++ b/lib/python/qmk/cli/generate/layouts.py
@@ -54,6 +54,10 @@ def generate_layouts(cli):
if kb_info_json['layouts'][layout_name]['c_macro']:
continue
+ if 'matrix' not in kb_info_json['layouts'][layout_name]['layout'][0]:
+ cli.log.debug('%s/%s: No matrix data!', cli.config.generate_layouts.keyboard, layout_name)
+ continue
+
layout_keys = []
layout_matrix = [['KC_NO' for i in range(col_num)] for i in range(row_num)]
diff --git a/lib/python/qmk/cli/generate/rules_mk.py b/lib/python/qmk/cli/generate/rules_mk.py
index 2a7e918569..0fdccb4048 100755
--- a/lib/python/qmk/cli/generate/rules_mk.py
+++ b/lib/python/qmk/cli/generate/rules_mk.py
@@ -37,26 +37,26 @@ def generate_rules_mk(cli):
# Bring in settings
for info_key, rule_key in info_to_rules.items():
- rules_mk_lines.append(f'{rule_key} := {kb_info_json[info_key]}')
+ rules_mk_lines.append(f'{rule_key} ?= {kb_info_json[info_key]}')
# Find features that should be enabled
if 'features' in kb_info_json:
for feature, enabled in kb_info_json['features'].items():
if feature == 'bootmagic_lite' and enabled:
- rules_mk_lines.append('BOOTMAGIC_ENABLE := lite')
+ rules_mk_lines.append('BOOTMAGIC_ENABLE ?= lite')
else:
feature = feature.upper()
enabled = 'yes' if enabled else 'no'
- rules_mk_lines.append(f'{feature}_ENABLE := {enabled}')
+ rules_mk_lines.append(f'{feature}_ENABLE ?= {enabled}')
# Set the LED driver
if 'led_matrix' in kb_info_json and 'driver' in kb_info_json['led_matrix']:
driver = kb_info_json['led_matrix']['driver']
- rules_mk_lines.append(f'LED_MATRIX_DRIVER = {driver}')
+ rules_mk_lines.append(f'LED_MATRIX_DRIVER ?= {driver}')
# Add community layouts
if 'community_layouts' in kb_info_json:
- rules_mk_lines.append(f'LAYOUTS = {" ".join(kb_info_json["community_layouts"])}')
+ rules_mk_lines.append(f'LAYOUTS ?= {" ".join(kb_info_json["community_layouts"])}')
# Show the results
rules_mk = '\n'.join(rules_mk_lines) + '\n'
--
cgit v1.2.3