micropython-stubber 1.23.1.post1__py3-none-any.whl → 1.23.3__py3-none-any.whl

mpflash/mpflash/mpboard_id/board_id.py

@@ -1,86 +1,86 @@
-"""
-Translate board description to board designator
-"""
-
-import functools
-from pathlib import Path
-from typing import Optional
-
-from mpflash.errors import MPFlashError
-from mpflash.logger import log
-from mpflash.mpboard_id.store import read_known_boardinfo
-from mpflash.versions import clean_version, get_stable_mp_version
-
-
-def find_board_id_by_description(
-    descr: str,
-    short_descr: str,
-    *,
-    version: str,
-    board_info: Optional[Path] = None,
-) -> Optional[str]:
-    """Find the MicroPython BOARD_ID based on the description in the firmware"""
-
-    try:
-        boards = _find_board_id_by_description(
-            descr=descr,
-            short_descr=short_descr,
-            board_info=board_info,
-            version=clean_version(version) if version else None,
-        )
-        return boards[-1].board_id
-    except MPFlashError:
-        return "UNKNOWN_BOARD"
-
-
-@functools.lru_cache(maxsize=20)
-def _find_board_id_by_description(
-    *,
-    descr: str,
-    short_descr: str,
-    version: Optional[str] = None,
-    board_info: Optional[Path] = None,
-):
-    """
-    Find the MicroPython BOARD_ID based on the description in the firmware
-    using the pre-built board_info.json file
-
-    Parameters:
-    descr: str
-        Description of the board
-    short_descr: str
-        Short description of the board (optional)
-    version: str
-        Version of the MicroPython firmware
-    board_info: Path
-        Path to the board_info.json file (optional)
-
-    """
-    # FIXME: functional overlap with
-    # src\mpflash\mpflash\mpboard_id\__init__.py find_known_board
-
-    if not short_descr and " with " in descr:
-        short_descr = descr.split(" with ")[0]
-
-    candidate_boards = read_known_boardinfo(board_info)
-
-    if version:
-        # filter for matching version
-        if version in ("preview", "stable"):
-            # match last stable
-            version = get_stable_mp_version()
-        known_versions = sorted({b.version for b in candidate_boards})
-        if version not in known_versions:
-            # FIXME if latest stable is newer than the last version in the boardlist this will fail
-            log.trace(f"Version {version} not found in board info, using latest known version {known_versions[-1]}")
-            version = known_versions[-1]
-        if version_matches := [b for b in candidate_boards if b.version.startswith(version)]:
-            candidate_boards = version_matches
-        else:
-            raise MPFlashError(f"No board info found for version {version}")
-    matches = [b for b in candidate_boards if b.description == descr]
-    if not matches and short_descr:
-        matches = [b for b in candidate_boards if b.description == short_descr]
-    if not matches:
-        raise MPFlashError(f"No board info found for description '{descr}' or '{short_descr}'")
-    return sorted(matches, key=lambda x: x.version)
+"""
+Translate board description to board designator
+"""
+
+import functools
+from pathlib import Path
+from typing import Optional
+
+from mpflash.errors import MPFlashError
+from mpflash.logger import log
+from mpflash.mpboard_id.store import read_known_boardinfo
+from mpflash.versions import clean_version, get_stable_mp_version
+
+
+def find_board_id_by_description(
+    descr: str,
+    short_descr: str,
+    *,
+    version: str,
+    board_info: Optional[Path] = None,
+) -> Optional[str]:
+    """Find the MicroPython BOARD_ID based on the description in the firmware"""
+
+    try:
+        boards = _find_board_id_by_description(
+            descr=descr,
+            short_descr=short_descr,
+            board_info=board_info,
+            version=clean_version(version) if version else None,
+        )
+        return boards[-1].board_id
+    except MPFlashError:
+        return "UNKNOWN_BOARD"
+
+
+@functools.lru_cache(maxsize=20)
+def _find_board_id_by_description(
+    *,
+    descr: str,
+    short_descr: str,
+    version: Optional[str] = None,
+    board_info: Optional[Path] = None,
+):
+    """
+    Find the MicroPython BOARD_ID based on the description in the firmware
+    using the pre-built board_info.json file
+
+    Parameters:
+    descr: str
+        Description of the board
+    short_descr: str
+        Short description of the board (optional)
+    version: str
+        Version of the MicroPython firmware
+    board_info: Path
+        Path to the board_info.json file (optional)
+
+    """
+    # FIXME: functional overlap with
+    # src\mpflash\mpflash\mpboard_id\__init__.py find_known_board
+
+    if not short_descr and " with " in descr:
+        short_descr = descr.split(" with ")[0]
+
+    candidate_boards = read_known_boardinfo(board_info)
+
+    if version:
+        # filter for matching version
+        if version in ("preview", "stable"):
+            # match last stable
+            version = get_stable_mp_version()
+        known_versions = sorted({b.version for b in candidate_boards})
+        if version not in known_versions:
+            # FIXME if latest stable is newer than the last version in the boardlist this will fail
+            log.trace(f"Version {version} not found in board info, using latest known version {known_versions[-1]}")
+            version = known_versions[-1]
+        if version_matches := [b for b in candidate_boards if b.version.startswith(version)]:
+            candidate_boards = version_matches
+        else:
+            raise MPFlashError(f"No board info found for version {version}")
+    matches = [b for b in candidate_boards if b.description == descr]
+    if not matches and short_descr:
+        matches = [b for b in candidate_boards if b.description == short_descr]
+    if not matches:
+        raise MPFlashError(f"No board info found for description '{descr}' or '{short_descr}'")
+    return sorted(matches, key=lambda x: x.version)

