diff options
| author | Joel Challis <[email protected]> | 2025-06-09 05:08:56 +0100 | 
|---|---|---|
| committer | GitHub <[email protected]> | 2025-06-09 05:08:56 +0100 | 
| commit | 0326355edcfd8008646d2ff2f6eca3e69fdc5738 (patch) | |
| tree | d2df8e02bcbc97fa5921d6ec2f72e3fd68de69c3 /lib/python | |
| parent | 94f1aade5ceb89464dbaddd29c7277f7333bf817 (diff) | |
| download | qmk_firmware-0326355edcfd8008646d2ff2f6eca3e69fdc5738.tar.gz qmk_firmware-0326355edcfd8008646d2ff2f6eca3e69fdc5738.zip | |
Remove `DEFAULT_FOLDER` handling (#23281)
Diffstat (limited to 'lib/python')
| -rw-r--r-- | lib/python/qmk/cli/ci/validate_aliases.py | 6 | ||||
| -rw-r--r-- | lib/python/qmk/cli/list/keyboards.py | 3 | ||||
| -rw-r--r-- | lib/python/qmk/cli/migrate.py | 4 | ||||
| -rw-r--r-- | lib/python/qmk/cli/resolve_alias.py | 2 | ||||
| -rw-r--r-- | lib/python/qmk/info.py | 11 | ||||
| -rw-r--r-- | lib/python/qmk/keyboard.py | 34 | ||||
| -rw-r--r-- | lib/python/qmk/path.py | 6 | 
7 files changed, 15 insertions, 51 deletions
| diff --git a/lib/python/qmk/cli/ci/validate_aliases.py b/lib/python/qmk/cli/ci/validate_aliases.py index 7f781d4397..8b062dbe56 100644 --- a/lib/python/qmk/cli/ci/validate_aliases.py +++ b/lib/python/qmk/cli/ci/validate_aliases.py @@ -2,7 +2,7 @@  """  from milc import cli -from qmk.keyboard import resolve_keyboard, keyboard_folder, keyboard_alias_definitions +from qmk.keyboard import keyboard_folder, keyboard_alias_definitions  def _safe_keyboard_folder(target): @@ -17,10 +17,6 @@ def _target_keyboard_exists(target):      if not target:          return False -    # If the target directory existed but there was no rules.mk or rules.mk was incorrectly parsed, then we can't build it. -    if not resolve_keyboard(target): -        return False -      # If the target directory exists but it itself has an invalid alias or invalid rules.mk, then we can't build it either.      if not _safe_keyboard_folder(target):          return False diff --git a/lib/python/qmk/cli/list/keyboards.py b/lib/python/qmk/cli/list/keyboards.py index 405b9210e4..8b6c451673 100644 --- a/lib/python/qmk/cli/list/keyboards.py +++ b/lib/python/qmk/cli/list/keyboards.py @@ -5,10 +5,9 @@ from milc import cli  import qmk.keyboard [email protected]('--no-resolve-defaults', arg_only=True, action='store_false', help='Ignore any "DEFAULT_FOLDER" within keyboards rules.mk')  @cli.subcommand("List the keyboards currently defined within QMK")  def list_keyboards(cli):      """List the keyboards currently defined within QMK      """ -    for keyboard_name in qmk.keyboard.list_keyboards(cli.args.no_resolve_defaults): +    for keyboard_name in qmk.keyboard.list_keyboards():          print(keyboard_name) diff --git a/lib/python/qmk/cli/migrate.py b/lib/python/qmk/cli/migrate.py index 0bab5c1949..d0f195d737 100644 --- a/lib/python/qmk/cli/migrate.py +++ b/lib/python/qmk/cli/migrate.py @@ -6,14 +6,14 @@ from dotty_dict import dotty  from milc import cli -from qmk.keyboard import keyboard_completer, keyboard_folder, resolve_keyboard +from qmk.keyboard import keyboard_completer, keyboard_folder  from qmk.info import info_json, find_info_json  from qmk.json_encoders import InfoJSONEncoder  from qmk.json_schema import json_load  def _candidate_files(keyboard): -    kb_dir = Path(resolve_keyboard(keyboard)) +    kb_dir = Path(keyboard)      cur_dir = Path('keyboards')      files = [] diff --git a/lib/python/qmk/cli/resolve_alias.py b/lib/python/qmk/cli/resolve_alias.py index b9ffb46618..dff2242b28 100644 --- a/lib/python/qmk/cli/resolve_alias.py +++ b/lib/python/qmk/cli/resolve_alias.py @@ -5,7 +5,7 @@ from milc import cli  @cli.argument('--allow-unknown', arg_only=True, action='store_true', help="Return original if rule is not a valid keyboard.")  @cli.argument('keyboard', arg_only=True, help='The keyboard\'s name') [email protected]('Resolve DEFAULT_FOLDER and any keyboard_aliases for provided rule') [email protected]('Resolve any keyboard_aliases for provided rule')  def resolve_alias(cli):      try:          print(keyboard_folder(cli.args.keyboard)) diff --git a/lib/python/qmk/info.py b/lib/python/qmk/info.py index d95fd3d799..db8a02d132 100644 --- a/lib/python/qmk/info.py +++ b/lib/python/qmk/info.py @@ -223,12 +223,6 @@ def _validate(keyboard, info_data):  def info_json(keyboard, force_layout=None):      """Generate the info.json data for a specific keyboard.      """ -    cur_dir = Path('keyboards') -    root_rules_mk = parse_rules_mk_file(cur_dir / keyboard / 'rules.mk') - -    if 'DEFAULT_FOLDER' in root_rules_mk: -        keyboard = root_rules_mk['DEFAULT_FOLDER'] -      info_data = {          'keyboard_name': str(keyboard),          'keyboard_folder': str(keyboard), @@ -1005,11 +999,6 @@ def find_info_json(keyboard):      keyboard_parent = keyboard_path.parent      info_jsons = [keyboard_path / 'info.json', keyboard_path / 'keyboard.json'] -    # Add DEFAULT_FOLDER before parents, if present -    rules = rules_mk(keyboard) -    if 'DEFAULT_FOLDER' in rules: -        info_jsons.append(Path(rules['DEFAULT_FOLDER']) / 'info.json') -      # Add in parent folders for least specific      for _ in range(5):          if keyboard_parent == base_path: diff --git a/lib/python/qmk/keyboard.py b/lib/python/qmk/keyboard.py index fcf5b5b158..254dc62309 100644 --- a/lib/python/qmk/keyboard.py +++ b/lib/python/qmk/keyboard.py @@ -99,8 +99,6 @@ def find_keyboard_from_dir():              keymap_index = len(current_path.parts) - current_path.parts.index('keymaps') - 1              current_path = current_path.parents[keymap_index] -        current_path = resolve_keyboard(current_path) -          if qmk.path.is_keyboard(current_path):              return str(current_path) @@ -121,7 +119,7 @@ def find_readme(keyboard):  def keyboard_folder(keyboard):      """Returns the actual keyboard folder. -    This checks aliases and DEFAULT_FOLDER to resolve the actual path for a keyboard. +    This checks aliases to resolve the actual path for a keyboard.      """      aliases = keyboard_alias_definitions() @@ -131,8 +129,6 @@ def keyboard_folder(keyboard):          if keyboard == last_keyboard:              break -    keyboard = resolve_keyboard(keyboard) -      if not qmk.path.is_keyboard(keyboard):          raise ValueError(f'Invalid keyboard: {keyboard}') @@ -158,7 +154,7 @@ def keyboard_aliases(keyboard):  def keyboard_folder_or_all(keyboard):      """Returns the actual keyboard folder. -    This checks aliases and DEFAULT_FOLDER to resolve the actual path for a keyboard. +    This checks aliases to resolve the actual path for a keyboard.      If the supplied argument is "all", it returns an AllKeyboards object.      """      if keyboard == 'all': @@ -179,32 +175,18 @@ def keyboard_completer(prefix, action, parser, parsed_args):      return list_keyboards() -def list_keyboards(resolve_defaults=True): -    """Returns a list of all keyboards - optionally processing any DEFAULT_FOLDER. +def list_keyboards(): +    """Returns a list of all keyboards      """      # We avoid pathlib here because this is performance critical code. -    paths = [] -    for marker in ['rules.mk', 'keyboard.json']: -        kb_wildcard = os.path.join(base_path, "**", marker) -        paths += [path for path in glob(kb_wildcard, recursive=True) if os.path.sep + 'keymaps' + os.path.sep not in path] +    kb_wildcard = os.path.join(base_path, "**", 'keyboard.json') +    paths = [path for path in glob(kb_wildcard, recursive=True) if os.path.sep + 'keymaps' + os.path.sep not in path]      found = map(_find_name, paths) -    if resolve_defaults: -        found = map(resolve_keyboard, found)      return sorted(set(found)) -@lru_cache(maxsize=None) -def resolve_keyboard(keyboard): -    cur_dir = Path('keyboards') -    rules = parse_rules_mk_file(cur_dir / keyboard / 'rules.mk') -    while 'DEFAULT_FOLDER' in rules and keyboard != rules['DEFAULT_FOLDER']: -        keyboard = rules['DEFAULT_FOLDER'] -        rules = parse_rules_mk_file(cur_dir / keyboard / 'rules.mk') -    return keyboard - -  def config_h(keyboard):      """Parses all the config.h files for a keyboard. @@ -216,7 +198,7 @@ def config_h(keyboard):      """      config = {}      cur_dir = Path('keyboards') -    keyboard = Path(resolve_keyboard(keyboard)) +    keyboard = Path(keyboard)      for dir in keyboard.parts:          cur_dir = cur_dir / dir @@ -235,7 +217,7 @@ def rules_mk(keyboard):          a dictionary representing the content of the entire rules.mk tree for a keyboard      """      cur_dir = Path('keyboards') -    keyboard = Path(resolve_keyboard(keyboard)) +    keyboard = Path(keyboard)      rules = parse_rules_mk_file(cur_dir / keyboard / 'rules.mk')      for i, dir in enumerate(keyboard.parts): diff --git a/lib/python/qmk/path.py b/lib/python/qmk/path.py index c47ed18362..1739689adf 100644 --- a/lib/python/qmk/path.py +++ b/lib/python/qmk/path.py @@ -21,11 +21,9 @@ def is_keyboard(keyboard_name):      if Path(keyboard_name).is_absolute():          return False -    keyboard_path = QMK_FIRMWARE / 'keyboards' / keyboard_name -    rules_mk = keyboard_path / 'rules.mk' -    keyboard_json = keyboard_path / 'keyboard.json' +    keyboard_json = QMK_FIRMWARE / 'keyboards' / keyboard_name / 'keyboard.json' -    return rules_mk.exists() or keyboard_json.exists() +    return keyboard_json.exists()  def under_qmk_firmware(path=Path(os.environ['ORIG_CWD'])): | 
