Merge branch 'mpflash/download_pico'

Author: Josverl

src/mpflash/mpflash/common.py

@@ -47,7 +47,7 @@ class FWInfo:
     firmware: str = field(default="")  # url or path to original firmware image
     variant: str = field(default="")  # MicroPython variant
     preview: bool = field(default=False)  # True if the firmware is a preview version
-    version: str = field(default="")  # MicroPython version
+    version: str = field(default="")  # MicroPython version (NO v prefix)
     url: str = field(default="")  # url to the firmware image download folder
     build: str = field(default="0")  # The build = number of commits since the last release
     ext: str = field(default="")  # the file extension of the firmware

src/mpflash/mpflash/download.py

@@ -21,6 +21,7 @@
 from mpflash.common import PORT_FWTYPES, FWInfo
 from mpflash.errors import MPFlashError
 from mpflash.mpboard_id import get_known_ports
+from mpflash.vendor.versions import clean_version
 
 # avoid conflict with the ujson used by MicroPython
 jsonlines.ujson = None  # type: ignore
@@ -157,7 +158,7 @@ def get_boards(ports: List[str], boards: List[str], clean: bool) -> List[FWInfo]
                 # board["firmware"] = _url
                 # board["preview"] = "preview" in _url  # type: ignore
                 if ver_match := re.search(RE_VERSION_PREVIEW, _url):
-                    fw_info.version = ver_match.group(1)
+                    fw_info.version = clean_version(ver_match.group(1))
                     fw_info.build = ver_match.group(2) or "0"
                 fw_info.preview = fw_info.build != "0"
                 # # else:
@@ -194,8 +195,9 @@ def download_firmwares(
     clean: bool = True,
 ) -> int:
     skipped = downloaded = 0
-    if versions is None:
-        versions = []
+    versions = [] if versions is None else [clean_version(v) for v in versions]
+    # handle renamed boards
+    boards = add_renamed_boards(boards)
 
     unique_boards = get_firmware_list(ports, boards, versions, clean)
 