mpflash/mpflash/mpboard_id/store.py

@@ -1,43 +1,48 @@
-import functools
-import zipfile
-from pathlib import Path
-from typing import List, Optional
-
-import jsons
-
-from mpflash.mpboard_id.board import Board
-
-###############################################################################################
-HERE = Path(__file__).parent
-###############################################################################################
-
-
-def write_boardinfo_json(board_list: List[Board], *, folder: Path):
-    """Writes the board information to a JSON file.
-
-    Args:
-        board_list (List[Board]): The list of Board objects.
-        folder (Path): The folder where the compressed JSON file will be saved.
-    """
-    import zipfile
-
-    # create a zip file with the json file
-    with zipfile.ZipFile(folder / "board_info.zip", "w", compression=zipfile.ZIP_DEFLATED) as zipf:
-        # write the list to json file inside the zip
-        with zipf.open("board_info.json", "w") as fp:
-            fp.write(jsons.dumps(board_list, jdkwargs={"indent": 4}).encode())
-
-
-@functools.lru_cache(maxsize=20)
-def read_known_boardinfo(board_info: Optional[Path] = None) -> List[Board]:
-
-    if not board_info:
-        board_info = HERE / "board_info.zip"
-    if not board_info.exists():
-        raise FileNotFoundError(f"Board info file not found: {board_info}")
-
-    with zipfile.ZipFile(board_info, "r") as zf:
-        with zf.open("board_info.json", "r") as file:
-            info = jsons.loads(file.read().decode(encoding="utf-8"), List[Board])
-
-    return info
+import functools
+import zipfile
+from pathlib import Path
+from typing import Final, List, Optional
+
+import jsons
+
+from mpflash.mpboard_id.board import Board
+
+###############################################################################################
+HERE: Final = Path(__file__).parent
+###############################################################################################
+
+
+def write_boardinfo_json(board_list: List[Board], *, folder: Optional[Path] = None):
+    """Writes the board information to a JSON file.
+
+    Args:
+        board_list (List[Board]): The list of Board objects.
+        folder (Path): The folder where the compressed JSON file will be saved.
+    """
+    import zipfile
+
+    if not folder:
+        folder = HERE
+    # create a zip file with the json file
+    with zipfile.ZipFile(folder / "board_info.zip", "w", compression=zipfile.ZIP_DEFLATED) as zipf:
+        # write the list to json file inside the zip
+        with zipf.open("board_info.json", "w") as fp:
+            fp.write(jsons.dumps(board_list, jdkwargs={"indent": 4}).encode())
+
+
+@functools.lru_cache(maxsize=20)
+def read_known_boardinfo(board_info: Optional[Path] = None) -> List[Board]:
+    """Reads the board information from a JSON file in a zip file."""
+
+    import zipfile
+
+    if not board_info:
+        board_info = HERE / "board_info.zip"
+    if not board_info.exists():
+        raise FileNotFoundError(f"Board info file not found: {board_info}")
+
+    with zipfile.ZipFile(board_info, "r") as zf:
+        with zf.open("board_info.json", "r") as file:
+            info = jsons.loads(file.read().decode(encoding="utf-8"), List[Board])
+
+    return info