From c3c40dfda89d3d10bef90e08bf0600d1f4b1cd0e Mon Sep 17 00:00:00 2001
From: Joel Challis
Date: Fri, 3 Mar 2023 11:26:53 +0000
Subject: Remove some use of keymap.h (#19980)

---
 lib/python/qmk/cli/generate/keycodes.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'lib/python/qmk/cli')

diff --git a/lib/python/qmk/cli/generate/keycodes.py b/lib/python/qmk/cli/generate/keycodes.py
index 17503bac63..3b69b17ed1 100644
--- a/lib/python/qmk/cli/generate/keycodes.py
+++ b/lib/python/qmk/cli/generate/keycodes.py
@@ -143,7 +143,7 @@ def generate_keycode_extras(cli):
     """
 
     # Build the header file.
-    keycodes_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once', '#include "keymap.h"', '// clang-format off']
+    keycodes_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once', '#include "keycodes.h"', '// clang-format off']
 
     keycodes = load_spec(cli.args.version, cli.args.lang)
 
-- 
cgit v1.2.3


From fa4dfb542fb62e0279e679a10f1ea7e01b4bf61c Mon Sep 17 00:00:00 2001
From: Joel Challis
Date: Thu, 23 Mar 2023 11:19:30 +0000
Subject: Strip API specific output from `qmk info` (#20234)

---
 lib/python/qmk/cli/info.py | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

(limited to 'lib/python/qmk/cli')

diff --git a/lib/python/qmk/cli/info.py b/lib/python/qmk/cli/info.py
index fa5729bcc9..839139346c 100755
--- a/lib/python/qmk/cli/info.py
+++ b/lib/python/qmk/cli/info.py
@@ -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))
-- 
cgit v1.2.3


From e35bb8ebfad8b8ce40de98e9607fb6dbf8d8fff4 Mon Sep 17 00:00:00 2001
From: Joel Challis
Date: Mon, 27 Mar 2023 19:15:25 +0100
Subject: Add force support to 'qmk git-submodule' (#19705)

---
 lib/python/qmk/cli/git/submodule.py | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

(limited to 'lib/python/qmk/cli')

diff --git a/lib/python/qmk/cli/git/submodule.py b/lib/python/qmk/cli/git/submodule.py
index 9f354c021e..ef116ea124 100644
--- a/lib/python/qmk/cli/git/submodule.py
+++ b/lib/python/qmk/cli/git/submodule.py
@@ -7,14 +7,21 @@ from qmk import submodules
 
 REMOVE_DIRS = [
     'lib/ugfx',
-    'lib/pico-sdk',
     'lib/chibios-contrib/ext/mcux-sdk',
-    'lib/lvgl',
+]
+
+IGNORE_DIRS = [
+    'lib/arm_atsam',
+    'lib/fnv',
+    'lib/lib8tion',
+    'lib/python',
+    'lib/usbhost',
 ]
 
 
 @cli.argument('--check', arg_only=True, action='store_true', help='Check if the submodules are dirty, and display a warning if they are.')
 @cli.argument('--sync', arg_only=True, action='store_true', help='Shallow clone any missing submodules.')
+@cli.argument('-f', '--force', action='store_true', help='Flag to remove unexpected directories')
 @cli.subcommand('Git Submodule actions.')
 def git_submodule(cli):
     """Git Submodule actions
@@ -29,7 +36,15 @@ def git_submodule(cli):
                 cli.run(['git', 'submodule', 'update', '--depth=50', '--init', name], capture_output=False)
         return True
 
-    for folder in REMOVE_DIRS:
+    # can be the default behavior with: qmk config git_submodule.force=True
+    remove_dirs = REMOVE_DIRS
+    if cli.config.git_submodule.force:
+        # Also trash everything that isnt marked as "safe"
+        for path in normpath('lib').iterdir():
+            if not any(ignore in path.as_posix() for ignore in IGNORE_DIRS):
+                remove_dirs.append(path)
+
+    for folder in map(normpath, remove_dirs):
         if normpath(folder).is_dir():
             print(f"Removing '{folder}'")
             shutil.rmtree(folder)
-- 
cgit v1.2.3


From 79b0f9168eafef1642f3223500197bf630a2433f Mon Sep 17 00:00:00 2001
From: Joel Challis
Date: Mon, 27 Mar 2023 20:01:07 +0100
Subject: Custom keycodes in JSON (#19925)

---
 data/schemas/definitions.jsonschema                | 32 ++++++++++++++++
 data/schemas/keyboard.jsonschema                   |  1 +
 data/schemas/keycodes.jsonschema                   | 10 ++---
 data/schemas/keymap.jsonschema                     |  1 +
 .../pytest/basic/keymaps/dd_keycodes/keymap.json   | 12 ++++++
 lib/python/qmk/cli/generate/api.py                 |  6 +++
 lib/python/qmk/cli/generate/keyboard_h.py          | 44 +++++++++++++++++++---
 lib/python/qmk/info.py                             |  6 +++
 lib/python/qmk/keymap.py                           | 30 +++++++++++++++
 9 files changed, 129 insertions(+), 13 deletions(-)
 create mode 100644 keyboards/handwired/pytest/basic/keymaps/dd_keycodes/keymap.json

(limited to 'lib/python/qmk/cli')

diff --git a/data/schemas/definitions.jsonschema b/data/schemas/definitions.jsonschema
index 94a94157c0..b9c64a55ec 100644
--- a/data/schemas/definitions.jsonschema
+++ b/data/schemas/definitions.jsonschema
@@ -71,6 +71,38 @@
         "type": "string",
         "pattern": "^[0-9a-z][0-9a-z_/]*$"
     },
+    "keycode": {
+        "type": "string",
+        "minLength": 2,
+        "maxLength": 50,
+        "pattern": "^[A-Z][A-Zs_0-9]*$"
+    },
+    "keycode_short": {
+        "type": "string",
+        "minLength": 2,
+        "maxLength": 7,
+        "pattern": "^[A-Z][A-Zs_0-9]*$"
+    },
+    "keycode_decl": {
+        "type": "object",
+        "required": [
+            "key"
+        ],
+        "properties": {
+            "key": {"$ref": "#/keycode"},
+            "label": {"$ref": "#/text_identifier"},
+            "aliases": {
+                "type": "array",
+                "minItems": 1,
+                "items": {"$ref": "#/keycode_short"}
+            }
+        }
+    },
+    "keycode_decl_array": {
+        "type": "array",
+        "minItems": 1
+        "items": {"$ref": "#/keycode_decl"}
+    },
     "mcu_pin_array": {
         "type": "array",
         "items": {"$ref": "#/mcu_pin"}
diff --git a/data/schemas/keyboard.jsonschema b/data/schemas/keyboard.jsonschema
index aa1be6efa7..18b3514aa5 100644
--- a/data/schemas/keyboard.jsonschema
+++ b/data/schemas/keyboard.jsonschema
@@ -259,6 +259,7 @@
                 "on_state": {"$ref": "qmk.definitions.v1#/bit"}
             }
         },