@@ -305,6 +307,7 @@ def download(
     if not boards:
         log.critical("No boards found, please connect a board or specify boards to download firmware for.")
         raise MPFlashError("No boards found")
+
     # versions = [clean_version(v, drop_v=True) for v in versions]  # remove leading v from version
     try:
         destination.mkdir(exist_ok=True, parents=True)
@@ -318,3 +321,28 @@ def download(
         raise MPFlashError("Could not connect to micropython.org") from e
 
     return result
+
+
+def add_renamed_boards(boards: List[str]) -> List[str]:
+    """
+    Adds the renamed boards to the list of boards.
+
+    Args:
+        boards : The list of boards to add the renamed boards to.
+
+    Returns:
+        List[str]: The list of boards with the renamed boards added.
+
+    """
+    renamed = {
+        "PICO": ["RPI_PICO"],
+        "PICO_W": ["RPI_PICO_W"],
+        "GENERIC": ["ESP32_GENERIC", "ESP8266_GENERIC"],  # just add both of them
+    }
+    _boards = boards.copy()
+    for board in boards:
+        if board in renamed and renamed[board] not in boards:
+            _boards.extend(renamed[board])
+        if board != board.upper() and board.upper() not in boards:
+            _boards.append(board.upper())
+    return _boards

src/mpflash/mpflash/downloaded.py

@@ -27,7 +27,7 @@ def downloaded_firmwares(fw_folder: Path) -> List[FWInfo]:
 def find_downloaded_firmware(
     *,
     board_id: str,
-    version: str = "",
+    version: str = "",  # v1.2.3
     port: str = "",
     variants: bool = False,
     fw_folder: Optional[Path] = None,
@@ -43,16 +43,16 @@ def find_downloaded_firmware(
         log.error("No firmware files found. Please download the firmware first.")
         return []
     # filter by version
-    version = clean_version(version, drop_v=True)
+    version = clean_version(version)
     fw_list = filter_downloaded_fwlist(fw_list, board_id, version, port, variants, selector)
 
     if not fw_list and trie < 3:
         log.info(f"Try ({trie+1}) to find a firmware for the board {board_id}")
         if trie == 1:
-            # ESP board naming conventions have changed by adding a PORT refix
+            # ESP board naming conventions have changed by adding a PORT prefix
             if port.startswith("esp") and not board_id.startswith(port.upper()):
                 board_id = f"{port.upper()}_{board_id}"
-            # RP2 board naming conventions have changed by adding a _RPIprefix
+            # RP2 board naming conventions have changed by adding a _RPI prefix
             if port == "rp2" and not board_id.startswith("RPI_"):
                 board_id = f"RPI_{board_id}"
         elif trie == 2:
@@ -75,7 +75,7 @@ def find_downloaded_firmware(
 def filter_downloaded_fwlist(
     fw_list: List[FWInfo],
     board_id: str,
-    version: str,
+    version: str,  # v1.2.3
     port: str,
     # preview: bool,
     variants: bool,
@@ -86,7 +86,9 @@ def filter_downloaded_fwlist(
         # never get a preview for an older version
         fw_list = [fw for fw in fw_list if fw.preview]
     else:
-        fw_list = [fw for fw in fw_list if fw.version == version]
+        # FWInfo version has no v1.2.3 prefix
+        _version = clean_version(version, drop_v=True)
+        fw_list = [fw for fw in fw_list if fw.version == _version]
 
     # filter by port
     if port:

src/mpflash/mpflash/mpboard_id/__init__.py

@@ -77,10 +77,14 @@ def known_stored_boards(port: str, versions: Optional[List[str]] = None) -> List
 @lru_cache(maxsize=20)
 def find_known_board(board_id: str) -> Board:
     """Find the board for the given BOARD_ID or 'board description' and return the board info as a Board object"""
+    # FIXME : functional overlap with:
+    # mpboard_id\board_id.py _find_board_id_by_description
     info = read_known_boardinfo()
     for board_info in info:
         if board_id in (board_info.board_id, board_info.description):
             if not board_info.cpu:
+                # safeguard for older board_info.json files
+                print(f"Board {board_id} has no CPU info, using port as CPU")
                 if " with " in board_info.description:
                     board_info.cpu = board_info.description.split(" with ")[-1]
                 else:

src/mpflash/mpflash/mpboard_id/board_id.py

@@ -44,7 +44,23 @@ def _find_board_id_by_description(
     """
     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)
 
@@ -58,10 +74,10 @@ def _find_board_id_by_description(
             # 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]
-        version_matches = [b for b in candidate_boards if b.version.startswith(version)]
-        if not version_matches:
+        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}")
-        candidate_boards = version_matches
     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]

src/mpflash/mpflash/mpboard_id/store.py

@@ -13,10 +13,11 @@
 
 
 def write_boardinfo_json(board_list: List[Board], *, folder: Path):
-    """Writes the board information to JSON and CSV files.
+    """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
 

src/mpflash/tests/data/firmware/firmware.jsonl

@@ -15,3 +15,4 @@
 {"board": "RPI_PICO_W", "url": "https://micropython.org/download/RPI_PICO_W", "port": "rp2", "firmware": "https://micropython.org/resources/firmware/RPI_PICO_W-20240316-v1.23.0-preview.236.gcd8eea2ae.uf2", "preview": true, "version": "1.23.0-preview.236", "build": "236", "filename": "rp2\\RPI_PICO_W-v1.23.0-preview.236.uf2", "ext": ".uf2", "variant": "RPI_PICO_W"}
 {"board": "RPI_PICO_W", "url": "https://micropython.org/download/RPI_PICO_W", "port": "rp2", "firmware": "https://micropython.org/resources/firmware/RPI_PICO_W-20240222-v1.22.2.uf2", "preview": false, "version": "1.22.2", "build": "0", "filename": "rp2\\RPI_PICO_W-v1.22.2.uf2", "ext": ".uf2", "variant": "RPI_PICO_W"}
 {"board": "RPI_PICO", "url": "https://micropython.org/download/RPI_PICO", "port": "rp2", "firmware": "https://micropython.org/resources/firmware/RPI_PICO-20240222-v1.22.2.uf2", "preview": false, "version": "1.22.2", "build": "0", "filename": "rp2\\RPI_PICO-v1.22.2.uf2", "ext": ".uf2", "variant": "RPI_PICO"}
+{"board": "RPI_PICO", "url": "https://micropython.org/download/RPI_PICO", "port": "rp2", "firmware": "https://micropython.org/resources/firmware/RPI_PICO-20240222-v1.19.1.uf2", "preview": false, "version": "1.19.1", "build": "0", "filename": "rp2\\RPI_PICO-v1.19.1.uf2", "ext": ".uf2", "variant": "RPI_PICO"}

src/mpflash/tests/mpboard_id/test_find_board_id.py

@@ -37,6 +37,9 @@
         ("esp32_v1.22.0-a", "v1.22.0", "ESP32 module with ESP32", None, "UNKNOWN_BOARD"),
         ("esp32_v1.21.0-a", None, "ESP32 module with ESP32", None, "GENERIC"),
         ("esp32_v1.22.0-a", None, "ESP32 module with ESP32", None, "GENERIC"),
+        # PICO
+        ("pico_v1.19.1-old", "v1.19.1", "Raspberry Pi Pico with RP2040", "Raspberry Pi Pico", "PICO"),
+        ("pico_v1.23.0", "v1.23.0", "Raspberry Pi Pico with RP2040", "Raspberry Pi Pico", "RPI_PICO"),
         # Error cases
         ("error-1", "stable", "Board X", "X", None),
         ("error-2", "stable", "Board A", "A", None),

src/mpflash/tests/test_downloaded.py

@@ -23,8 +23,12 @@ def test_downloaded_firmwares(mocker: MockerFixture, test_fw_path):
     [
         ("esp32", "ESP32_GENERIC", "preview", True),
         ("esp32", "GENERIC", "preview", True),
+        # Old and new names for PICO
         ("rp2", "RPI_PICO", "1.22.2", True),
         ("rp2", "PICO", "1.22.2", True),
+        # old name for PICO
+        ("rp2", "PICO", "1.19.1", True),
+        # old and new name for PICO_W
         ("rp2", "RPI_PICO_W", "1.22.2", True),
         ("rp2", "PICO_W", "1.22.2", True),
         ("fake", "NO_BOARD", "1.22.2", False),