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) --- lib/python/qmk/cli/find.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'lib/python/qmk/cli/find.py') 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}') -- 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/find.py') 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