g1smo
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

JSON encoder: improve sorting of layout dict keys (#19974)

master
Ryan 2023-03-13 23:20:54 +11:00 committed by GitHub
parent cf5e9d172d
commit 91e0457b0e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 52 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/python/qmk/c_parse.py
View File

@ -11,7 +11,7 @@ from milc import cli
from qmk.comment_remover import comment_remover
default_key_entry = {'x': -1, 'y': 0, 'w': 1}
default_key_entry = {'x': -1, 'y': 0}
single_comment_regex = re.compile(r'\s+/[/*].*$')
multi_comment_regex = re.compile(r'/\*(.|\n)*?\*/', re.MULTILINE)
layout_macro_define_regex = re.compile(r'^#\s*define')

70
lib/python/qmk/json_encoders.py
View File

@ -27,7 +27,10 @@ class QMKJSONEncoder(json.JSONEncoder):
return float(obj)
def encode_list(self, obj):
def encode_dict_single_line(self, obj):
return "{" + ", ".join(f"{self.encode(key)}: {self.encode(element)}" for key, element in sorted(obj.items(), key=self.sort_layout)) + "}"
def encode_list(self, obj, key=None):
"""Encode a list-like object.
"""
if self.primitives_only(obj):
@ -35,22 +38,28 @@ class QMKJSONEncoder(json.JSONEncoder):
else:
self.indentation_level += 1
output = [self.indent_str + self.encode(element) for element in obj]
if key in ('layout', 'rotary'):
# These are part of a layout or led/encoder config, put them on a single line.
output = [self.indent_str + self.encode_dict_single_line(element) for element in obj]
else:
output = [self.indent_str + self.encode(element) for element in obj]
self.indentation_level -= 1
return "[\n" + ",\n".join(output) + "\n" + self.indent_str + "]"
def encode(self, obj):
def encode(self, obj, key=None):
"""Encode keymap.json objects for QMK.
"""
if isinstance(obj, Decimal):
return self.encode_decimal(obj)
elif isinstance(obj, (list, tuple)):
return self.encode_list(obj)
return self.encode_list(obj, key)
elif isinstance(obj, dict):
return self.encode_dict(obj)
return self.encode_dict(obj, key)
else:
return super().encode(obj)
@ -71,22 +80,43 @@ class QMKJSONEncoder(json.JSONEncoder):
class InfoJSONEncoder(QMKJSONEncoder):
"""Custom encoder to make info.json's a little nicer to work with.
"""
def encode_dict(self, obj):
def encode_dict(self, obj, key):
"""Encode info.json dictionaries.
"""
if obj:
if set(("x", "y")).issubset(obj.keys()):
# These are part of a layout/led_config, put them on a single line.
return "{ " + ", ".join(f"{self.encode(key)}: {self.encode(element)}" for key, element in sorted(obj.items())) + " }"
else:
self.indentation_level += 1
output = [self.indent_str + f"{json.dumps(key)}: {self.encode(value)}" for key, value in sorted(obj.items(), key=self.sort_dict)]
self.indentation_level -= 1
return "{\n" + ",\n".join(output) + "\n" + self.indent_str + "}"
self.indentation_level += 1
output = [self.indent_str + f"{json.dumps(k)}: {self.encode(v, k)}" for k, v in sorted(obj.items(), key=self.sort_dict)]
self.indentation_level -= 1
return "{\n" + ",\n".join(output) + "\n" + self.indent_str + "}"
else:
return "{}"
def sort_layout(self, key):
key = key[0]
if key == 'label':
return '00label'
elif key == 'matrix':
return '01matrix'
elif key == 'x':
return '02x'
elif key == 'y':
return '03y'
elif key == 'w':
return '04w'
elif key == 'h':
return '05h'
elif key == 'flags':
return '06flags'
return key
def sort_dict(self, key):
"""Forces layout to the back of the sort order.
"""
@ -120,21 +150,19 @@ class InfoJSONEncoder(QMKJSONEncoder):
class KeymapJSONEncoder(QMKJSONEncoder):
"""Custom encoder to make keymap.json's a little nicer to work with.
"""
def encode_dict(self, obj):
def encode_dict(self, obj, key):
"""Encode dictionary objects for keymap.json.
"""
if obj:
self.indentation_level += 1
output_lines = [f"{self.indent_str}{json.dumps(key)}: {self.encode(value)}" for key, value in sorted(obj.items(), key=self.sort_dict)]
output = ',\n'.join(output_lines)
output = [self.indent_str + f"{json.dumps(k)}: {self.encode(v, k)}" for k, v in sorted(obj.items(), key=self.sort_dict)]
self.indentation_level -= 1
return f"{{\n{output}\n{self.indent_str}}}"
return "{\n" + ",\n".join(output) + "\n" + self.indent_str + "}"
else:
return "{}"
def encode_list(self, obj):
def encode_list(self, obj, k=None):
"""Encode a list-like object.
"""
if self.indentation_level == 2:

4
lib/python/qmk/tests/test_cli_commands.py
View File

@ -291,7 +291,7 @@ def test_generate_version_h():
def test_format_json_keyboard():
result = check_subcommand('format-json', '--format', 'keyboard', 'lib/python/qmk/tests/minimal_info.json')
check_returncode(result)
assert result.stdout == '{\n "keyboard_name": "tester",\n "maintainer": "qmk",\n "layouts": {\n "LAYOUT": {\n "layout": [\n { "label": "KC_A", "matrix": [0, 0], "x": 0, "y": 0 }\n ]\n }\n }\n}\n'
assert result.stdout == '{\n "keyboard_name": "tester",\n "maintainer": "qmk",\n "layouts": {\n "LAYOUT": {\n "layout": [\n {"label": "KC_A", "matrix": [0, 0], "x": 0, "y": 0}\n ]\n }\n }\n}\n'
def test_format_json_keymap():
@ -303,7 +303,7 @@ def test_format_json_keymap():
def test_format_json_keyboard_auto():
result = check_subcommand('format-json', '--format', 'auto', 'lib/python/qmk/tests/minimal_info.json')
check_returncode(result)
assert result.stdout == '{\n "keyboard_name": "tester",\n "maintainer": "qmk",\n "layouts": {\n "LAYOUT": {\n "layout": [\n { "label": "KC_A", "matrix": [0, 0], "x": 0, "y": 0 }\n ]\n }\n }\n}\n'
assert result.stdout == '{\n "keyboard_name": "tester",\n "maintainer": "qmk",\n "layouts": {\n "LAYOUT": {\n "layout": [\n {"label": "KC_A", "matrix": [0, 0], "x": 0, "y": 0}\n ]\n }\n }\n}\n'
def test_format_json_keymap_auto():