+        "keycodes": {"$ref": "qmk.definitions.v1#/keycode_decl_array"},
         "layout_aliases": {
             "type": "object",
             "additionalProperties": {"$ref": "qmk.definitions.v1#/layout_macro"}
diff --git a/data/schemas/keycodes.jsonschema b/data/schemas/keycodes.jsonschema
index 77a8347b3b..df6ce95a83 100644
--- a/data/schemas/keycodes.jsonschema
+++ b/data/schemas/keycodes.jsonschema
@@ -8,11 +8,7 @@
             "type": "string",
             "minLength": 2,
             "maxLength": 50,
-            "pattern": "^[A-Zs_0-9]*$"
-        },
-        "hex_number_4d": {
-            "type": "string",
-            "pattern": "^0x[0-9A-F]{4}$"
+            "pattern": "^[A-Z][A-Zs_0-9]*$"
         }
     },
     "properties": {
@@ -34,10 +30,10 @@
         "keycodes": {
             "type": "object",
             "propertyNames": {
-                "$ref": "#/definitions/hex_number_4d"
+                "$ref": "qmk.definitions.v1#/hex_number_4d"
             },
             "additionalProperties": {
-                "type": "object",
+                "type": "object", // use 'qmk.definitions.v1#/keycode_decl' when problem keycodes are removed
                 "required": [
                     "key"
                 ],
diff --git a/data/schemas/keymap.jsonschema b/data/schemas/keymap.jsonschema
index 73aa7c5c22..7233e896e9 100644
--- a/data/schemas/keymap.jsonschema
+++ b/data/schemas/keymap.jsonschema
@@ -67,6 +67,7 @@
                 }
             }
         },
