summaryrefslogtreecommitdiff
path: root/lib/python/qmk/cli
diff options
context:
space:
mode:
authorzvecr <git@zvecr.com>2023-01-04 04:17:58 +0000
committerzvecr <git@zvecr.com>2023-01-04 04:17:58 +0000
commit115c241f21d35028a188d88c710fb5770c809da7 (patch)
treef8344a39cfc3239d7ad4bd9dcdb688b15bf57d81 /lib/python/qmk/cli
parentf9ee0571a773186b8a6236c26fcfe0e480937aec (diff)
parent691668340cccdc84164d37501885d509db88f113 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'lib/python/qmk/cli')
-rw-r--r--lib/python/qmk/cli/__init__.py3
-rwxr-xr-xlib/python/qmk/cli/mass_compile.py165
2 files changed, 167 insertions, 1 deletions
diff --git a/lib/python/qmk/cli/__init__.py b/lib/python/qmk/cli/__init__.py
index e0ab67da7b..16edf88ad6 100644
--- a/lib/python/qmk/cli/__init__.py
+++ b/lib/python/qmk/cli/__init__.py
@@ -69,10 +69,11 @@ subcommands = [
69 'qmk.cli.info', 69 'qmk.cli.info',
70 'qmk.cli.json2c', 70 'qmk.cli.json2c',
71 'qmk.cli.lint', 71 'qmk.cli.lint',
72 'qmk.cli.kle2json',
72 'qmk.cli.list.keyboards', 73 'qmk.cli.list.keyboards',
73 'qmk.cli.list.keymaps', 74 'qmk.cli.list.keymaps',
74 'qmk.cli.list.layouts', 75 'qmk.cli.list.layouts',
75 'qmk.cli.kle2json', 76 'qmk.cli.mass_compile',
76 'qmk.cli.migrate', 77 'qmk.cli.migrate',
77 'qmk.cli.multibuild', 78 'qmk.cli.multibuild',
78 'qmk.cli.new.keyboard', 79 'qmk.cli.new.keyboard',
diff --git a/lib/python/qmk/cli/mass_compile.py b/lib/python/qmk/cli/mass_compile.py
new file mode 100755
index 0000000000..b5f12c5026
--- /dev/null
+++ b/lib/python/qmk/cli/mass_compile.py
@@ -0,0 +1,165 @@
1"""Compile all keyboards.
2
3This will compile everything in parallel, for testing purposes.
4"""
5import logging
6import multiprocessing
7import os
8import re
9from pathlib import Path
10from subprocess import DEVNULL
11from dotty_dict import dotty
12from milc import cli
13
14from qmk.constants import QMK_FIRMWARE
15from qmk.commands import _find_make, get_make_parallel_args
16from qmk.info import keymap_json
17import qmk.keyboard
18import qmk.keymap
19
20
21def _set_log_level(level):
22 cli.acquire_lock()
23 old = cli.log_level
24 cli.log_level = level
25 cli.log.setLevel(level)
26 logging.root.setLevel(level)
27 cli.release_lock()
28 return old
29
30
31def _all_keymaps(keyboard):
32 old = _set_log_level(logging.CRITICAL)
33 keymaps = qmk.keymap.list_keymaps(keyboard)
34 _set_log_level(old)
35 return (keyboard, keymaps)
36
37
38def _keymap_exists(keyboard, keymap):
39 old = _set_log_level(logging.CRITICAL)
40 ret = keyboard if qmk.keymap.locate_keymap(keyboard, keymap) is not None else None
41 _set_log_level(old)
42 return ret
43
44
45def _load_keymap_info(keyboard, keymap):
46 old = _set_log_level(logging.CRITICAL)
47 ret = (keyboard, keymap, keymap_json(keyboard, keymap))
48 _set_log_level(old)
49 return ret
50
51
52@cli.argument('-t', '--no-temp', arg_only=True, action='store_true', help="Remove temporary files during build.")
53@cli.argument('-j', '--parallel', type=int, default=1, help="Set the number of parallel make jobs; 0 means unlimited.")
54@cli.argument('-c', '--clean', arg_only=True, action='store_true', help="Remove object files before compiling.")
55@cli.argument(
56 '-f',
57 '--filter',
58 arg_only=True,
59 action='append',
60 default=[],
61 help="Filter the list of keyboards based on the supplied value in rules.mk. Matches info.json structure, and accepts the format 'features.rgblight=true'. May be passed multiple times, all filters need to match."
62)
63@cli.argument('-km', '--keymap', type=str, default='default', help="The keymap name to build. Default is 'default'.")
64@cli.argument('-e', '--env', arg_only=True, action='append', default=[], help="Set a variable to be passed to make. May be passed multiple times.")
65@cli.subcommand('Compile QMK Firmware for all keyboards.', hidden=False if cli.config.user.developer else True)
66def mass_compile(cli):
67 """Compile QMK Firmware against all keyboards.
68 """
69 make_cmd = _find_make()
70 if cli.args.clean:
71 cli.run([make_cmd, 'clean'], capture_output=False, stdin=DEVNULL)
72
73 builddir = Path(QMK_FIRMWARE) / '.build'
74 makefile = builddir / 'parallel_kb_builds.mk'
75
76 targets = []
77
78 with multiprocessing.Pool() as pool:
79 cli.log.info(f'Retrieving list of keyboards with keymap "{cli.args.keymap}"...')
80 target_list = []
81 if cli.args.keymap == 'all':
82 kb_to_kms = pool.map(_all_keymaps, qmk.keyboard.list_keyboards())
83 for targets in kb_to_kms:
84 keyboard = targets[0]
85 keymaps = targets[1]
86 target_list.extend([(keyboard, keymap) for keymap in keymaps])
87 else:
88 target_list = [(kb, cli.args.keymap) for kb in filter(lambda kb: kb is not None, pool.starmap(_keymap_exists, [(kb, cli.args.keymap) for kb in qmk.keyboard.list_keyboards()]))]
89
90 if len(cli.args.filter) == 0:
91 targets = target_list
92 else:
93 cli.log.info('Parsing data for all matching keyboard/keymap combinations...')
94 valid_keymaps = [(e[0], e[1], dotty(e[2])) for e in pool.starmap(_load_keymap_info, target_list)]
95
96 filter_re = re.compile(r'^(?P<key>[a-zA-Z0-9_\.]+)\s*=\s*(?P<value>[^#]+)$')
97 for filter_txt in cli.args.filter:
98 f = filter_re.match(filter_txt)
99 if f is not None:
100 key = f.group('key')
101 value = f.group('value')
102 cli.log.info(f'Filtering on condition ("{key}" == "{value}")...')
103
104 def _make_filter(k, v):
105 def f(e):
106 lhs = e[2].get(k)
107 lhs = str(False if lhs is None else lhs).lower()
108 rhs = str(v).lower()
109 return lhs == rhs
110
111 return f
112
113 valid_keymaps = filter(_make_filter(key, value), valid_keymaps)
114
115 targets = [(e[0], e[1]) for e in valid_keymaps]
116
117 if len(targets) == 0:
118 return
119
120 builddir.mkdir(parents=True, exist_ok=True)
121 with open(makefile, "w") as f:
122 for target in sorted(targets):
123 keyboard_name = target[0]
124 keymap_name = target[1]
125 keyboard_safe = keyboard_name.replace('/', '_')
126 # yapf: disable
127 f.write(
128 f"""\
129all: {keyboard_safe}_{keymap_name}_binary
130{keyboard_safe}_{keymap_name}_binary:
131 @rm -f "{QMK_FIRMWARE}/.build/failed.log.{keyboard_safe}.{keymap_name}" || true
132 @echo "Compiling QMK Firmware for target: '{keyboard_name}:{keymap_name}'..." >>"{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}"
133 +@$(MAKE) -C "{QMK_FIRMWARE}" -f "{QMK_FIRMWARE}/builddefs/build_keyboard.mk" KEYBOARD="{keyboard_name}" KEYMAP="{keymap_name}" REQUIRE_PLATFORM_KEY= COLOR=true SILENT=false {' '.join(cli.args.env)} \\
134 >>"{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}.{keymap_name}" 2>&1 \\
135 || cp "{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}.{keymap_name}" "{QMK_FIRMWARE}/.build/failed.log.{os.getpid()}.{keyboard_safe}.{keymap_name}"
136 @{{ grep '\[ERRORS\]' "{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}.{keymap_name}" >/dev/null 2>&1 && printf "Build %-64s \e[1;31m[ERRORS]\e[0m\\n" "{keyboard_name}:{keymap_name}" ; }} \\
137 || {{ grep '\[WARNINGS\]' "{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}.{keymap_name}" >/dev/null 2>&1 && printf "Build %-64s \e[1;33m[WARNINGS]\e[0m\\n" "{keyboard_name}:{keymap_name}" ; }} \\
138 || printf "Build %-64s \e[1;32m[OK]\e[0m\\n" "{keyboard_name}:{keymap_name}"
139 @rm -f "{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}.{keymap_name}" || true
140"""# noqa
141 )
142 # yapf: enable
143
144 if cli.args.no_temp:
145 # yapf: disable
146 f.write(
147 f"""\
148 @rm -rf "{QMK_FIRMWARE}/.build/{keyboard_safe}_{keymap_name}.elf" 2>/dev/null || true
149 @rm -rf "{QMK_FIRMWARE}/.build/{keyboard_safe}_{keymap_name}.map" 2>/dev/null || true
150 @rm -rf "{QMK_FIRMWARE}/.build/{keyboard_safe}_{keymap_name}.hex" 2>/dev/null || true
151 @rm -rf "{QMK_FIRMWARE}/.build/{keyboard_safe}_{keymap_name}.bin" 2>/dev/null || true
152 @rm -rf "{QMK_FIRMWARE}/.build/{keyboard_safe}_{keymap_name}.uf2" 2>/dev/null || true
153 @rm -rf "{QMK_FIRMWARE}/.build/obj_{keyboard_safe}" || true
154 @rm -rf "{QMK_FIRMWARE}/.build/obj_{keyboard_safe}_{keymap_name}" || true
155"""# noqa
156 )
157 # yapf: enable
158 f.write('\n')
159
160 cli.run([make_cmd, *get_make_parallel_args(cli.args.parallel), '-f', makefile.as_posix(), 'all'], capture_output=False, stdin=DEVNULL)
161
162 # Check for failures
163 failures = [f for f in builddir.glob(f'failed.log.{os.getpid()}.*')]
164 if len(failures) > 0:
165 return False