Something went wrong. Try again.
keyboard stuff
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205"""This script automates the generation of the QMK API data."""from pathlib import Pathimport shutilimport json
from milc import cli
import qmk.pathfrom qmk.datetime import current_datetimefrom qmk.info import info_jsonfrom qmk.json_schema import json_loadfrom qmk.keymap import list_keymapsfrom qmk.keyboard import find_readme, list_keyboards, keyboard_alias_definitionsfrom qmk.keycodes import load_spec, list_versions, list_languages
DATA_PATH = Path('data')TEMPLATE_PATH = DATA_PATH / 'templates/api/'BUILD_API_PATH = Path('.build/api_data/')
def _list_constants(output_folder): """Produce a map of available constants """ ret = {} for file in (output_folder / 'constants').glob('**/*_[0-9].[0-9].[0-9].json'): name, version = file.stem.rsplit('_', 1) if name not in ret: ret[name] = [] ret[name].append(version)
# Ensure content is sorted for name in ret: ret[name] = sorted(ret[name])
return ret
def _resolve_keycode_specs(output_folder): """To make it easier for consumers, publish pre-merged spec files """ for version in list_versions(): overall = load_spec(version)
output_file = output_folder / f'constants/keycodes_{version}.json' output_file.write_text(json.dumps(overall, separators=(',', ':')), 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, separators=(',', ':')), encoding='utf-8')
# Purge files consumed by 'load_spec' shutil.rmtree(output_folder / 'constants/keycodes/')
def _filtered_copy(src, dst): src = Path(src) dst = Path(dst)
if dst.suffix == '.hjson': data = json_load(src)
dst = dst.with_suffix('.json') dst.write_text(json.dumps(data, separators=(',', ':')), 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)
def _filtered_keyboard_list(): """Perform basic filtering of list_keyboards """ keyboard_list = list_keyboards() if cli.args.filter: kb_list = [] for keyboard_name in keyboard_list: if any(i in keyboard_name for i in cli.args.filter): kb_list.append(keyboard_name) keyboard_list = kb_list return keyboard_list
@cli.argument('-n', '--dry-run', arg_only=True, action='store_true', help="Don't write the data to disk.")@cli.argument('-f', '--filter', arg_only=True, action='append', default=[], help="Filter the list of keyboards based on partial name matches the supplied value. May be passed multiple times.")@cli.subcommand('Generate QMK API data', hidden=False if cli.config.user.developer else True)def generate_api(cli): """Generates the QMK API data. """ v1_dir = BUILD_API_PATH / 'v1' keyboard_all_file = v1_dir / 'keyboards.json' # A massive JSON containing everything keyboard_list_file = v1_dir / 'keyboard_list.json' # A simple list of keyboard targets keyboard_aliases_file = v1_dir / 'keyboard_aliases.json' # A list of historical keyboard names and their new name keyboard_metadata_file = v1_dir / 'keyboard_metadata.json' # All the data configurator/via needs for initialization constants_metadata_file = v1_dir / 'constants_metadata.json' # Metadata for available constants usb_file = v1_dir / 'usb.json' # A mapping of USB VID/PID -> keyboard target
if BUILD_API_PATH.exists(): shutil.rmtree(BUILD_API_PATH)
shutil.copytree(TEMPLATE_PATH, BUILD_API_PATH) shutil.copytree(DATA_PATH, v1_dir, copy_function=_filtered_copy)
# Filter down when required keyboard_list = _filtered_keyboard_list()
kb_all = {} usb_list = {}
# Generate and write keyboard specific JSON files for keyboard_name in keyboard_list: 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): keymap_rel = qmk.path.under_qmk_firmware(keymap) if keymap_rel is None: cli.log.debug('Skipping keymap %s (not in qmk_firmware)', keymap) continue
if (keymap_rel / 'keymap.c').exists(): cli.log.debug('Skipping keymap %s (not pure dd keymap)', keymap) continue
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_rel}/keymap.json',
# Instead consumer should grab from API and not repo directly 'path': (keymap_rel / 'keymap.json').as_posix(), }
keyboard_dir.mkdir(parents=True, exist_ok=True) keyboard_json = json.dumps({'last_updated': current_datetime(), 'keyboards': {keyboard_name: kb_json}}, separators=(',', ':')) if not cli.args.dry_run: 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)
# 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)), separators=(',', ':')), 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']] = {}
if 'pid' in usb and usb['pid'] not in usb_list[usb['vid']]: usb_list[usb['vid']][usb['pid']] = {}
if 'vid' in usb and 'pid' in usb: usb_list[usb['vid']][usb['pid']][keyboard_name] = usb
# Generate data for the global files keyboard_list = sorted(kb_all) keyboard_aliases = keyboard_alias_definitions() keyboard_metadata = { 'last_updated': current_datetime(), 'keyboards': keyboard_list, 'keyboard_aliases': keyboard_aliases, 'usb': usb_list, }
# Feature specific handling _resolve_keycode_specs(v1_dir)
# Write the global JSON files keyboard_all_json = json.dumps({'last_updated': current_datetime(), 'keyboards': kb_all}, separators=(',', ':')) usb_json = json.dumps({'last_updated': current_datetime(), 'usb': usb_list}, separators=(',', ':')) keyboard_list_json = json.dumps({'last_updated': current_datetime(), 'keyboards': keyboard_list}, separators=(',', ':')) keyboard_aliases_json = json.dumps({'last_updated': current_datetime(), 'keyboard_aliases': keyboard_aliases}, separators=(',', ':')) keyboard_metadata_json = json.dumps(keyboard_metadata, separators=(',', ':')) constants_metadata_json = json.dumps({'last_updated': current_datetime(), 'constants': _list_constants(v1_dir)}, separators=(',', ':'))
if not cli.args.dry_run: 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')