+        "keycodes": {"$ref": "qmk.definitions.v1#/keycode_decl_array"},
         "config": {"$ref": "qmk.keyboard.v1"},
         "notes": {
             "type": "string"
diff --git a/keyboards/handwired/pytest/basic/keymaps/dd_keycodes/keymap.json b/keyboards/handwired/pytest/basic/keymaps/dd_keycodes/keymap.json
new file mode 100644
index 0000000000..a64a65a80a
--- /dev/null
+++ b/keyboards/handwired/pytest/basic/keymaps/dd_keycodes/keymap.json
@@ -0,0 +1,12 @@
+{
+    "keyboard": "handwired/pytest/basic",
+    "keymap": "default_json",
+    "layout": "LAYOUT_ortho_1x1",
+    "layers": [["EXAMPLE_1"]],
+    "keycodes": [
+        { "key": "EXAMPLE_1" }
+    ],
+    "author": "qmk",
+    "notes": "This file is a keymap.json file for handwired/pytest/basic",
+    "version": 1
+}
diff --git a/lib/python/qmk/cli/generate/api.py b/lib/python/qmk/cli/generate/api.py
index 11d4616199..cfea3f3946 100755
--- a/lib/python/qmk/cli/generate/api.py
+++ b/lib/python/qmk/cli/generate/api.py
@@ -67,6 +67,12 @@ def _filtered_copy(src, dst):
         dst.write_text(json.dumps(data), encoding='utf-8')
         return dst
 
+    if dst.suffix == '.jsonschema':
+        data = json_load(src)
+
+        dst.write_text(json.dumps(data), encoding='utf-8')
+        return dst
+
     return shutil.copy2(src, dst)
 
 
diff --git a/lib/python/qmk/cli/generate/keyboard_h.py b/lib/python/qmk/cli/generate/keyboard_h.py
index 152921bdce..fa4036e39a 100755
--- a/lib/python/qmk/cli/generate/keyboard_h.py
+++ b/lib/python/qmk/cli/generate/keyboard_h.py
@@ -11,12 +11,9 @@ from qmk.keyboard import keyboard_completer, keyboard_folder
 from qmk.constants import COL_LETTERS, ROW_LETTERS, GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
 
 
-def _generate_layouts(keyboard):
-    """Generates the layouts.h file.
+def _generate_layouts(keyboard, kb_info_json):
+    """Generates the layouts macros.
     """
-    # Build the info.json file
-    kb_info_json = info_json(keyboard)
-
     if 'matrix_size' not in kb_info_json:
         cli.log.error(f'{keyboard}: Invalid matrix config.')
         return []
@@ -65,6 +62,32 @@ def _generate_layouts(keyboard):
     return lines
 
 
+def _generate_keycodes(kb_info_json):
+    """Generates keyboard level keycodes.
+    """
+    if 'keycodes' not in kb_info_json:
+        return []
+
+    lines = []
+    lines.append('enum keyboard_keycodes {')
+
+    for index, item in enumerate(kb_info_json.get('keycodes')):
+        key = item["key"]
+        if index == 0:
+            lines.append(f'  {key} = QK_KB_0,')
+        else:
+            lines.append(f'  {key},')
+
+    lines.append('};')
+
+    for item in kb_info_json.get('keycodes', []):
+        key = item["key"]
+        for alias in item.get("aliases", []):
+            lines.append(f'#define {alias} {key}')
+
+    return lines
+
+
 @cli.argument('-i', '--include', nargs='?', arg_only=True, help='Optional file to include')
 @cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to')
 @cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
@@ -73,8 +96,12 @@ def _generate_layouts(keyboard):
 def generate_keyboard_h(cli):
     """Generates the keyboard.h file.
     """
+    # Build the info.json file
+    kb_info_json = info_json(cli.args.keyboard)
+
     keyboard_h = cli.args.include
-    dd_layouts = _generate_layouts(cli.args.keyboard)
+    dd_layouts = _generate_layouts(cli.args.keyboard, kb_info_json)
+    dd_keycodes = _generate_keycodes(kb_info_json)
     valid_config = dd_layouts or keyboard_h
 
     # Build the layouts.h file.
@@ -87,6 +114,11 @@ def generate_keyboard_h(cli):
     if keyboard_h:
         keyboard_h_lines.append(f'#include "{Path(keyboard_h).name}"')
 
+    keyboard_h_lines.append('')
+    keyboard_h_lines.append('// Keycode content')
+    if dd_keycodes:
+        keyboard_h_lines.extend(dd_keycodes)
+
     # Protect against poorly configured keyboards
     if not valid_config:
         keyboard_h_lines.append('#error("<keyboard>.h is required unless your keyboard uses data-driven configuration. Please rename your keyboard\'s header file to <keyboard>.h")')
diff --git a/lib/python/qmk/info.py b/lib/python/qmk/info.py
index b7ee055eef..f4dcc507ef 100644
--- a/lib/python/qmk/info.py
+++ b/lib/python/qmk/info.py
@@ -103,6 +103,12 @@ def _validate(keyboard, info_data):
         if layout_name not in layouts and layout_name not in layout_aliases:
             _log_error(info_data, 'Claims to support community layout %s but no %s() macro found' % (layout, layout_name))
 
+    # keycodes with length > 7 must have short forms for visualisation purposes
+    for decl in info_data.get('keycodes', []):
+        if len(decl["key"]) > 7:
+            if not decl.get("aliases", []):
+                _log_error(info_data, f'Keycode {decl["key"]} has no short form alias')
+
 
 def info_json(keyboard):
     """Generate the info.json data for a specific keyboard.
diff --git a/lib/python/qmk/keymap.py b/lib/python/qmk/keymap.py
index dddf6449a7..8ae8a5ed19 100644
--- a/lib/python/qmk/keymap.py
+++ b/lib/python/qmk/keymap.py
@@ -25,6 +25,7 @@ __INCLUDES__
  * This file was generated by qmk json2c. You may or may not want to
  * edit it directly.
  */
+__KEYCODE_OUTPUT_GOES_HERE__
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 __KEYMAP_GOES_HERE__
@@ -123,6 +124,29 @@ def _generate_macros_function(keymap_json):
     return macro_txt
 
 
+def _generate_keycodes_function(keymap_json):
+    """Generates keymap level keycodes.
+    """
+    lines = []
+    lines.append('enum keymap_keycodes {')
+
+    for index, item in enumerate(keymap_json.get('keycodes', [])):
+        key = item["key"]
+        if index == 0:
+            lines.append(f'  {key} = QK_USER_0,')
+        else:
+            lines.append(f'  {key},')
+
+    lines.append('};')
+
+    for item in keymap_json.get('keycodes', []):
+        key = item["key"]
+        for alias in item.get("aliases", []):
+            lines.append(f'#define {alias} {key}')
+
+    return lines
+
+
 def template_json(keyboard):
     """Returns a `keymap.json` template for a keyboard.
 
@@ -317,6 +341,12 @@ def generate_c(keymap_json):
         hostlang = f'#include "keymap_{keymap_json["host_language"]}.h"\n#include "sendstring_{keymap_json["host_language"]}.h"\n'
     new_keymap = new_keymap.replace('__INCLUDES__', hostlang)
 
+    keycodes = ''
+    if 'keycodes' in keymap_json and keymap_json['keycodes'] is not None:
+        keycodes_txt = _generate_keycodes_function(keymap_json)
+        keycodes = '\n'.join(keycodes_txt)
+    new_keymap = new_keymap.replace('__KEYCODE_OUTPUT_GOES_HERE__', keycodes)
+
     return new_keymap
 
 
-- 
cgit v1.2.3


From dc75c23f5c4768d48e6e77fb4e795ff0e0ee2d7f Mon Sep 17 00:00:00 2001
From: Ryan
Date: Fri, 19 May 2023 16:05:43 +1000
Subject: CLI: Improve keymap folder resolution (#20981)

---
 lib/python/qmk/cli/new/keymap.py      |  8 ++++----
 lib/python/qmk/importers.py           |  4 ++--
 lib/python/qmk/keymap.py              |  4 ++--
 lib/python/qmk/path.py                | 25 ++++++++++++++++++++++---
 lib/python/qmk/tests/test_qmk_path.py |  4 ++--
 5 files changed, 32 insertions(+), 13 deletions(-)

(limited to 'lib/python/qmk/cli')

diff --git a/lib/python/qmk/cli/new/keymap.py b/lib/python/qmk/cli/new/keymap.py
index e7823bc46d..9b0ac221a4 100755
--- a/lib/python/qmk/cli/new/keymap.py
+++ b/lib/python/qmk/cli/new/keymap.py
@@ -5,7 +5,7 @@ import shutil
 from milc import cli
 from milc.questions import question
 
-from qmk.path import is_keyboard, keymap
+from qmk.path import is_keyboard, keymaps, keymap
 from qmk.git import git_get_username
 from qmk.decorators import automagic_keyboard, automagic_keymap
 from qmk.keyboard import keyboard_completer, keyboard_folder
@@ -50,9 +50,9 @@ def new_keymap(cli):
         return False
 
     # generate keymap paths
-    km_path = keymap(kb_name)
-    keymap_path_default = km_path / 'default'
-    keymap_path_new = km_path / user_name
+    keymaps_dirs = keymaps(kb_name)
+    keymap_path_default = keymap(kb_name, 'default')
+    keymap_path_new = keymaps_dirs[0] / user_name
 
     if not keymap_path_default.exists():
         cli.log.error(f'Default keymap {{fg_cyan}}{keymap_path_default}{{fg_reset}} does not exist!')
diff --git a/lib/python/qmk/importers.py b/lib/python/qmk/importers.py
index 307c66ee3c..edc1f940da 100644
--- a/lib/python/qmk/importers.py
+++ b/lib/python/qmk/importers.py
@@ -5,7 +5,7 @@ import json
 
 from qmk.git import git_get_username
 from qmk.json_schema import validate
-from qmk.path import keyboard, keymap
+from qmk.path import keyboard, keymaps
 from qmk.constants import MCU2BOOTLOADER, LEGACY_KEYCODES
 from qmk.json_encoders import InfoJSONEncoder, KeymapJSONEncoder
 from qmk.json_schema import deep_update, json_load
@@ -84,7 +84,7 @@ def import_keymap(keymap_data):
     kb_name = keymap_data['keyboard']
     km_name = keymap_data['keymap']
 
-    km_folder = keymap(kb_name) / km_name
+    km_folder = keymaps(kb_name)[0] / km_name
     keyboard_keymap = km_folder / 'keymap.json'
 
     # This is the deepest folder in the expected tree
diff --git a/lib/python/qmk/keymap.py b/lib/python/qmk/keymap.py
index 825267a1fe..11e8d39dad 100644
--- a/lib/python/qmk/keymap.py
+++ b/lib/python/qmk/keymap.py
@@ -379,7 +379,7 @@ def write_json(keyboard, keymap, layout, layers, macros=None):
     """
     keymap_json = generate_json(keyboard, keymap, layout, layers, macros=None)
     keymap_content = json.dumps(keymap_json)
-    keymap_file = qmk.path.keymap(keyboard) / keymap / 'keymap.json'
+    keymap_file = qmk.path.keymaps(keyboard)[0] / keymap / 'keymap.json'
 
     return write_file(keymap_file, keymap_content)
 
@@ -406,7 +406,7 @@ def write(keymap_json):
             A list of macros for this keymap.
     """
     keymap_content = generate_c(keymap_json)
-    keymap_file = qmk.path.keymap(keymap_json['keyboard']) / keymap_json['keymap'] / 'keymap.c'
+    keymap_file = qmk.path.keymaps(keymap_json['keyboard'])[0] / keymap_json['keymap'] / 'keymap.c'
 
     return write_file(keymap_file, keymap_content)
 
diff --git a/lib/python/qmk/path.py b/lib/python/qmk/path.py
index 556d0eefc8..9d248451b8 100644
--- a/lib/python/qmk/path.py
+++ b/lib/python/qmk/path.py
@@ -36,8 +36,8 @@ def keyboard(keyboard_name):
     return Path('keyboards') / keyboard_name
 
 
-def keymap(keyboard_name):
-    """Locate the correct directory for storing a keymap.
+def keymaps(keyboard_name):
+    """Returns all of the `keymaps/` directories for a given keyboard.
 
     Args:
 
@@ -45,17 +45,36 @@ def keymap(keyboard_name):
             The name of the keyboard. Example: clueboard/66/rev3
     """
     keyboard_folder = keyboard(keyboard_name)
+    found_dirs = []
 
     for _ in range(MAX_KEYBOARD_SUBFOLDERS):
         if (keyboard_folder / 'keymaps').exists():
-            return (keyboard_folder / 'keymaps').resolve()
+            found_dirs.append((keyboard_folder / 'keymaps').resolve())
 
         keyboard_folder = keyboard_folder.parent
 
+    if len(found_dirs) > 0:
+        return found_dirs
+
     logging.error('Could not find the keymaps directory!')
     raise NoSuchKeyboardError('Could not find keymaps directory for: %s' % keyboard_name)
 
 
+def keymap(keyboard_name, keymap_name):
+    """Locate the directory of a given keymap.
+
+    Args:
+
+        keyboard_name
+            The name of the keyboard. Example: clueboard/66/rev3
+        keymap_name
+            The name of the keymap. Example: default
+    """
+    for keymap_dir in keymaps(keyboard_name):
+        if (keymap_dir / keymap_name).exists():
+            return (keymap_dir / keymap_name).resolve()
+
+
 def normpath(path):
     """Returns a `pathlib.Path()` object for a given path.
 
diff --git a/lib/python/qmk/tests/test_qmk_path.py b/lib/python/qmk/tests/test_qmk_path.py
index 4b5132f13d..cc068e39da 100644
--- a/lib/python/qmk/tests/test_qmk_path.py
+++ b/lib/python/qmk/tests/test_qmk_path.py
@@ -5,8 +5,8 @@ import qmk.path
 
 
 def test_keymap_pytest_basic():
-    path = qmk.path.keymap('handwired/pytest/basic')
-    assert path.samefile('keyboards/handwired/pytest/basic/keymaps')
+    path = qmk.path.keymap('handwired/pytest/basic', 'default')
+    assert path.samefile('keyboards/handwired/pytest/basic/keymaps/default')
 
 
 def test_normpath():
-- 
cgit v1.2.3


From 7b31c18d464356bde219c5b3fff346f3e7a89d1a Mon Sep 17 00:00:00 2001
From: Peter
Date: Sat, 20 May 2023 12:11:57 +0000
Subject: Fix English word list retrieval in qmk generate-autocorrect-data
 (#20915)

---
 lib/python/qmk/cli/generate/autocorrect_data.py | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'lib/python/qmk/cli')

diff --git a/lib/python/qmk/cli/generate/autocorrect_data.py b/lib/python/qmk/cli/generate/autocorrect_data.py
index 5b70e0cb4e..b11c66d95d 100644
--- a/lib/python/qmk/cli/generate/autocorrect_data.py
+++ b/lib/python/qmk/cli/generate/autocorrect_data.py
@@ -63,7 +63,13 @@ def parse_file(file_name: str) -> List[Tuple[str, str]]:
   """
 
     try:
+        import english_words
+        correct_words = english_words.get_english_words_set(['web2'], lower=True, alpha=True)
+    except AttributeError:
         from english_words import english_words_lower_alpha_set as correct_words
+        if not cli.args.quiet:
+            cli.echo('The english_words package is outdated, update by running:')
+            cli.echo('  {fg_cyan}python3 -m pip install english_words --upgrade')
     except ImportError:
         if not cli.args.quiet:
             cli.echo('Autocorrection will falsely trigger when a typo is a substring of a correctly spelled word.')
-- 
cgit v1.2.3


From 102c42b14bc79a178d16ae5217d739490a312ea4 Mon Sep 17 00:00:00 2001
From: Ryan
Date: Sat, 20 May 2023 22:14:43 +1000
Subject: `qmk find`: usability improvements (#20440)

---
 docs/cli_commands.md       | 19 ++++++++++++++--
 lib/python/qmk/cli/find.py | 12 ++++++----
 lib/python/qmk/makefile.py |  2 +-
 lib/python/qmk/search.py   | 56 +++++++++++++++++++++++++++++++++-------------
 4 files changed, 67 insertions(+), 22 deletions(-)

(limited to 'lib/python/qmk/cli')

diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index d759c9c35a..79fd9de575 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -165,16 +165,31 @@ qmk find -f 'processor=STM32F411'
 qmk find -f 'processor=STM32F411' -f 'features.rgb_matrix=true'
 ```
 
+The following filter expressions are also supported:
+
+ - `exists(key)`: Match targets where `key` is present.
+ - `absent(key)`: Match targets where `key` is not present.
+ - `contains(key, value)`: Match targets where `key` contains `value`. Can be used for strings, arrays and object keys.
+ - `length(key, value)`: Match targets where the length of `key` is `value`. Can be used for strings, arrays and objects.
+
+You can also list arbitrary values for each matched target with `--print`:
+
+```
+qmk find -f 'processor=STM32F411' -p 'keyboard_name' -p 'features.rgb_matrix'
+```
+
 **Usage**:
 
 ```
-qmk find [-h] [-km KEYMAP] [-f FILTER]
+qmk find [-h] [-km KEYMAP] [-p PRINT] [-f FILTER]
 
 options:
   -km KEYMAP, --keymap KEYMAP
                         The keymap name to build. Default is 'default'.
+  -p PRINT, --print PRINT
+                        For each matched target, print the value of the supplied info.json key. May be passed multiple times.
   -f FILTER, --filter FILTER
-                        Filter the list of keyboards based on the supplied value in rules.mk. Matches info.json structure, and accepts the formats 'features.rgblight=true' or 'exists(matrix_pins.direct)'. May be passed multiple times, all filters need to match. Value may include wildcards such as '*' and '?'.
+                        Filter the list of keyboards based on their info.json data. Accepts the formats key=value, function(key), or function(key,value), eg. 'features.rgblight=true'. Valid functions are 'absent', 'contains', 'exists' and 'length'. May be passed multiple times; all filters need to match. Value may include wildcards such as '*' and '?'.
 ```
 
 ## `qmk console`
diff --git a/lib/python/qmk/cli/find.py b/lib/python/qmk/cli/find.py
index b6f74380ab..b8340f5f33 100644
--- a/lib/python/qmk/cli/find.py
+++ b/lib/python/qmk/cli/find.py
@@ -11,13 +11,17 @@ from qmk.search import search_keymap_targets
     action='append',
     default=[],
     help=  # noqa: `format-python` and `pytest` don't agree here.
-    "Filter the list of keyboards based on the supplied value in rules.mk. Matches info.json structure, and accepts the formats 'features.rgblight=true' or 'exists(matrix_pins.direct)'. May be passed multiple times, all filters need to match. Value may include wildcards such as '*' and '?'."  # noqa: `format-python` and `pytest` don't agree here.
+    "Filter the list of keyboards based on their info.json data. Accepts the formats key=value, function(key), or function(key,value), eg. 'features.rgblight=true'. Valid functions are 'absent', 'contains', 'exists' and 'length'. May be passed multiple times; all filters need to match. Value may include wildcards such as '*' and '?'."  # noqa: `format-python` and `pytest` don't agree here.
 )
+@cli.argument('-p', '--print', arg_only=True, action='append', default=[], help="For each matched target, print the value of the supplied info.json key. May be passed multiple times.")
 @cli.argument('-km', '--keymap', type=str, default='default', help="The keymap name to build. Default is 'default'.")
 @cli.subcommand('Find builds which match supplied search criteria.')
 def find(cli):
     """Search through all keyboards and keymaps for a given search criteria.
     """
-    targets = search_keymap_targets(cli.args.keymap, cli.args.filter)
-    for target in targets:
-        print(f'{target[0]}:{target[1]}')
+    targets = search_keymap_targets(cli.args.keymap, cli.args.filter, cli.args.print)
+    for keyboard, keymap, print_vals in targets:
+        print(f'{keyboard}:{keymap}')
+
+        for key, val in print_vals:
+            print(f'    {key}={val}')
diff --git a/lib/python/qmk/makefile.py b/lib/python/qmk/makefile.py
index 02c2e70050..ae95abbf23 100644
--- a/lib/python/qmk/makefile.py
+++ b/lib/python/qmk/makefile.py
@@ -18,7 +18,7 @@ def parse_rules_mk_file(file, rules_mk=None):
 
     file = Path(file)
     if file.exists():
-        rules_mk_lines = file.read_text().split("\n")
+        rules_mk_lines = file.read_text(encoding='utf-8').split("\n")
 
         for line in rules_mk_lines:
             # Filter out comments
diff --git a/lib/python/qmk/search.py b/lib/python/qmk/search.py
index af48900e6b..8728890b27 100644
--- a/lib/python/qmk/search.py
+++ b/lib/python/qmk/search.py
@@ -45,7 +45,7 @@ def _load_keymap_info(keyboard, keymap):
         return (keyboard, keymap, keymap_json(keyboard, keymap))
 
 
-def search_keymap_targets(keymap='default', filters=[]):
+def search_keymap_targets(keymap='default', filters=[], print_vals=[]):
     targets = []
 
     with multiprocessing.Pool() as pool:
@@ -66,14 +66,43 @@ def search_keymap_targets(keymap='default', filters=[]):
             cli.log.info('Parsing data for all matching keyboard/keymap combinations...')
             valid_keymaps = [(e[0], e[1], dotty(e[2])) for e in pool.starmap(_load_keymap_info, target_list)]
 
+            function_re = re.compile(r'^(?P<function>[a-zA-Z]+)\((?P<key>[a-zA-Z0-9_\.]+)(,\s*(?P<value>[^#]+))?\)$')
             equals_re = re.compile(r'^(?P<key>[a-zA-Z0-9_\.]+)\s*=\s*(?P<value>[^#]+)$')
-            exists_re = re.compile(r'^exists\((?P<key>[a-zA-Z0-9_\.]+)\)$')
-            for filter_txt in filters:
-                f = equals_re.match(filter_txt)
-                if f is not None:
-                    key = f.group('key')
-                    value = f.group('value')
-                    cli.log.info(f'Filtering on condition ("{key}" == "{value}")...')
+
+            for filter_expr in filters:
+                function_match = function_re.match(filter_expr)
+                equals_match = equals_re.match(filter_expr)
+
+                if function_match is not None:
+                    func_name = function_match.group('function').lower()
+                    key = function_match.group('key')
+                    value = function_match.group('value')
+
+                    if value is not None:
+                        if func_name == 'length':
+                            valid_keymaps = filter(lambda e: key in e[2] and len(e[2].get(key)) == int(value), valid_keymaps)
+                        elif func_name == 'contains':
+                            valid_keymaps = filter(lambda e: key in e[2] and value in e[2].get(key), valid_keymaps)
+                        else:
+                            cli.log.warning(f'Unrecognized filter expression: {function_match.group(0)}')
+                            continue
+
+                        cli.log.info(f'Filtering on condition: {{fg_green}}{func_name}{{fg_reset}}({{fg_cyan}}{key}{{fg_reset}}, {{fg_cyan}}{value}{{fg_reset}})...')
+                    else:
+                        if func_name == 'exists':
+                            valid_keymaps = filter(lambda e: key in e[2], valid_keymaps)
+                        elif func_name == 'absent':
+                            valid_keymaps = filter(lambda e: key not in e[2], valid_keymaps)
+                        else:
+                            cli.log.warning(f'Unrecognized filter expression: {function_match.group(0)}')
+                            continue
+
+                        cli.log.info(f'Filtering on condition: {{fg_green}}{func_name}{{fg_reset}}({{fg_cyan}}{key}{{fg_reset}})...')
+
+                elif equals_match is not None:
+                    key = equals_match.group('key')
+                    value = equals_match.group('value')
+                    cli.log.info(f'Filtering on condition: {{fg_cyan}}{key}{{fg_reset}} == {{fg_cyan}}{value}{{fg_reset}}...')
 
                     def _make_filter(k, v):
                         expr = fnmatch.translate(v)
@@ -87,13 +116,10 @@ def search_keymap_targets(keymap='default', filters=[]):
                         return f
 
                     valid_keymaps = filter(_make_filter(key, value), valid_keymaps)
+                else:
+                    cli.log.warning(f'Unrecognized filter expression: {filter_expr}')
+                    continue
 
-                f = exists_re.match(filter_txt)
-                if f is not None:
-                    key = f.group('key')
-                    cli.log.info(f'Filtering on condition (exists: "{key}")...')
-                    valid_keymaps = filter(lambda e: e[2].get(key) is not None, valid_keymaps)
-
-            targets = [(e[0], e[1]) for e in valid_keymaps]
+            targets = [(e[0], e[1], [(p, e[2].get(p)) for p in print_vals]) for e in valid_keymaps]
 
     return targets
-- 
cgit v1.2.3


From 6d90fa2300b463f5cc6920022a445d5ed217124c Mon Sep 17 00:00:00 2001
From: Ryan
Date: Sat, 20 May 2023 22:15:05 +1000
Subject: `qmk format-json`: Expose full key path and respect `sort_keys`
 (#20836)

---
 lib/python/qmk/cli/c2json.py             |  2 +-
 lib/python/qmk/cli/format/json.py        |  2 +-
 lib/python/qmk/cli/generate/info_json.py |  2 +-
 lib/python/qmk/cli/info.py               |  2 +-
 lib/python/qmk/cli/migrate.py            |  2 +-
 lib/python/qmk/cli/new/keyboard.py       |  2 +-
 lib/python/qmk/cli/via2json.py           |  2 +-
 lib/python/qmk/importers.py              |  6 +--
 lib/python/qmk/json_encoders.py          | 80 +++++++++++++++-----------------
 9 files changed, 48 insertions(+), 52 deletions(-)

(limited to 'lib/python/qmk/cli')

diff --git a/lib/python/qmk/cli/c2json.py b/lib/python/qmk/cli/c2json.py
index 43110a9387..7f6aca070a 100644
--- a/lib/python/qmk/cli/c2json.py
+++ b/lib/python/qmk/cli/c2json.py
@@ -57,7 +57,7 @@ def c2json(cli):
         cli.args.output.parent.mkdir(parents=True, exist_ok=True)
         if cli.args.output.exists():
             cli.args.output.replace(cli.args.output.parent / (cli.args.output.name + '.bak'))
-        cli.args.output.write_text(json.dumps(keymap_json, cls=InfoJSONEncoder))
+        cli.args.output.write_text(json.dumps(keymap_json, cls=InfoJSONEncoder, sort_keys=True))
 
         if not cli.args.quiet:
             cli.log.info('Wrote keymap to %s.', cli.args.output)
diff --git a/lib/python/qmk/cli/format/json.py b/lib/python/qmk/cli/format/json.py
index 19d504491f..058b613294 100755
--- a/lib/python/qmk/cli/format/json.py
+++ b/lib/python/qmk/cli/format/json.py
@@ -62,4 +62,4 @@ def format_json(cli):
                 json_file['layers'][layer_num] = current_layer
 
     # Display the results
-    print(json.dumps(json_file, cls=json_encoder))
+    print(json.dumps(json_file, cls=json_encoder, sort_keys=True))
diff --git a/lib/python/qmk/cli/generate/info_json.py b/lib/python/qmk/cli/generate/info_json.py
index 0dc80f10cc..08c294146b 100755
--- a/lib/python/qmk/cli/generate/info_json.py
+++ b/lib/python/qmk/cli/generate/info_json.py
@@ -76,7 +76,7 @@ def generate_info_json(cli):
     # Build the info.json file
     kb_info_json = info_json(cli.config.generate_info_json.keyboard)
     strip_info_json(kb_info_json)
-    info_json_text = json.dumps(kb_info_json, indent=4, cls=InfoJSONEncoder)
+    info_json_text = json.dumps(kb_info_json, indent=4, cls=InfoJSONEncoder, sort_keys=True)
 
     if cli.args.output:
         # Write to a file
diff --git a/lib/python/qmk/cli/info.py b/lib/python/qmk/cli/info.py
index 839139346c..cfb73ce1fd 100755
--- a/lib/python/qmk/cli/info.py
+++ b/lib/python/qmk/cli/info.py
@@ -200,7 +200,7 @@ def info(cli):
 
     # Output in the requested format
     if cli.args.format == 'json':
-        print(json.dumps(kb_info_json, cls=InfoJSONEncoder))
+        print(json.dumps(kb_info_json, cls=InfoJSONEncoder, sort_keys=True))
         return True
     elif cli.args.format == 'text':
         print_dotted_output(kb_info_json)
diff --git a/lib/python/qmk/cli/migrate.py b/lib/python/qmk/cli/migrate.py
index 4164f9c8ad..c1b1ad1ea9 100644
--- a/lib/python/qmk/cli/migrate.py
+++ b/lib/python/qmk/cli/migrate.py
@@ -75,7 +75,7 @@ def migrate(cli):
 
     # Finally write out updated info.json
     cli.log.info(f'  Updating {target_info}')
-    target_info.write_text(json.dumps(info_data.to_dict(), cls=InfoJSONEncoder))
+    target_info.write_text(json.dumps(info_data.to_dict(), cls=InfoJSONEncoder, sort_keys=True))
 
     cli.log.info(f'{{fg_green}}Migration of keyboard {{fg_cyan}}{cli.args.keyboard}{{fg_green}} complete!{{fg_reset}}')
     cli.log.info(f"Verify build with {{fg_yellow}}qmk compile -kb {cli.args.keyboard} -km default{{fg_reset}}.")
diff --git a/lib/python/qmk/cli/new/keyboard.py b/lib/python/qmk/cli/new/keyboard.py
index cdd3919168..ce956d0ce1 100644
--- a/lib/python/qmk/cli/new/keyboard.py
+++ b/lib/python/qmk/cli/new/keyboard.py
@@ -102,7 +102,7 @@ def augment_community_info(src, dest):
         item["matrix"] = [int(item["y"]), int(item["x"])]
 
     # finally write out the updated info.json
-    dest.write_text(json.dumps(info, cls=InfoJSONEncoder))
+    dest.write_text(json.dumps(info, cls=InfoJSONEncoder, sort_keys=True))
 
 
 def _question(*args, **kwargs):
diff --git a/lib/python/qmk/cli/via2json.py b/lib/python/qmk/cli/via2json.py
index 6edc9dfbe5..77823b5d9d 100755
--- a/lib/python/qmk/cli/via2json.py
+++ b/lib/python/qmk/cli/via2json.py
@@ -141,5 +141,5 @@ def via2json(cli):
     # Generate the keymap.json
     keymap_json = generate_json(cli.args.keymap, cli.args.keyboard, keymap_layout, keymap_data, macro_data)
 
-    keymap_lines = [json.dumps(keymap_json, cls=KeymapJSONEncoder)]
+    keymap_lines = [json.dumps(keymap_json, cls=KeymapJSONEncoder, sort_keys=True)]
     dump_lines(cli.args.output, keymap_lines, cli.args.quiet)
diff --git a/lib/python/qmk/importers.py b/lib/python/qmk/importers.py
index edc1f940da..8c449a7194 100644
--- a/lib/python/qmk/importers.py
+++ b/lib/python/qmk/importers.py
@@ -91,7 +91,7 @@ def import_keymap(keymap_data):
     keyboard_keymap.parent.mkdir(parents=True, exist_ok=True)
 
     # Dump out all those lovely files
-    keyboard_keymap.write_text(json.dumps(keymap_data, cls=KeymapJSONEncoder))
+    keyboard_keymap.write_text(json.dumps(keymap_data, cls=KeymapJSONEncoder, sort_keys=True))
 
     return (kb_name, km_name)
 
@@ -139,8 +139,8 @@ def import_keyboard(info_data, keymap_data=None):
     temp = json_load(keyboard_info)
     deep_update(temp, info_data)
 
-    keyboard_info.write_text(json.dumps(temp, cls=InfoJSONEncoder))
-    keyboard_keymap.write_text(json.dumps(keymap_data, cls=KeymapJSONEncoder))
+    keyboard_info.write_text(json.dumps(temp, cls=InfoJSONEncoder, sort_keys=True))
+    keyboard_keymap.write_text(json.dumps(keymap_data, cls=KeymapJSONEncoder, sort_keys=True))
 
     return kb_name
 
diff --git a/lib/python/qmk/json_encoders.py b/lib/python/qmk/json_encoders.py
index e61c63aff3..1e90f6a288 100755
--- a/lib/python/qmk/json_encoders.py
+++ b/lib/python/qmk/json_encoders.py
@@ -27,39 +27,56 @@ class QMKJSONEncoder(json.JSONEncoder):
 
         return float(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_dict(self, obj, path):
+        """Encode a dict-like object.
+        """
+        if obj:
+            self.indentation_level += 1
+
+            items = sorted(obj.items(), key=self.sort_dict) if self.sort_keys else obj.items()
+            output = [self.indent_str + f"{json.dumps(key)}: {self.encode(value, path + [key])}" for key, value in items]
 
-    def encode_list(self, obj, key=None):
+            self.indentation_level -= 1
+
+            return "{\n" + ",\n".join(output) + "\n" + self.indent_str + "}"
+        else:
+            return "{}"
+
+    def encode_dict_single_line(self, obj, path):
+        """Encode a dict-like object onto a single line.
+        """
+        return "{" + ", ".join(f"{json.dumps(key)}: {self.encode(value, path + [key])}" for key, value in sorted(obj.items(), key=self.sort_layout)) + "}"
+
+    def encode_list(self, obj, path):
         """Encode a list-like object.
         """
         if self.primitives_only(obj):
-            return "[" + ", ".join(self.encode(element) for element in obj) + "]"
+            return "[" + ", ".join(self.encode(value, path + [index]) for index, value in enumerate(obj)) + "]"
 
         else:
             self.indentation_level += 1
 
-            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]
+            if path[-1] in ('layout', 'rotary'):
+                # These are part of a LED layout or encoder config, put them on a single line
+                output = [self.indent_str + self.encode_dict_single_line(value, path + [index]) for index, value in enumerate(obj)]
             else:
-                output = [self.indent_str + self.encode(element) for element in obj]
+                output = [self.indent_str + self.encode(value, path + [index]) for index, value in enumerate(obj)]
 
             self.indentation_level -= 1
 
             return "[\n" + ",\n".join(output) + "\n" + self.indent_str + "]"
 
-    def encode(self, obj, key=None):
-        """Encode keymap.json objects for QMK.
+    def encode(self, obj, path=[]):
+        """Encode JSON objects for QMK.
         """
         if isinstance(obj, Decimal):
             return self.encode_decimal(obj)
 
         elif isinstance(obj, (list, tuple)):
-            return self.encode_list(obj, key)
+            return self.encode_list(obj, path)
 
         elif isinstance(obj, dict):
-            return self.encode_dict(obj, key)
+            return self.encode_dict(obj, path)
 
         else:
             return super().encode(obj)
@@ -80,19 +97,10 @@ 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, key):
-        """Encode info.json dictionaries.
+    def sort_layout(self, item):
+        """Sorts the hashes in a nice way.
         """
-        if obj:
-            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]
+        key = item[0]
 
         if key == 'label':
             return '00label'
@@ -117,14 +125,14 @@ class InfoJSONEncoder(QMKJSONEncoder):
 
         return key
 
-    def sort_dict(self, key):
+    def sort_dict(self, item):
         """Forces layout to the back of the sort order.
         """
-        key = key[0]
+        key = item[0]
 
         if self.indentation_level == 1:
             if key == 'manufacturer':
-                return '10keyboard_name'
+                return '10manufacturer'
 
             elif key == 'keyboard_name':
                 return '11keyboard_name'
@@ -150,19 +158,7 @@ class InfoJSONEncoder(QMKJSONEncoder):
 class KeymapJSONEncoder(QMKJSONEncoder):
     """Custom encoder to make keymap.json's a little nicer to work with.
     """
-    def encode_dict(self, obj, key):
-        """Encode dictionary objects for keymap.json.
-        """
-        if obj:
-            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 encode_list(self, obj, k=None):
+    def encode_list(self, obj, path):
         """Encode a list-like object.
         """
         if self.indentation_level == 2:
@@ -196,10 +192,10 @@ class KeymapJSONEncoder(QMKJSONEncoder):
 
             return "[\n" + ",\n".join(output) + "\n" + self.indent_str + "]"
 
-    def sort_dict(self, key):
+    def sort_dict(self, item):
         """Sorts the hashes in a nice way.
         """
-        key = key[0]
+        key = item[0]
 
         if self.indentation_level == 1:
             if key == 'version':
-- 
cgit v1.2.3


From fb056c543765b1c8ed7dae031a36ed2d04b1c718 Mon Sep 17 00:00:00 2001
From: Joel Challis
Date: Mon, 22 May 2023 07:03:59 +0100
Subject: Update json2c to use dump_lines (#21013)

---
 lib/python/qmk/cli/json2c.py              | 19 +++----------------
 lib/python/qmk/tests/test_cli_commands.py |  4 ++--
 2 files changed, 5 insertions(+), 18 deletions(-)

(limited to 'lib/python/qmk/cli')

diff --git a/lib/python/qmk/cli/json2c.py b/lib/python/qmk/cli/json2c.py
index 2873a9bfd3..a2db314947 100755
--- a/lib/python/qmk/cli/json2c.py
+++ b/lib/python/qmk/cli/json2c.py
@@ -5,7 +5,7 @@ from milc import cli
 
 import qmk.keymap
 import qmk.path
-from qmk.commands import parse_configurator_json
+from qmk.commands import dump_lines, parse_configurator_json
 
 
 @cli.argument('-o', '--output', arg_only=True, type=qmk.path.normpath, help='File to write to')
@@ -21,21 +21,8 @@ def json2c(cli):
     # Parse the configurator from json file (or stdin)
     user_keymap = parse_configurator_json(cli.args.filename)
 
-    # Environment processing
-    if cli.args.output and cli.args.output.name == '-':
-        cli.args.output = None
-
     # Generate the keymap
     keymap_c = qmk.keymap.generate_c(user_keymap)
 
-    if cli.args.output:
-        cli.args.output.parent.mkdir(parents=True, exist_ok=True)
-        if cli.args.output.exists():
-            cli.args.output.replace(cli.args.output.parent / (cli.args.output.name + '.bak'))
-        cli.args.output.write_text(keymap_c)
-
-        if not cli.args.quiet:
-            cli.log.info('Wrote keymap to %s.', cli.args.output)
-
-    else:
-        print(keymap_c)
+    # Show the results
+    dump_lines(cli.args.output, keymap_c.split('\n'), cli.args.quiet)
diff --git a/lib/python/qmk/tests/test_cli_commands.py b/lib/python/qmk/tests/test_cli_commands.py
index 13359808a0..1725e3ea79 100644
--- a/lib/python/qmk/tests/test_cli_commands.py
+++ b/lib/python/qmk/tests/test_cli_commands.py
@@ -144,7 +144,7 @@ def test_list_keymaps_no_keyboard_found():
 def test_json2c():
     result = check_subcommand('json2c', 'keyboards/handwired/pytest/has_template/keymaps/default_json/keymap.json')
     check_returncode(result)
-    assert result.stdout == '#include QMK_KEYBOARD_H\nconst uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {\t[0] = LAYOUT_ortho_1x1(KC_A)};\n\n'
+    assert result.stdout == '#include QMK_KEYBOARD_H\nconst uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {\t[0] = LAYOUT_ortho_1x1(KC_A)};\n\n\n'
 
 
 def test_json2c_macros():
@@ -158,7 +158,7 @@ def test_json2c_macros():
 def test_json2c_stdin():
     result = check_subcommand_stdin('keyboards/handwired/pytest/has_template/keymaps/default_json/keymap.json', 'json2c', '-')
     check_returncode(result)
-    assert result.stdout == '#include QMK_KEYBOARD_H\nconst uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {\t[0] = LAYOUT_ortho_1x1(KC_A)};\n\n'
+    assert result.stdout == '#include QMK_KEYBOARD_H\nconst uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {\t[0] = LAYOUT_ortho_1x1(KC_A)};\n\n\n'
 
 
 def test_json2c_wrong_json():
-- 
cgit v1.2.3


From 6e41377824a42487bb4a1d24fc95d7301477ca97 Mon Sep 17 00:00:00 2001
From: Joel Challis
Date: Wed, 24 May 2023 23:27:57 +0100
Subject: qmk info - Remove printing of "Keyboard Folder" (#21033)

---
 lib/python/qmk/cli/info.py | 1 -
 1 file changed, 1 deletion(-)

(limited to 'lib/python/qmk/cli')

diff --git a/lib/python/qmk/cli/info.py b/lib/python/qmk/cli/info.py
index cfb73ce1fd..02cc6051ec 100755
--- a/lib/python/qmk/cli/info.py
+++ b/lib/python/qmk/cli/info.py
@@ -104,7 +104,6 @@ def print_friendly_output(kb_info_json):
         cli.echo('{fg_blue}Maintainer{fg_reset}: QMK Community')
     else:
         cli.echo('{fg_blue}Maintainer{fg_reset}: %s', kb_info_json['maintainer'])
-    cli.echo('{fg_blue}Keyboard Folder{fg_reset}: %s', kb_info_json.get('keyboard_folder', 'Unknown'))
     cli.echo('{fg_blue}Layouts{fg_reset}: %s', ', '.join(sorted(kb_info_json['layouts'].keys())))
     cli.echo('{fg_blue}Processor{fg_reset}: %s', kb_info_json.get('processor', 'Unknown'))
     cli.echo('{fg_blue}Bootloader{fg_reset}: %s', kb_info_json.get('bootloader', 'Unknown'))
-- 
cgit v1.2.3


From 5642bd18077061fa21f4850124a9f4eeb8f23ca3 Mon Sep 17 00:00:00 2001
From: Nick Brassel
Date: Sat, 27 May 2023 13:23:07 +1000
Subject: Fix up `qmk find` when not specifying filters. (#21059)

---
 lib/python/qmk/cli/find.py | 4 ++++
 lib/python/qmk/search.py   | 2 +-
 2 files changed, 5 insertions(+), 1 deletion(-)

(limited to 'lib/python/qmk/cli')

diff --git a/lib/python/qmk/cli/find.py b/lib/python/qmk/cli/find.py
index b8340f5f33..2836eb8a54 100644
--- a/lib/python/qmk/cli/find.py
+++ b/lib/python/qmk/cli/find.py
@@ -19,6 +19,10 @@ from qmk.search import search_keymap_targets
 def find(cli):
     """Search through all keyboards and keymaps for a given search criteria.
     """
+
+    if len(cli.args.filter) == 0 and len(cli.args.print) > 0:
+        cli.log.warning('No filters supplied -- keymaps not parsed, unable to print requested values.')
+
     targets = search_keymap_targets(cli.args.keymap, cli.args.filter, cli.args.print)
     for keyboard, keymap, print_vals in targets:
         print(f'{keyboard}:{keymap}')
diff --git a/lib/python/qmk/search.py b/lib/python/qmk/search.py
index 8728890b27..c8ce85b96e 100644
--- a/lib/python/qmk/search.py
+++ b/lib/python/qmk/search.py
@@ -61,7 +61,7 @@ def search_keymap_targets(keymap='default', filters=[], print_vals=[]):
             target_list = [(kb, keymap) for kb in filter(lambda kb: kb is not None, pool.starmap(_keymap_exists, [(kb, keymap) for kb in qmk.keyboard.list_keyboards()]))]
 
         if len(filters) == 0:
-            targets = target_list
+            targets = [(kb, km, {}) for kb, km in target_list]
         else:
             cli.log.info('Parsing data for all matching keyboard/keymap combinations...')
             valid_keymaps = [(e[0], e[1], dotty(e[2])) for e in pool.starmap(_load_keymap_info, target_list)]
-- 
cgit v1.2.3