darkkirb/qmk_firmware
1
0
Fork 0
forked from mirrors/qmk_firmware
Code Issues Pull requests Projects Releases Packages Wiki Activity

make our schema validation more compact and flexible

Browse source
This commit is contained in:
Zach White 2021-06-21 12:30:26 -07:00
parent 846da06380
commit 6d20b28354
3 changed files with 6 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
lib/python/qmk/cli/format/json.py
View file

@ -8,7 +8,7 @@ from jsonschema import ValidationError
from milc import cli from milc import cli
from qmk.info import info_json from qmk.info import info_json
from qmk.json_schema import json_load, keyboard_validate from qmk.json_schema import json_load, validate
from qmk.json_encoders import InfoJSONEncoder, KeymapJSONEncoder from qmk.json_encoders import InfoJSONEncoder, KeymapJSONEncoder
from qmk.path import normpath from qmk.path import normpath
@ -23,14 +23,13 @@ def format_json(cli):
if cli.args.format == 'auto': if cli.args.format == 'auto':
try: try:
keyboard_validate(json_file) validate(json_file, 'qmk.keyboard.v1')
json_encoder = InfoJSONEncoder json_encoder = InfoJSONEncoder
except ValidationError as e: except ValidationError as e:
cli.log.warning('File %s did not validate as a keyboard:\n\t%s', cli.args.json_file, e) cli.log.warning('File %s did not validate as a keyboard:\n\t%s', cli.args.json_file, e)
cli.log.info('Treating %s as a keymap file.', cli.args.json_file) cli.log.info('Treating %s as a keymap file.', cli.args.json_file)
json_encoder = KeymapJSONEncoder json_encoder = KeymapJSONEncoder
elif cli.args.format == 'keyboard': elif cli.args.format == 'keyboard':
json_encoder = InfoJSONEncoder json_encoder = InfoJSONEncoder
elif cli.args.format == 'keymap': elif cli.args.format == 'keymap':

6
lib/python/qmk/info.py
View file

@ -9,7 +9,7 @@ from milc import cli
from qmk.constants import CHIBIOS_PROCESSORS, LUFA_PROCESSORS, VUSB_PROCESSORS from qmk.constants import CHIBIOS_PROCESSORS, LUFA_PROCESSORS, VUSB_PROCESSORS
from qmk.c_parse import find_layouts from qmk.c_parse import find_layouts
from qmk.json_schema import deep_update, json_load, keyboard_validate, keyboard_api_validate from qmk.json_schema import deep_update, json_load, validate
from qmk.keyboard import config_h, rules_mk from qmk.keyboard import config_h, rules_mk
from qmk.keymap import list_keymaps from qmk.keymap import list_keymaps
from qmk.makefile import parse_rules_mk_file from qmk.makefile import parse_rules_mk_file
@ -66,7 +66,7 @@ def info_json(keyboard):
# Validate against the jsonschema # Validate against the jsonschema
try: try:
keyboard_api_validate(info_data) validate(info_data, 'qmk.api.keyboard.v1')
except jsonschema.ValidationError as e: except jsonschema.ValidationError as e:
json_path = '.'.join([str(p) for p in e.absolute_path]) json_path = '.'.join([str(p) for p in e.absolute_path])
@ -496,7 +496,7 @@ def merge_info_jsons(keyboard, info_data):
continue continue
try: try:
keyboard_validate(new_info_data) validate(new_info_data, 'qmk.keyboard.v1')
except jsonschema.ValidationError as e: except jsonschema.ValidationError as e:
json_path = '.'.join([str(p) for p in e.absolute_path]) json_path = '.'.join([str(p) for p in e.absolute_path])
cli.log.error('Not including data from file: %s', info_file) cli.log.error('Not including data from file: %s', info_file)

14
lib/python/qmk/json_schema.py
View file

@ -61,20 +61,8 @@ def validate(data, schema):
return validator(data) return validator(data)
def keyboard_validate(data):
"""Validates data against the keyboard jsonschema.
"""
return validate(data, 'qmk.keyboard.v1')
def keyboard_api_validate(data):
"""Validates data against the api_keyboard jsonschema.
"""
return validate(data, 'qmk.api.keyboard.v1')
def deep_update(origdict, newdict): def deep_update(origdict, newdict):
"""Update a dictionary in place, recursing to do a deep copy. """Update a dictionary in place, recursing to do a depth-first deep copy.
""" """
for key, value in newdict.items(): for key, value in newdict.items():
if isinstance(value, Mapping): if isinstance(value, Mapping):