Merge pull request #9221 from elpekenin/feat/stub/list

[Tooling] Add `--list` to `circuitpython_setboard`

Author: tannewt

tools/board_stubs/circuitpython_setboard/__init__.py

@@ -1,26 +1,103 @@
 # SPDX-FileCopyrightText: 2024 Tim Cocks
 #
 # SPDX-License-Identifier: MIT
-from importlib import resources
-import os
+import argparse
 import sys
 import shutil
+from collections import defaultdict
+from importlib import resources
+from importlib.abc import Traversable
+
+
+def get_definitions_or_exit(board: str) -> Traversable:
+    """Get the definitions file for a board given its name."""
+
+    path = resources.files("board_definitions").joinpath(board)
+
+    file = path.joinpath("__init__.pyi")
+    if not file.is_file():
+        sys.stderr.write(f"Definitions for: '{board}' were not found\n")
+        sys.exit(1)
+
+    return file
+
+
+def get_doc_or_exit(board: str) -> str:
+    """Get the docstring for a board given its name."""
+
+    with get_definitions_or_exit(board).open("r") as f:
+        return f.read().split('"""')[1]
+
+
+def header(txt: str) -> str:
+    """Helper text formatter."""
+    return txt + "\n" + "-" * len(txt) + "\n"
 
 
 def set_board():
-    if len(sys.argv) != 2:
-        print(f"Incorrect args. Please call with: 'circuitpython_setboard chosen_board'")
-        return
+    parser = argparse.ArgumentParser(
+        prog=__name__,
+        usage="Install CircuitPython board-specific stubs",
+    )
+    parser.add_argument("chosen_board", help="selected board", nargs="?")
+    parser.add_argument(
+        "-l",
+        "--list",
+        help=f"show available boards. can filter eg: '{__name__} -l feather'",
+        action="store_true",
+    )
 
-    chosen_board = sys.argv[1]
-    print(f"setting board: {chosen_board}")
+    args = parser.parse_args()
 
-    board_stubs_file = resources.files("board-stubs").joinpath("__init__.pyi")
-    board_definitions_path = resources.files("board_definitions").joinpath(chosen_board)
-    board_definitions_file = board_definitions_path.joinpath("__init__.pyi")
+    if args.list:
+        port_boards: defaultdict[str, list[str]] = defaultdict(list)
+
+        # NOTE: "" in some_str == True
+        looking_for = "" if args.chosen_board is None else args.chosen_board.lower()
+
+        for board in resources.files("board_definitions").iterdir():
+            # NOTE: For the hand-crafted finding of port in the docstring, its
+            #       format is assumed to be:
+            #
+            # <empty line>
+            # Board stub for ...
+            #  - port: ...
+            #  - board_id: ...
+            #  - NVM size: ...
+            #  - Included modules: ...
+            #  - Frozen libraries: ...
+            #
+
+            lines = get_doc_or_exit(board).split("\n")
+            port = lines[2].split("-")[1].split(":")[1].strip()
+
+            if looking_for not in board.name.lower() and looking_for not in port.lower():
+                continue
+
+            port_boards[port].append(board.name)
 
-    if not board_definitions_file.is_file():
-        print(f"Board: '{chosen_board}' was not found")
-        return
+        if not port_boards:
+            sys.stdout.write("Nothing found, check out your filter.\n")
+            sys.exit(0)
 
+        sys.stdout.write("Available boards are: \n")
+        # sort by port name
+        for port, boards in sorted(port_boards.items(), key=lambda kv: kv[0]):
+            sys.stdout.write(
+                header(port)
+                + "  * "
+                # sort by board name
+                + "\n  * ".join(sorted(boards))
+                + "\n\n"
+            )
+
+        sys.exit(0)
+
+    if args.chosen_board is None:
+        sys.stderr.write("Must select a board\n")
+        sys.exit(1)
+
+    board_definitions_file = get_definitions_or_exit(args.chosen_board)
+
+    board_stubs_file = resources.files("board-stubs").joinpath("__init__.pyi")
     shutil.copyfile(board_definitions_file, board_stubs_file)