mpflash 0.8.1b1__py3-none-any.whl → 0.8.2__py3-none-any.whl

mpflash/cli_group.py

@@ -5,8 +5,8 @@ Additional comands are added in the submodules.
 
 import rich_click as click
 
-from .config import config
-from .logger import make_quiet, set_loglevel
+from .config import __version__, config
+from .logger import log, make_quiet, set_loglevel
 
 
 def cb_verbose(ctx, param, value):
@@ -17,6 +17,7 @@ def cb_verbose(ctx, param, value):
             set_loglevel("TRACE")
         else:
             set_loglevel("DEBUG")
+        log.debug(f"version: {__version__}")
     else:
         set_loglevel("INFO")
         config.verbose = False

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

mpflash/config.py

@@ -3,9 +3,18 @@
 from pathlib import Path
 from typing import List
 
+import pkg_resources
 import platformdirs
 
 
+def get_version():
+    name = __package__ or "mpflash"
+    try:
+        return pkg_resources.get_distribution(name).version
+    except pkg_resources.DistributionNotFound:
+        return "Package not found"
+
+
 class MPtoolConfig:
     """Centralized configuration for mpflash"""
 
@@ -19,3 +28,4 @@ class MPtoolConfig:
 
 
 config = MPtoolConfig()
+__version__ = get_version()

mpflash/download.py

@@ -19,8 +19,10 @@ from loguru import logger as log
 from rich.progress import track
 
 from mpflash.common import PORT_FWTYPES, FWInfo
+from mpflash.downloaded import clean_downloaded_firmwares
 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
@@ -32,8 +34,18 @@ MICROPYTHON_ORG_URL = "https://micropython.org/"
 # Regexes to remove dates and hashes in the filename that just get in the way
 RE_DATE = r"(-\d{8}-)"
 RE_HASH = r"(.g[0-9a-f]+\.)"
-# regex to extract the version from the firmware filename
-RE_VERSION_PREVIEW = r"(\d+\.\d+(\.\d+)?(-\w+.\d+)?)"
+# regex to extract the version and the build from the firmware filename
+# group 1 is the version, group 2 is the build
+RE_VERSION_PREVIEW = r"v([\d\.]+)-?(?:preview\.)?(\d+)?\."
+# 'RPI_PICO_W-v1.23.uf2'
+# 'RPI_PICO_W-v1.23.0.uf2'
+# 'RPI_PICO_W-v1.23.0-406.uf2'
+# 'RPI_PICO_W-v1.23.0-preview.406.uf2'
+# 'RPI_PICO_W-v1.23.0-preview.4.uf2'
+# 'RPI_PICO_W-v1.23.0.uf2'
+# 'https://micropython.org/resources/firmware/RPI_PICO_W-20240531-v1.24.0-preview.10.gc1a6b95bf.uf2'
+# 'https://micropython.org/resources/firmware/RPI_PICO_W-20240531-v1.24.0-preview.10.uf2'
+# 'RPI_PICO_W-v1.24.0-preview.10.gc1a6b95bf.uf2'
 
 
 # use functools.lru_cache to avoid needing to download pages multiple times
@@ -98,6 +110,7 @@ def board_firmware_urls(board_url: str, base_url: str, ext: str) -> List[str]:
 # The first run takes ~60 seconds to run for 4 ports , all boards
 # so it makes sense to cache the results and skip boards as soon as possible
 def get_boards(ports: List[str], boards: List[str], clean: bool) -> List[FWInfo]:
