summaryrefslogtreecommitdiffstats
path: root/lib/python
diff options
context:
space:
mode:
Diffstat (limited to 'lib/python')
-rw-r--r--lib/python/qmk/cli/__init__.py9
-rwxr-xr-xlib/python/qmk/cli/cformat.py28
-rwxr-xr-xlib/python/qmk/cli/compile.py17
-rw-r--r--lib/python/qmk/cli/doctor/check.py93
-rw-r--r--lib/python/qmk/cli/doctor/linux.py34
-rwxr-xr-xlib/python/qmk/cli/doctor/main.py8
-rw-r--r--lib/python/qmk/cli/doctor/windows.py8
-rwxr-xr-xlib/python/qmk/cli/fileformat.py23
-rw-r--r--lib/python/qmk/cli/flash.py61
-rwxr-xr-xlib/python/qmk/cli/generate/api.py56
-rw-r--r--lib/python/qmk/cli/generate/keycodes.py55
-rw-r--r--lib/python/qmk/cli/generate/keycodes_tests.py39
-rw-r--r--lib/python/qmk/cli/git/__init__.py0
-rw-r--r--lib/python/qmk/cli/git/submodule.py38
-rw-r--r--lib/python/qmk/cli/list/keyboards.py3
-rwxr-xr-xlib/python/qmk/cli/mass_compile.py2
-rw-r--r--lib/python/qmk/cli/migrate.py81
-rwxr-xr-xlib/python/qmk/cli/multibuild.py106
-rw-r--r--lib/python/qmk/cli/new/keyboard.py10
-rwxr-xr-xlib/python/qmk/cli/new/keymap.py56
-rwxr-xr-xlib/python/qmk/cli/pyformat.py24
-rw-r--r--lib/python/qmk/flashers.py14
-rw-r--r--lib/python/qmk/info.py31
-rw-r--r--lib/python/qmk/json_schema.py36
-rw-r--r--lib/python/qmk/keyboard.py10
-rw-r--r--lib/python/qmk/keycodes.py99
-rw-r--r--lib/python/qmk/keymap.py56
-rw-r--r--lib/python/qmk/painter.py80
-rw-r--r--lib/python/qmk/submodules.py26
29 files changed, 728 insertions, 375 deletions
diff --git a/lib/python/qmk/cli/__init__.py b/lib/python/qmk/cli/__init__.py
index 1da4d25741..778eccada8 100644
--- a/lib/python/qmk/cli/__init__.py
+++ b/lib/python/qmk/cli/__init__.py
@@ -34,13 +34,11 @@ subcommands = [
'qmk.cli.bux',
'qmk.cli.c2json',
'qmk.cli.cd',
- 'qmk.cli.cformat',
'qmk.cli.chibios.confmigrate',
'qmk.cli.clean',
'qmk.cli.compile',
'qmk.cli.docs',
'qmk.cli.doctor',
- 'qmk.cli.fileformat',
'qmk.cli.flash',
'qmk.cli.format.c',
'qmk.cli.format.json',
@@ -57,9 +55,11 @@ subcommands = [
'qmk.cli.generate.keyboard_c',
'qmk.cli.generate.keyboard_h',
'qmk.cli.generate.keycodes',
+ 'qmk.cli.generate.keycodes_tests',
'qmk.cli.generate.rgb_breathe_table',
'qmk.cli.generate.rules_mk',
'qmk.cli.generate.version_h',
+ 'qmk.cli.git.submodule',
'qmk.cli.hello',
'qmk.cli.import.kbfirmware',
'qmk.cli.import.keyboard',
@@ -67,16 +67,15 @@ subcommands = [
'qmk.cli.info',
'qmk.cli.json2c',
'qmk.cli.lint',
+ 'qmk.cli.kle2json',
'qmk.cli.list.keyboards',
'qmk.cli.list.keymaps',
'qmk.cli.list.layouts',
- 'qmk.cli.kle2json',
'qmk.cli.mass_compile',
- 'qmk.cli.multibuild',
+ 'qmk.cli.migrate',
'qmk.cli.new.keyboard',
'qmk.cli.new.keymap',
'qmk.cli.painter',
- 'qmk.cli.pyformat',
'qmk.cli.pytest',
'qmk.cli.via2json',
]
diff --git a/lib/python/qmk/cli/cformat.py b/lib/python/qmk/cli/cformat.py
deleted file mode 100755
index 9d0ecaeba3..0000000000
--- a/lib/python/qmk/cli/cformat.py
+++ /dev/null
@@ -1,28 +0,0 @@
-"""Point people to the new command name.
-"""
-import sys
-from pathlib import Path
-
-from milc import cli
-
-
-@cli.argument('-n', '--dry-run', arg_only=True, action='store_true', help="Flag only, don't automatically format.")
-@cli.argument('-b', '--base-branch', default='origin/master', help='Branch to compare to diffs to.')
-@cli.argument('-a', '--all-files', arg_only=True, action='store_true', help='Format all core files.')
-@cli.argument('--core-only', arg_only=True, action='store_true', help='Format core files only.')
-@cli.argument('files', nargs='*', arg_only=True, help='Filename(s) to format.')
-@cli.subcommand('Pointer to the new command name: qmk format-c.', hidden=True)
-def cformat(cli):
- """Pointer to the new command name: qmk format-c.
- """
- cli.log.warning('"qmk cformat" has been renamed to "qmk format-c". Please use the new command in the future.')
- argv = [sys.executable, *sys.argv]
- argv[argv.index('cformat')] = 'format-c'
- script_path = Path(argv[1])
- script_path_exe = Path(f'{argv[1]}.exe')
-
- if not script_path.exists() and script_path_exe.exists():
- # For reasons I don't understand ".exe" is stripped from the script name on windows.
- argv[1] = str(script_path_exe)
-
- return cli.run(argv, capture_output=False).returncode
diff --git a/lib/python/qmk/cli/compile.py b/lib/python/qmk/cli/compile.py
index 9e7629906f..f43e5f32de 100755
--- a/lib/python/qmk/cli/compile.py
+++ b/lib/python/qmk/cli/compile.py
@@ -10,7 +10,17 @@ import qmk.path
from qmk.decorators import automagic_keyboard, automagic_keymap
from qmk.commands import compile_configurator_json, create_make_command, parse_configurator_json, build_environment
from qmk.keyboard import keyboard_completer, keyboard_folder
-from qmk.keymap import keymap_completer
+from qmk.keymap import keymap_completer, locate_keymap
+
+
+def _is_keymap_target(keyboard, keymap):
+ if keymap == 'all':
+ return True
+
+ if locate_keymap(keyboard, keymap):
+ return True
+
+ return False
@cli.argument('filename', nargs='?', arg_only=True, type=qmk.path.FileType('r'), completer=FilesCompleter('.json'), help='The configurator export to compile')
@@ -43,6 +53,11 @@ def compile(cli):
elif cli.config.compile.keyboard and cli.config.compile.keymap:
# Generate the make command for a specific keyboard/keymap.
+ if not _is_keymap_target(cli.config.compile.keyboard, cli.config.compile.keymap):
+ cli.log.error('Invalid keymap argument.')
+ cli.print_help()
+ return False
+
if cli.args.clean:
commands.append(create_make_command(cli.config.compile.keyboard, cli.config.compile.keymap, 'clean', **envs))
commands.append(create_make_command(cli.config.compile.keyboard, cli.config.compile.keymap, parallel=cli.config.compile.parallel, **envs))
diff --git a/lib/python/qmk/cli/doctor/check.py b/lib/python/qmk/cli/doctor/check.py
index 8a0422ba72..cd69cdd11c 100644
--- a/lib/python/qmk/cli/doctor/check.py
+++ b/lib/python/qmk/cli/doctor/check.py
@@ -3,7 +3,7 @@
from enum import Enum
import re
import shutil
-from subprocess import DEVNULL
+from subprocess import DEVNULL, TimeoutExpired
from milc import cli
from qmk import submodules
@@ -41,9 +41,8 @@ def _parse_gcc_version(version):
def _check_arm_gcc_version():
"""Returns True if the arm-none-eabi-gcc version is not known to cause problems.
"""
- if 'output' in ESSENTIAL_BINARIES['arm-none-eabi-gcc']:
- version_number = ESSENTIAL_BINARIES['arm-none-eabi-gcc']['output'].strip()
- cli.log.info('Found arm-none-eabi-gcc version %s', version_number)
+ version_number = ESSENTIAL_BINARIES['arm-none-eabi-gcc']['output'].strip()
+ cli.log.info('Found arm-none-eabi-gcc version %s', version_number)
return CheckStatus.OK # Right now all known arm versions are ok
@@ -51,44 +50,37 @@ def _check_arm_gcc_version():
def _check_avr_gcc_version():
"""Returns True if the avr-gcc version is not known to cause problems.
"""
- rc = CheckStatus.ERROR
- if 'output' in ESSENTIAL_BINARIES['avr-gcc']:
- version_number = ESSENTIAL_BINARIES['avr-gcc']['output'].strip()
+ version_number = ESSENTIAL_BINARIES['avr-gcc']['output'].strip()
+ cli.log.info('Found avr-gcc version %s', version_number)
- cli.log.info('Found avr-gcc version %s', version_number)
- rc = CheckStatus.OK
+ parsed_version = _parse_gcc_version(version_number)
+ if parsed_version['major'] > 8:
+ cli.log.warning('{fg_yellow}We do not recommend avr-gcc newer than 8. Downgrading to 8.x is recommended.')
+ return CheckStatus.WARNING
- parsed_version = _parse_gcc_version(version_number)
- if parsed_version['major'] > 8:
- cli.log.warning('{fg_yellow}We do not recommend avr-gcc newer than 8. Downgrading to 8.x is recommended.')
- rc = CheckStatus.WARNING
-
- return rc
+ return CheckStatus.OK
def _check_avrdude_version():
- if 'output' in ESSENTIAL_BINARIES['avrdude']:
- last_line = ESSENTIAL_BINARIES['avrdude']['output'].split('\n')[-2]
- version_number = last_line.split()[2][:-1]
- cli.log.info('Found avrdude version %s', version_number)
+ last_line = ESSENTIAL_BINARIES['avrdude']['output'].split('\n')[-2]
+ version_number = last_line.split()[2][:-1]
+ cli.log.info('Found avrdude version %s', version_number)
return CheckStatus.OK
def _check_dfu_util_version():
- if 'output' in ESSENTIAL_BINARIES['dfu-util']:
- first_line = ESSENTIAL_BINARIES['dfu-util']['output'].split('\n')[0]
- version_number = first_line.split()[1]
- cli.log.info('Found dfu-util version %s', version_number)
+ first_line = ESSENTIAL_BINARIES['dfu-util']['output'].split('\n')[0]
+ version_number = first_line.split()[1]
+ cli.log.info('Found dfu-util version %s', version_number)
return CheckStatus.OK
def _check_dfu_programmer_version():
- if 'output' in ESSENTIAL_BINARIES['dfu-programmer']:
- first_line = ESSENTIAL_BINARIES['dfu-programmer']['output'].split('\n')[0]
- version_number = first_line.split()[1]
- cli.log.info('Found dfu-programmer version %s', version_number)
+ first_line = ESSENTIAL_BINARIES['dfu-programmer']['output'].split('\n')[0]
+ version_number = first_line.split()[1]
+ cli.log.info('Found dfu-programmer version %s', version_number)
return CheckStatus.OK
@@ -96,11 +88,16 @@ def _check_dfu_programmer_version():
def check_binaries():
"""Iterates through ESSENTIAL_BINARIES and tests them.
"""
- ok = True
+ ok = CheckStatus.OK
for binary in sorted(ESSENTIAL_BINARIES):
- if not is_executable(binary):
- ok = False
+ try:
+ if not is_executable(binary):
+ ok = CheckStatus.ERROR
+ except TimeoutExpired:
+ cli.log.debug('Timeout checking %s', binary)
+ if ok != CheckStatus.ERROR:
+ ok = CheckStatus.WARNING
return ok
@@ -108,8 +105,22 @@ def check_binaries():
def check_binary_versions():
"""Check the versions of ESSENTIAL_BINARIES
"""
+ checks = {
+ 'arm-none-eabi-gcc': _check_arm_gcc_version,
+ 'avr-gcc': _check_avr_gcc_version,
+ 'avrdude': _check_avrdude_version,
+ 'dfu-util': _check_dfu_util_version,
+ 'dfu-programmer': _check_dfu_programmer_version,
+ }
+
versions = []
- for check in (_check_arm_gcc_version, _check_avr_gcc_version, _check_avrdude_version, _check_dfu_util_version, _check_dfu_programmer_version):
+ for binary in sorted(ESSENTIAL_BINARIES):
+ if 'output' not in ESSENTIAL_BINARIES[binary]:
+ cli.log.warning('Unknown version for %s', binary)
+ versions.append(CheckStatus.WARNING)
+ continue
+
+ check = checks[binary]
versions.append(check())
return versions
@@ -119,10 +130,8 @@ def check_submodules():
"""
for submodule in submodules.status().values():
if submodule['status'] is None:
- cli.log.error('Submodule %s has not yet been cloned!', submodule['name'])
return CheckStatus.ERROR
elif not submodule['status']:
- cli.log.warning('Submodule %s is not up to date!', submodule['name'])
return CheckStatus.WARNING
return CheckStatus.OK
@@ -149,3 +158,21 @@ def is_executable(command):
cli.log.error("{fg_red}Can't run `%s %s`", command, version_arg)
return False
+
+
+def release_info(file='/etc/os-release'):
+ """Parse release info to dict
+ """
+ ret = {}
+ try:
+ with open(file) as f:
+ for line in f:
+ if '=' in line:
+ key, value = map(str.strip, line.split('=', 1))
+ if value.startswith('"') and value.endswith('"'):
+ value = value[1:-1]
+ ret[key] = value
+ except (PermissionError, FileNotFoundError):
+ pass
+
+ return ret
diff --git a/lib/python/qmk/cli/doctor/linux.py b/lib/python/qmk/cli/doctor/linux.py
index a803305c0d..f0850d4e64 100644
--- a/lib/python/qmk/cli/doctor/linux.py
+++ b/lib/python/qmk/cli/doctor/linux.py
@@ -7,7 +7,11 @@ from pathlib import Path
from milc import cli
from qmk.constants import QMK_FIRMWARE, BOOTLOADER_VIDS_PIDS
-from .check import CheckStatus
+from .check import CheckStatus, release_info
+
+
+def _is_wsl():
+ return 'microsoft' in platform.uname().release.lower()
def _udev_rule(vid, pid=None, *args):
@@ -78,10 +82,13 @@ def check_udev_rules():
# Collect all rules from the config files
for rule_file in udev_rules:
- for line in rule_file.read_text(encoding='utf-8').split('\n'):
- line = line.strip()
- if not line.startswith("#") and len(line):
- current_rules.add(line)
+ try:
+ for line in rule_file.read_text(encoding='utf-8').split('\n'):
+ line = line.strip()
+ if not line.startswith("#") and len(line):
+ current_rules.add(line)
+ except PermissionError:
+ cli.log.debug("Failed to read: %s", rule_file)
# Check if the desired rules are among the currently present rules
for bootloader, rules in desired_rules.items():
@@ -127,17 +134,22 @@ def check_modem_manager():
def os_test_linux():
"""Run the Linux specific tests.
"""
- # Don't bother with udev on WSL, for now
- if 'microsoft' in platform.uname().release.lower():
- cli.log.info("Detected {fg_cyan}Linux (WSL){fg_reset}.")
+ info = release_info()
+ release_id = info.get('PRETTY_NAME', info.get('ID', 'Unknown'))
+ plat = 'WSL, ' if _is_wsl() else ''
+ cli.log.info(f"Detected {{fg_cyan}}Linux ({plat}{release_id}){{fg_reset}}.")
+
+ # Don't bother with udev on WSL, for now
+ if _is_wsl():
# https://github.com/microsoft/WSL/issues/4197
if QMK_FIRMWARE.as_posix().startswith("/mnt"):
cli.log.warning("I/O performance on /mnt may be extremely slow.")
return CheckStatus.WARNING
- return CheckStatus.OK
else:
- cli.log.info("Detected {fg_cyan}Linux{fg_reset}.")
+ rc = check_udev_rules()
+ if rc != CheckStatus.OK:
+ return rc
- return check_udev_rules()
+ return CheckStatus.OK
diff --git a/lib/python/qmk/cli/doctor/main.py b/lib/python/qmk/cli/doctor/main.py
index 1600ab8dd4..6a6feb87d1 100755
--- a/lib/python/qmk/cli/doctor/main.py
+++ b/lib/python/qmk/cli/doctor/main.py
@@ -119,13 +119,15 @@ def doctor(cli):
# Make sure the basic CLI tools we need are available and can be executed.
bin_ok = check_binaries()
- if not bin_ok:
+ if bin_ok == CheckStatus.ERROR:
if yesno('Would you like to install dependencies?', default=True):
cli.run(['util/qmk_install.sh', '-y'], stdin=DEVNULL, capture_output=False)
bin_ok = check_binaries()
- if bin_ok:
+ if bin_ok == CheckStatus.OK:
cli.log.info('All dependencies are installed.')
+ elif bin_ok == CheckStatus.WARNING:
+ cli.log.warning('Issues encountered while checking dependencies.')
else:
status = CheckStatus.ERROR
@@ -142,7 +144,7 @@ def doctor(cli):
if sub_ok == CheckStatus.OK:
cli.log.info('Submodules are up to date.')
else:
- if yesno('Would you like to clone the submodules?', default=True):
+ if git_check_repo() and yesno('Would you like to clone the submodules?', default=True):
submodules.update()
sub_ok = check_submodules()
diff --git a/lib/python/qmk/cli/doctor/windows.py b/lib/python/qmk/cli/doctor/windows.py
index 381ab36fde..26bb65374b 100644
--- a/lib/python/qmk/cli/doctor/windows.py
+++ b/lib/python/qmk/cli/doctor/windows.py
@@ -2,7 +2,7 @@ import platform
from milc import cli
-from .check import CheckStatus
+from .check import CheckStatus, release_info
def os_test_windows():
@@ -11,4 +11,10 @@ def os_test_windows():
win32_ver = platform.win32_ver()
cli.log.info("Detected {fg_cyan}Windows %s (%s){fg_reset}.", win32_ver[0], win32_ver[1])
+ # MSYS really does not like "/" files - resolve manually
+ file = cli.run(['cygpath', '-m', '/etc/qmk-release']).stdout.strip()
+ qmk_distro_version = release_info(file).get('VERSION', None)
+ if qmk_distro_version:
+ cli.log.info('QMK MSYS version: %s', qmk_distro_version)
+
return CheckStatus.OK
diff --git a/lib/python/qmk/cli/fileformat.py b/lib/python/qmk/cli/fileformat.py
deleted file mode 100755
index cee4ba1acd..0000000000
--- a/lib/python/qmk/cli/fileformat.py
+++ /dev/null
@@ -1,23 +0,0 @@
-"""Point people to the new command name.
-"""
-import sys
-from pathlib import Path
-
-from milc import cli
-
-
-@cli.subcommand('Pointer to the new command name: qmk format-text.', hidden=True)
-def fileformat(cli):
- """Pointer to the new command name: qmk format-text.
- """
- cli.log.warning('"qmk fileformat" has been renamed to "qmk format-text". Please use the new command in the future.')
- argv = [sys.executable, *sys.argv]
- argv[argv.index('fileformat')] = 'format-text'
- script_path = Path(argv[1])
- script_path_exe = Path(f'{argv[1]}.exe')
-
- if not script_path.exists() and script_path_exe.exists():
- # For reasons I don't understand ".exe" is stripped from the script name on windows.
- argv[1] = str(script_path_exe)
-
- return cli.run(argv, capture_output=False).returncode
diff --git a/lib/python/qmk/cli/flash.py b/lib/python/qmk/cli/flash.py
index 40bfbdab56..8724f26889 100644
--- a/lib/python/qmk/cli/flash.py
+++ b/lib/python/qmk/cli/flash.py
@@ -11,12 +11,24 @@ import qmk.path
from qmk.decorators import automagic_keyboard, automagic_keymap
from qmk.commands import compile_configurator_json, create_make_command, parse_configurator_json, build_environment
from qmk.keyboard import keyboard_completer, keyboard_folder
+from qmk.keymap import keymap_completer, locate_keymap
from qmk.flashers import flasher
-def print_bootloader_help():
+def _is_keymap_target(keyboard, keymap):
+ if keymap == 'all':
+ return True
+
+ if locate_keymap(keyboard, keymap):
+ return True
+
+ return False
+
+
+def _list_bootloaders():
"""Prints the available bootloaders listed in docs.qmk.fm.
"""
+ cli.print_help()
cli.log.info('Here are the available bootloaders:')
cli.echo('\tavrdude')
cli.echo('\tbootloadhid')
@@ -36,14 +48,29 @@ def print_bootloader_help():
cli.echo('\tuf2-split-left')
cli.echo('\tuf2-split-right')
cli.echo('For more info, visit https://docs.qmk.fm/#/flashing')
+ return False
+
+
+def _flash_binary(filename, mcu):
+ """Try to flash binary firmware
+ """
+ cli.echo('Flashing binary firmware...\nPlease reset your keyboard into bootloader mode now!\nPress Ctrl-C to exit.\n')
+ try:
+ err, msg = flasher(mcu, filename)
+ if err:
+ cli.log.error(msg)
+ return False
+ except KeyboardInterrupt:
+ cli.log.info('Ctrl-C was pressed, exiting...')
+ return True
@cli.argument('filename', nargs='?', arg_only=True, type=qmk.path.FileType('r'), completer=FilesCompleter('.json'), help='A configurator export JSON to be compiled and flashed or a pre-compiled binary firmware file (bin/hex) to be flashed.')
@cli.argument('-b', '--bootloaders', action='store_true', help='List the available bootloaders.')
@cli.argument('-bl', '--bootloader', default='flash', help='The flash command, corresponding to qmk\'s make options of bootloaders.')
@cli.argument('-m', '--mcu', help='The MCU name. Required for HalfKay, HID, USBAspLoader and ISP flashing.')
-@cli.argument('-km', '--keymap', help='The keymap to build a firmware for. Use this if you dont have a configurator file. Ignored when a configurator file is supplied.')
-@cli.argument('-kb', '--keyboard', type=keyboard_folder, completer=keyboard_completer, help='The keyboard to build a firmware for. Use this if you dont have a configurator file. Ignored when a configurator file is supplied.')
+@cli.argument('-kb', '--keyboard', type=keyboard_folder, completer=keyboard_completer, help='The keyboard to build a firmware for. Ignored when a configurator export is supplied.')
+@cli.argument('-km', '--keymap', completer=keymap_completer, help='The keymap to build a firmware for. Ignored when a configurator export is supplied.')
@cli.argument('-n', '--dry-run', arg_only=True, action='store_true', help="Don't actually build, just show the make command to be run.")
@cli.argument('-j', '--parallel', type=int, default=1, help="Set the number of parallel make jobs; 0 means unlimited.")
@cli.argument('-e', '--env', arg_only=True, action='append', default=[], help="Set a variable to be passed to make. May be passed multiple times.")
@@ -56,30 +83,17 @@ def flash(cli):
If a binary firmware is supplied, try to flash that.
- If a Configurator JSON export is supplied this command will create a new keymap. Keymap and Keyboard arguments
- will be ignored.
+ If a Configurator export is supplied this command will create a new keymap, overwriting an existing keymap if one exists.
- If no file is supplied, keymap and keyboard are expected.
+ If a keyboard and keymap are provided this command will build a firmware based on that.
If bootloader is omitted the make system will use the configured bootloader for that keyboard.
"""
- if cli.args.filename and cli.args.filename.suffix in ['.bin', '.hex']:
- # Try to flash binary firmware
- cli.echo('Flashing binary firmware...\nPlease reset your keyboard into bootloader mode now!\nPress Ctrl-C to exit.\n')
- try:
- err, msg = flasher(cli.args.mcu, cli.args.filename)
- if err:
- cli.log.error(msg)
- return False
- except KeyboardInterrupt:
- cli.log.info('Ctrl-C was pressed, exiting...')
- return True
+ if cli.args.filename and cli.args.filename.suffix in ['.bin', '.hex', '.uf2']:
+ return _flash_binary(cli.args.filename, cli.args.mcu)
if cli.args.bootloaders:
- # Provide usage and list bootloaders
- cli.print_help()
- print_bootloader_help()
- return False
+ return _list_bootloaders()
# Build the environment vars
envs = build_environment(cli.args.env)
@@ -94,6 +108,11 @@ def flash(cli):
elif cli.config.flash.keyboard and cli.config.flash.keymap:
# Generate the make command for a specific keyboard/keymap.
+ if not _is_keymap_target(cli.config.flash.keyboard, cli.config.flash.keymap):
+ cli.log.error('Invalid keymap argument.')
+ cli.print_help()
+ return False
+
if cli.args.clean:
commands.append(create_make_command(cli.config.flash.keyboard, cli.config.flash.keymap, 'clean', **envs))
commands.append(create_make_command(cli.config.flash.keyboard, cli.config.flash.keymap, cli.args.bootloader, parallel=cli.config.flash.parallel, **envs))
diff --git a/lib/python/qmk/cli/generate/api.py b/lib/python/qmk/cli/generate/api.py
index 8650a36b84..11d4616199 100755
--- a/lib/python/qmk/cli/generate/api.py
+++ b/lib/python/qmk/cli/generate/api.py
@@ -10,8 +10,9 @@ from qmk.datetime import current_datetime
from qmk.info import info_json
from qmk.json_encoders import InfoJSONEncoder
from qmk.json_schema import json_load
+from qmk.keymap import list_keymaps
from qmk.keyboard import find_readme, list_keyboards
-from qmk.keycodes import load_spec, list_versions
+from qmk.keycodes import load_spec, list_versions, list_languages
DATA_PATH = Path('data')
TEMPLATE_PATH = DATA_PATH / 'templates/api/'
@@ -42,7 +43,14 @@ def _resolve_keycode_specs(output_folder):
overall = load_spec(version)
output_file = output_folder / f'constants/keycodes_{version}.json'
- output_file.write_text(json.dumps(overall, indent=4), encoding='utf-8')
+ output_file.write_text(json.dumps(overall), encoding='utf-8')
+
+ for lang in list_languages():
+ for version in list_versions(lang):
+ overall = load_spec(version, lang)
+
+ output_file = output_folder / f'constants/keycodes_{lang}_{version}.json'
+ output_file.write_text(json.dumps(overall, indent=4), encoding='utf-8')
# Purge files consumed by 'load_spec'
shutil.rmtree(output_folder / 'constants/keycodes/')
@@ -56,7 +64,7 @@ def _filtered_copy(src, dst):
data = json_load(src)
dst = dst.with_suffix('.json')
- dst.write_text(json.dumps(data, indent=4), encoding='utf-8')
+ dst.write_text(json.dumps(data), encoding='utf-8')
return dst
return shutil.copy2(src, dst)
@@ -103,24 +111,44 @@ def generate_api(cli):
# Generate and write keyboard specific JSON files
for keyboard_name in keyboard_list:
- kb_all[keyboard_name] = info_json(keyboard_name)
+ kb_json = info_json(keyboard_name)
+ kb_all[keyboard_name] = kb_json
+
keyboard_dir = v1_dir / 'keyboards' / keyboard_name
keyboard_info = keyboard_dir / 'info.json'
keyboard_readme = keyboard_dir / 'readme.md'
keyboard_readme_src = find_readme(keyboard_name)
+ # Populate the list of JSON keymaps
+ for keymap in list_keymaps(keyboard_name, c=False, fullpath=True):
+ kb_json['keymaps'][keymap.name] = {
+ # TODO: deprecate 'url' as consumer needs to know its potentially hjson
+ 'url': f'https://raw.githubusercontent.com/qmk/qmk_firmware/master/{keymap}/keymap.json',
+
+ # Instead consumer should grab from API and not repo directly
+ 'path': (keymap / 'keymap.json').as_posix(),
+ }
+
keyboard_dir.mkdir(parents=True, exist_ok=True)
- keyboard_json = json.dumps({'last_updated': current_datetime(), 'keyboards': {keyboard_name: kb_all[keyboard_name]}})
+ keyboard_json = json.dumps({'last_updated': current_datetime(), 'keyboards': {keyboard_name: kb_json}})
if not cli.args.dry_run:
- keyboard_info.write_text(keyboard_json)
+ keyboard_info.write_text(keyboard_json, encoding='utf-8')
cli.log.debug('Wrote file %s', keyboard_info)
if keyboard_readme_src:
shutil.copyfile(keyboard_readme_src, keyboard_readme)
cli.log.debug('Copied %s -> %s', keyboard_readme_src, keyboard_readme)
- if 'usb' in kb_all[keyboard_name]:
- usb = kb_all[keyboard_name]['usb']
+ # resolve keymaps as json
+ for keymap in kb_json['keymaps']:
+ keymap_hjson = kb_json['keymaps'][keymap]['path']
+ keymap_json = v1_dir / keymap_hjson
+ keymap_json.parent.mkdir(parents=True, exist_ok=True)
+ keymap_json.write_text(json.dumps(json_load(Path(keymap_hjson))), encoding='utf-8')
+ cli.log.debug('Wrote keymap %s', keymap_json)
+
+ if 'usb' in kb_json:
+ usb = kb_json['usb']
if 'vid' in usb and usb['vid'] not in usb_list:
usb_list[usb['vid']] = {}
@@ -153,9 +181,9 @@ def generate_api(cli):
constants_metadata_json = json.dumps({'last_updated': current_datetime(), 'constants': _list_constants(v1_dir)})
if not cli.args.dry_run:
- keyboard_all_file.write_text(keyboard_all_json)
- usb_file.write_text(usb_json)
- keyboard_list_file.write_text(keyboard_list_json)
- keyboard_aliases_file.write_text(keyboard_aliases_json)
- keyboard_metadata_file.write_text(keyboard_metadata_json)
- constants_metadata_file.write_text(constants_metadata_json)
+ keyboard_all_file.write_text(keyboard_all_json, encoding='utf-8')
+ usb_file.write_text(usb_json, encoding='utf-8')
+ keyboard_list_file.write_text(keyboard_list_json, encoding='utf-8')
+ keyboard_aliases_file.write_text(keyboard_aliases_json, encoding='utf-8')
+ keyboard_metadata_file.write_text(keyboard_metadata_json, encoding='utf-8')
+ constants_metadata_file.write_text(constants_metadata_json, encoding='utf-8')
diff --git a/lib/python/qmk/cli/generate/keycodes.py b/lib/python/qmk/cli/generate/keycodes.py
index 29b7db3c80..2ed84cd589 100644
--- a/lib/python/qmk/cli/generate/keycodes.py
+++ b/lib/python/qmk/cli/generate/keycodes.py
@@ -8,6 +8,24 @@ from qmk.path import normpath
from qmk.keycodes import load_spec
+def _render_key(key):
+ width = 7
+ if 'S(' in key:
+ width += len('S()')
+ if 'A(' in key:
+ width += len('A()')
+ if 'RCTL(' in key:
+ width += len('RCTL()')
+ if 'ALGR(' in key:
+ width += len('ALGR()')
+ return key.ljust(width)
+
+
+def _render_label(label):
+ label = label.replace("\\", "(backslash)")
+ return label
+
+
def _generate_ranges(lines, keycodes):
lines.append('')
lines.append('enum qk_keycode_ranges {')
@@ -67,6 +85,23 @@ def _generate_helpers(lines, keycodes):
lines.append(f'#define IS_{ group.upper() }_KEYCODE(code) ((code) >= {lo} && (code) <= {hi})')
+def _generate_aliases(lines, keycodes):
+ lines.append('')
+ lines.append('// Aliases')
+ for key, value in keycodes["aliases"].items():
+ define = _render_key(value.get("key"))
+ val = _render_key(key)
+ if 'label' in value:
+ lines.append(f'#define {define} {val} // {_render_label(value.get("label"))}')
+ else:
+ lines.append(f'#define {define} {val}')
+
+ lines.append('')
+ for key, value in keycodes["aliases"].items():
+ for alias in value.get("aliases", []):
+ lines.append(f'#define {alias} {value.get("key")}')
+
+
@cli.argument('-v', '--version', arg_only=True, required=True, help='Version of keycodes to generate.')
@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")
@@ -86,3 +121,23 @@ def generate_keycodes(cli):
# Show the results
dump_lines(cli.args.output, keycodes_h_lines, cli.args.quiet)
+
+
+@cli.argument('-v', '--version', arg_only=True, required=True, help='Version of keycodes to generate.')
+@cli.argument('-l', '--lang', arg_only=True, required=True, help='Language of keycodes to generate.')
+@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, onl