+    # sourcery skip: use-getitem-for-re-match-groups
     """
     Retrieves a list of firmware information for the specified ports and boards.
 
@@ -146,13 +159,15 @@ 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[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:
+                # #     board.$1= ""
+                # if "preview." in fw_info.version:
+                #     fw_info.build = fw_info.version.split("preview.")[-1]
                 # else:
-                #     board.$1= ""
-                if "preview." in fw_info.version:
-                    fw_info.build = fw_info.version.split("preview.")[-1]
-                else:
-                    fw_info.build = "0"
+                #     fw_info.build = "0"
 
                 fw_info.ext = Path(fw_info.firmware).suffix
                 fw_info.variant = fw_info.filename.split("-v")[0] if "-v" in fw_info.filename else ""
@@ -180,9 +195,21 @@ def download_firmwares(
     force: bool = False,
     clean: bool = True,
 ) -> int:
+    """
+    Downloads firmware files based on the specified firmware folder, ports, boards, versions, force flag, and clean flag.
+
+    Args:
+        firmware_folder : The folder to save the downloaded firmware files.
+        ports : The list of ports to check for firmware.
+        boards : The list of boards to download firmware for.
+        versions : The list of versions to download firmware for.
+        force : A flag indicating whether to force the download even if the firmware file already exists.
+        clean : A flag indicating to clean the date from the firmware filename.
+    """
     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)
 
@@ -191,6 +218,11 @@ def download_firmwares(
     # relevant
 
     log.info(f"Found {len(unique_boards)} relevant unique firmwares")
+    if not unique_boards:
+        log.error("No relevant firmwares could be found on https://micropython.org/download")
+        log.info(f"{versions=} {ports=} {boards=}")
+        log.info("Please check the website for the latest firmware files or try the preview version.")
+        return 0
 
     firmware_folder.mkdir(exist_ok=True)
 
@@ -214,7 +246,9 @@ def download_firmwares(
                 continue
             writer.write(board.to_dict())
             downloaded += 1
-    log.info(f"Downloaded {downloaded} firmwares, skipped {skipped} existing files.")
+    if downloaded > 0:
+        clean_downloaded_firmwares(firmware_folder)
+    log.success(f"Downloaded {downloaded} firmwares, skipped {skipped} existing files.")
     return downloaded + skipped
 
 
@@ -238,12 +272,15 @@ def get_firmware_list(ports: List[str], boards: List[str], versions: List[str],
     board_urls = sorted(get_boards(ports, boards, clean), key=key_fw_ver_pre_ext_bld)
 
     log.debug(f"Total {len(board_urls)} firmwares")
+
     relevant = [
         board
         for board in board_urls
-        if board.board in boards and (board.version in versions or board.preview and preview)
-        # and b["port"] in ["esp32", "rp2"]
+        if board.version in versions and board.build == "0" and board.board in boards and not board.preview
     ]
+
+    if preview:
+        relevant.extend([board for board in board_urls if board.board in boards and board.preview])
     log.debug(f"Matching firmwares: {len(relevant)}")
     # select the unique boards
     unique_boards: List[FWInfo] = []
@@ -272,7 +309,7 @@ def download(
         boards : The list of boards to download firmware for.
         versions : The list of versions to download firmware for.
         force : A flag indicating whether to force the download even if the firmware file already exists.
-        clean : A flag indicating whether to perform a clean download.
+        clean : A flag indicating whether to clean the date from the firmware filename.
 
     Returns:
         int: The number of downloaded firmware files.
@@ -284,7 +321,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)
     except (PermissionError, FileNotFoundError) as e:
@@ -297,3 +334,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

mpflash/downloaded.py

@@ -24,10 +24,25 @@ def downloaded_firmwares(fw_folder: Path) -> List[FWInfo]:
     return firmwares
 
 
+def clean_downloaded_firmwares(fw_folder: Path) -> None:
+    """
+    Remove duplicate entries from the firmware.jsonl file, keeping the latest one
+    uniqueness is based on the filename
+    """
+    firmwares = downloaded_firmwares(fw_folder)
+    if not firmwares:
+        return
+    # keep the latest entry
+    unique_fw = {fw.filename: fw for fw in firmwares}
+    with jsonlines.open(fw_folder / "firmware.jsonl", "w") as writer:
+        for fw in unique_fw.values():
+            writer.write(fw.to_dict())
+    log.info(f"Removed duplicate entries from firmware.jsonl in {fw_folder}")
+
 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 +58,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 +90,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 +101,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:

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:

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]

mpflash/mpboard_id/store.py

@@ -13,10 +13,11 @@ HERE = Path(__file__).parent
 
 
 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
 

{mpflash-0.8.1b1.dist-info → mpflash-0.8.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mpflash
-Version: 0.8.1b1
+Version: 0.8.2
 Summary: Flash and download tool for MicroPython firmwares
 Home-page: https://github.com/Josverl/micropython-stubber/blob/main/src/mpflash/README.md
 License: MIT
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: MicroPython
 Classifier: Topic :: Software Development :: Build Tools

{mpflash-0.8.1b1.dist-info → mpflash-0.8.2.dist-info}/RECORD

@@ -3,14 +3,14 @@ mpflash/add_firmware.py,sha256=u_g9mID557fptLEJ1Nld9n27V1R1og8uEkadm0O3YTw,3435
 mpflash/ask_input.py,sha256=e54WfgktG7Ff8dBUknXioROq3lPNZ-eacUjfmUvFfS0,8496
 mpflash/cli_download.py,sha256=6ctC4ga6q2LcpHUHMrz1trbePziQpuIFPbjcJnc3K7E,3645
 mpflash/cli_flash.py,sha256=QHEb-e2ABjISfuGCWpTxOM7kkcTZSQxBXmVaWh3WVnE,7074
-mpflash/cli_group.py,sha256=-qkR4ou7bmIwfDIzyL1s34z6ya1wckKtL22nanvyQGU,1974
+mpflash/cli_group.py,sha256=nrihkm74X8pX1jPM72W8ljoc5rYL6ggGOQFRaOldhLo,2038
 mpflash/cli_list.py,sha256=Mdaf13gKZCoLp8Y2ja0L5rYMzkE_t3d4r62bF7isI3E,1997
 mpflash/cli_main.py,sha256=yABFFf45TpPMcC1qEVARAWe4EI9zui2pUXjoPms0mq8,1030
-mpflash/common.py,sha256=kanbO22SQDWb4ASQG8vLF0Z83ahujKPbrsCw3llN5T4,5594
-mpflash/config.py,sha256=hBc1Hf4XQ0YIoeiPBbannnqDg0C7226Y7Vu8o4jUkBQ,495
+mpflash/common.py,sha256=MmyLadb_z7bhVy6U8jb4f3pnBK8n7x28smFBcA9ZfGg,5608
+mpflash/config.py,sha256=R7PomStIFHSTnLhpWhw9P2DL_b-8a8Wrja3aY-dPm6A,762
 mpflash/connected.py,sha256=CBG_DJ33OPWAPbX-ICQpL1LcFOhNYpLUSB0Q5v7gi9s,3029
-mpflash/download.py,sha256=nz7iE-t_3wxyht0iQbMcc6rx8JOnHjbK3D3lQ13bLnU,11612
-mpflash/downloaded.py,sha256=IYMyx_67paKFSKOg3whgwsWf8IlHaLgpmSlukMT7V9Q,3804
+mpflash/download.py,sha256=NErA2SJEhXnTElvq6z4BJl-L-5M_ETJpqX6pM0oubsg,14290
+mpflash/downloaded.py,sha256=lxwRP-7gE9TO23jKG5Ov6TCsRA1kM8rzZEdceA163Uk,4520
 mpflash/errors.py,sha256=Q5LR12Wo8iUCg5n_qq4GjdBdBflbvCOdKsRJ5InYRfI,96
 mpflash/flash.py,sha256=JoskuwaHVYqeG4YW8kgbv26vPFnqDmkTz1VRs-pTRiY,2468
 mpflash/flash_esp.py,sha256=dEc_B7-f1BMUGBMrwIm83ulcCqaS5MlrPAp3FCNgNfk,2311
@@ -24,12 +24,12 @@ mpflash/flash_uf2_macos.py,sha256=HGUg2HSw4qalfSP7npLYgos2WlVRxtOVTDcAnBL7qPY,10
 mpflash/flash_uf2_windows.py,sha256=a-iIGPkwIoUXA7atCz0_uZp-kipSL24P-IE5ka1B1Mk,1025
 mpflash/list.py,sha256=0TawTkwhjKPPj7nTHoDn8nQ54WOkGRurP1BJVeg956g,2963
 mpflash/logger.py,sha256=dI_H_a7EOdQJyvoeRHQuYeZuTKYVUS3DUPTLhE9rkdM,1098
-mpflash/mpboard_id/__init__.py,sha256=QRLVUpeiXeiY3P-im2Bv8zX8xGS_MIqiH-3svuVoWyY,3576
+mpflash/mpboard_id/__init__.py,sha256=9IS8E-4eimd_bclgGgWE1wGEx0IRzKnu5Jzl8pQih_g,3816
 mpflash/mpboard_id/add_boards.py,sha256=OWclyLWf9L-pCVmZ22b-xQYfvi3yQVsJHmGMgMzWxoU,9684
 mpflash/mpboard_id/board.py,sha256=CwtBux8y7GDUe7CADVxL8YefGRl9Fg8OAJBUhgaBYCI,1151
-mpflash/mpboard_id/board_id.py,sha256=63K91S_KWdSL5vHkZhpU-ibOhpOrUt0YPwxDsUBEmnc,2489
+mpflash/mpboard_id/board_id.py,sha256=uVBbqksE1S4RPO1kNAVk4-xJWj6vwAX6QeuE0ekkZEc,2964
 mpflash/mpboard_id/board_info.zip,sha256=F6YowS96DAqjten4ySe4MXgZwPtE-saZOUfY5OQkqKk,19759
-mpflash/mpboard_id/store.py,sha256=hhNTPlraQYH_Tx3syoi_NBx8z13efkgXn433OZ2GjpU,1462
+mpflash/mpboard_id/store.py,sha256=4lLEff6a30lIOb4fOYYzanE4G4qfgikfprmpV1eUf2U,1536
 mpflash/mpremoteboard/__init__.py,sha256=fJ_N1F6R3CfP9F7pmocb5l8yRvzmSmtHi4u_uTQHR1w,7683
 mpflash/mpremoteboard/mpy_fw_info.py,sha256=6AQbN3jtQgllqWQYl4e-63KeEtV08EXk8_JnM6XBkvo,4554
 mpflash/mpremoteboard/runner.py,sha256=-PgzAeBGbyXaAUlwyiw4mcINsP2U1XRRjP1_QdBrxpg,4786
@@ -40,8 +40,8 @@ mpflash/vendor/pydfu.py,sha256=_MdBRo1EeNeKDqFPSTB5tNL1jGSBJgsVeVjE5e7Pb8s,20542
 mpflash/vendor/readme.md,sha256=iIIZxuLUIGHQ0KODzYVtMezsztvyxCXcNJp_AzwTIPk,86
 mpflash/vendor/versions.py,sha256=thk1a5wEEhXIQoL0zZ7oooeFyQeSoI00CIUbZF0b3rI,3783
 mpflash/worklist.py,sha256=MKHDynttVP3lsHSfb7DEqeQ2mRV0da96lD4lIcS_zQY,5962
-mpflash-0.8.1b1.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
-mpflash-0.8.1b1.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
-mpflash-0.8.1b1.dist-info/METADATA,sha256=TT5lfBjX96EPaD70_I__rVhxVhHprFaQszEbpHn5OYA,15226
-mpflash-0.8.1b1.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-mpflash-0.8.1b1.dist-info/RECORD,,
+mpflash-0.8.2.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
+mpflash-0.8.2.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
+mpflash-0.8.2.dist-info/METADATA,sha256=N1kDSCr4LilmXiMUdcs190wEJgNm_X8Vshh5D4GCRLo,15275
+mpflash-0.8.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+mpflash-0.8.2.dist-info/RECORD,,

{mpflash-0.8.1b1.dist-info → mpflash-0.8.2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.7.0
+Generator: poetry-core 1.9.0
 Root-Is-Purelib: true
 Tag: py3-none-any