mpflash 0.8.6__py3-none-any.whl → 0.8.7__py3-none-any.whl

mpflash/vendor/readme.md

@@ -1,3 +1,3 @@
-These modules are vendored from the following repositories:
-
+These modules are vendored from the following repositories:
+
 micropython/micropython

mpflash/vendor/versions.py

@@ -1,117 +1,119 @@
-"""
-#############################################################
-# Version handling copied from stubber/utils/versions.py
-#############################################################
-"""
-
-from functools import lru_cache
-
-from loguru import logger as log
-from packaging.version import parse
-
-from mpflash.common import GH_CLIENT
-
-V_PREVIEW = "preview"
-"Latest preview version"
-
-SET_PREVIEW = {"preview", "latest", "master"}
-
-
-def clean_version(
-    version: str,
-    *,
-    build: bool = False,
-    patch: bool = False,
-    commit: bool = False,
-    drop_v: bool = False,
-    flat: bool = False,
-):
-    "Clean up and transform the many flavours of versions"
-    # 'v1.13.0-103-gb137d064e' --> 'v1.13-103'
-    if version in {"", "-"}:
-        return version
-    if version.lower() == "stable":
-        _v = get_stable_mp_version()
-        if not _v:
-            log.warning("Could not determine the latest stable version")
-            return "stable"
-        version = _v
-        log.trace(f"Using latest stable version: {version}")
-    is_preview = "-preview" in version
-    nibbles = version.split("-")
-    ver_ = nibbles[0].lower().lstrip("v")
-    if not patch and ver_ >= "1.10.0" and ver_ < "1.20.0" and ver_.endswith(".0"):
-        # remove the last ".0" - but only for versions between 1.10 and 1.20 (because)
-        nibbles[0] = nibbles[0][:-2]
-    if len(nibbles) == 1:
-        version = nibbles[0]
-    elif build and not is_preview:
-        version = "-".join(nibbles) if commit else "-".join(nibbles[:-1])
-    else:
-        # version = "-".join((nibbles[0], LATEST))
-        # HACK: this is not always right, but good enough most of the time
-        if is_preview:
-            version = "-".join((nibbles[0], V_PREVIEW))
-        else:
-            version = V_PREVIEW
-    if flat:
-        version = version.strip().replace(".", "_").replace("-", "_")
-    else:
-        version = version.strip().replace("_preview", "-preview").replace("_", ".")
-
-    if drop_v:
-        version = version.lstrip("v")
-    elif not version.startswith("v") and version.lower() not in SET_PREVIEW:
-        version = "v" + version
-    if version in SET_PREVIEW:
-        version = V_PREVIEW
-    return version
-
-
-@lru_cache(maxsize=10)
-def micropython_versions(minver: str = "v1.20", reverse: bool = False):
-    """Get the list of micropython versions from github tags"""
-    try:
-        gh_client = GH_CLIENT
-        repo = gh_client.get_repo("micropython/micropython")
-        versions = [tag.name for tag in repo.get_tags()]
-    except Exception:
-        versions = [
-            "v9.99.9-preview",
-            "v1.22.2",
-            "v1.22.1",
-            "v1.22.0",
-            "v1.21.1",
-            "v1.21.0",
-            "v1.20.0",
-            "v1.19.1",
-            "v1.19",
-            "v1.18",
-            "v1.17",
-            "v1.16",
-            "v1.15",
-            "v1.14",
-            "v1.13",
-            "v1.12",
-            "v1.11",
-            "v1.10",
-        ]
-    versions = [v for v in versions if parse(v) >= parse(minver)]
-    # remove all but the most recent (preview) version
-    versions = versions[:1] + [v for v in versions if "preview" not in v]
-    return sorted(versions)
-
-
-def get_stable_mp_version() -> str:
-    # read the versions from the git tags
-    all_versions = micropython_versions(minver="v1.17")
-    return [v for v in all_versions if not v.endswith(V_PREVIEW)][-1]
-
-
-def get_preview_mp_version() -> str:
-    # read the versions from the git tags
-    all_versions = micropython_versions(minver="v1.17")
-    return [v for v in all_versions if v.endswith(V_PREVIEW)][-1]
-
-
-#############################################################
+"""
+#############################################################
+# Version handling copied from stubber/utils/versions.py
+#############################################################
+"""
+
+from functools import lru_cache
+
+from loguru import logger as log
+from packaging.version import parse
+
+from mpflash.common import GH_CLIENT
+OLDEST_VERSION = "1.16"
+"This is the oldest MicroPython version to build the stubs on"
+
+V_PREVIEW = "preview"
+"Latest preview version"
+
+SET_PREVIEW = {"preview", "latest", "master"}
+
+
+def clean_version(
+    version: str,
+    *,
+    build: bool = False,
+    patch: bool = False,
+    commit: bool = False,
+    drop_v: bool = False,
+    flat: bool = False,
+):
+    "Clean up and transform the many flavours of versions"
+    # 'v1.13.0-103-gb137d064e' --> 'v1.13-103'
+    if version in {"", "-"}:
+        return version
+    if version.lower() == "stable":
+        _v = get_stable_mp_version()
+        if not _v:
+            log.warning("Could not determine the latest stable version")
+            return "stable"
+        version = _v
+        log.trace(f"Using latest stable version: {version}")
+    is_preview = "-preview" in version
+    nibbles = version.split("-")
+    ver_ = nibbles[0].lower().lstrip("v")
+    if not patch and ver_ >= "1.10.0" and ver_ < "1.20.0" and ver_.endswith(".0"):
+        # remove the last ".0" - but only for versions between 1.10 and 1.20 (because)
+        nibbles[0] = nibbles[0][:-2]
+    if len(nibbles) == 1:
+        version = nibbles[0]
+    elif build and not is_preview:
+        version = "-".join(nibbles) if commit else "-".join(nibbles[:-1])
+    else:
+        # version = "-".join((nibbles[0], LATEST))
+        # HACK: this is not always right, but good enough most of the time
+        if is_preview:
+            version = "-".join((nibbles[0], V_PREVIEW))
+        else:
+            version = V_PREVIEW
+    if flat:
+        version = version.strip().replace(".", "_").replace("-", "_")
+    else:
+        version = version.strip().replace("_preview", "-preview").replace("_", ".")
+
+    if drop_v:
+        version = version.lstrip("v")
+    elif not version.startswith("v") and version.lower() not in SET_PREVIEW:
+        version = "v" + version
+    if version in SET_PREVIEW:
+        version = V_PREVIEW
+    return version
+
+
+@lru_cache(maxsize=10)
+def micropython_versions(minver: str = "v1.20", reverse: bool = False):
+    """Get the list of micropython versions from github tags"""
+    try:
+        gh_client = GH_CLIENT
+        repo = gh_client.get_repo("micropython/micropython")
+        versions = [tag.name for tag in repo.get_tags() if parse(tag.name) >= parse(minver)]
+        # Only keep the last preview
+        versions = [v for v in versions if not v.endswith(V_PREVIEW) or v == versions[-1]]
+    except Exception:
+        versions = [
+            "v9.99.9-preview",
+            "v1.22.2",
+            "v1.22.1",
+            "v1.22.0",
+            "v1.21.1",
+            "v1.21.0",
+            "v1.20.0",
+            "v1.19.1",
+            "v1.19",
+            "v1.18",
+            "v1.17",
+            "v1.16",
+            "v1.15",
+            "v1.14",
+            "v1.13",
+            "v1.12",
+            "v1.11",
+            "v1.10",
+        ]
+    versions = [v for v in versions if parse(v) >= parse(minver)]
+    # remove all but the most recent (preview) version
+    versions = versions[:1] + [v for v in versions if "preview" not in v]
+    return sorted(versions, reverse=reverse)
+
+
+def get_stable_mp_version() -> str:
+    # read the versions from the git tags
+    all_versions = micropython_versions(minver=OLDEST_VERSION)
+    return [v for v in all_versions if not v.endswith(V_PREVIEW)][-1]
+
+
+def get_preview_mp_version() -> str:
+    # read the versions from the git tags
+    all_versions = micropython_versions(minver=OLDEST_VERSION)
+    return [v for v in all_versions if v.endswith(V_PREVIEW)][-1]
+

mpflash/worklist.py

@@ -1,170 +1,170 @@
-from pathlib import Path
-from typing import Dict, List, Optional, Tuple
-
-from loguru import logger as log
-
-from mpflash.common import FWInfo, filtered_comports
-from mpflash.errors import MPFlashError
-
-from .downloaded import find_downloaded_firmware
-from .list import show_mcus
-from .mpboard_id import find_known_board
-from .mpremoteboard import MPRemoteBoard
-
-# #########################################################################################################
-WorkList = List[Tuple[MPRemoteBoard, FWInfo]]
-# #########################################################################################################
-
-
-def auto_update(
-    conn_boards: List[MPRemoteBoard],
-    target_version: str,
-    fw_folder: Path,
-    *,
-    selector: Optional[Dict[str, str]] = None,
-) -> WorkList:
-    """Builds a list of boards to update based on the connected boards and the firmwares available locally in the firmware folder.
-
-    Args:
-        conn_boards (List[MPRemoteBoard]): List of connected boards
-        target_version (str): Target firmware version
-        fw_folder (Path): Path to the firmware folder
-        selector (Optional[Dict[str, str]], optional): Selector for filtering firmware. Defaults to None.
-
-    Returns:
-        WorkList: List of boards and firmware information to update
-    """
-    if selector is None:
-        selector = {}
-    wl: WorkList = []
-    for mcu in conn_boards:
-        if mcu.family not in ("micropython", "unknown"):
-            log.warning(
-                f"Skipping flashing {mcu.family} {mcu.port} {mcu.board} on {mcu.serialport} as it is not a MicroPython firmware"
-            )
-            continue
-        board_firmwares = find_downloaded_firmware(
-            fw_folder=fw_folder,
-            board_id=mcu.board,
-            version=target_version,
-            port=mcu.port,
-            selector=selector,
-        )
-
-        if not board_firmwares:
-            log.error(f"No {target_version} firmware found for {mcu.board} on {mcu.serialport}.")
-            continue
-        if len(board_firmwares) > 1:
-            log.debug(f"Multiple {target_version} firmwares found for {mcu.board} on {mcu.serialport}.")
-
-        # just use the last firmware
-        fw_info = board_firmwares[-1]
-        log.info(f"Found {target_version} firmware {fw_info.filename} for {mcu.board} on {mcu.serialport}.")
-        wl.append((mcu, fw_info))
-    return wl
-
-
-def manual_worklist(
-    serial: str,
-    *,
-    board_id: str,
-    version: str,
-    fw_folder: Path,
-) -> WorkList:
-    """Create a worklist for a single board specified manually.
-
-    Args:
-        serial (str): Serial port of the board
-        board (str): Board_ID
-        version (str): Firmware version
-        fw_folder (Path): Path to the firmware folder
-
-    Returns:
-        WorkList: List of boards and firmware information to update
-    """
-    log.trace(f"Manual updating {serial} to {board_id} {version}")
-    mcu = MPRemoteBoard(serial)
-    # Lookup the matching port and cpu in board_info based in the board name
-    try:
-        info = find_known_board(board_id)
-        mcu.port = info.port
-        # need the CPU type for the esptool
-        mcu.cpu = info.cpu
-    except (LookupError, MPFlashError) as e:
-        log.error(f"Board {board_id} not found in board_info.zip")
-        log.exception(e)
-        return []
-    mcu.board = board_id
-    firmwares = find_downloaded_firmware(fw_folder=fw_folder, board_id=board_id, version=version, port=mcu.port)
-    if not firmwares:
-        log.error(f"No firmware found for {mcu.port} {board_id} version {version}")
-        return []
-    # use the most recent matching firmware
-    return [(mcu, firmwares[-1])]  # type: ignore
-
-
-def single_auto_worklist(
-    serial: str,
-    *,
-    version: str,
-    fw_folder: Path,
-) -> WorkList:
-    """Create a worklist for a single serial-port.
-
-    Args:
-        serial_port (str): Serial port of the board
-        version (str): Firmware version
-        fw_folder (Path): Path to the firmware folder
-
-    Returns:
-        WorkList: List of boards and firmware information to update
-    """
-    log.trace(f"Auto updating {serial} to {version}")
-    conn_boards = [MPRemoteBoard(serial)]
-    todo = auto_update(conn_boards, version, fw_folder)  # type: ignore # List / list
-    show_mcus(conn_boards)  # type: ignore
-    return todo
-
-
-def full_auto_worklist(
-    all_boards: List[MPRemoteBoard], *, include: List[str], ignore: List[str], version: str, fw_folder: Path
-) -> WorkList:
-    """
-    Create a worklist for all connected micropython boards based on the information retrieved from the board.
-    This allows the firmware version of one or moae boards to be changed without needing to specify the port or board_id manually.
-
-    Args:
-        version (str): Firmware version
-        fw_folder (Path): Path to the firmware folder
-
-    Returns:
-        WorkList: List of boards and firmware information to update
-    """
-    log.trace(f"Auto updating all boards to {version}")
-    if selected_boards := filter_boards(all_boards, include=include, ignore=ignore):
-        return auto_update(selected_boards, version, fw_folder)
-    else:
-        return []
-
-
-def filter_boards(
-    all_boards: List[MPRemoteBoard],
-    *,
-    include: List[str],
-    ignore: List[str],
-):
-    try:
-        comports = [
-            p.device
-            for p in filtered_comports(
-                ignore=ignore,
-                include=include,
-                bluetooth=False,
-            )
-        ]
-        selected_boards = [b for b in all_boards if b.serialport in comports]
-        # [MPRemoteBoard(port.device, update=True) for port in comports]
-    except ConnectionError as e:
-        log.error(f"Error connecting to boards: {e}")
-        return []
-    return selected_boards  # type: ignore
+from pathlib import Path
+from typing import Dict, List, Optional, Tuple
+
+from loguru import logger as log
+
+from mpflash.common import FWInfo, filtered_comports
+from mpflash.errors import MPFlashError
+
+from .downloaded import find_downloaded_firmware
+from .list import show_mcus
+from .mpboard_id import find_known_board
+from .mpremoteboard import MPRemoteBoard
+
+# #########################################################################################################
+WorkList = List[Tuple[MPRemoteBoard, FWInfo]]
+# #########################################################################################################
+
+
+def auto_update(
+    conn_boards: List[MPRemoteBoard],
+    target_version: str,
+    fw_folder: Path,
+    *,
+    selector: Optional[Dict[str, str]] = None,
+) -> WorkList:
+    """Builds a list of boards to update based on the connected boards and the firmwares available locally in the firmware folder.
+
+    Args:
+        conn_boards (List[MPRemoteBoard]): List of connected boards
+        target_version (str): Target firmware version
+        fw_folder (Path): Path to the firmware folder
+        selector (Optional[Dict[str, str]], optional): Selector for filtering firmware. Defaults to None.
+
+    Returns:
+        WorkList: List of boards and firmware information to update
+    """
+    if selector is None:
+        selector = {}
+    wl: WorkList = []
+    for mcu in conn_boards:
+        if mcu.family not in ("micropython", "unknown"):
+            log.warning(
+                f"Skipping flashing {mcu.family} {mcu.port} {mcu.board} on {mcu.serialport} as it is not a MicroPython firmware"
+            )
+            continue
+        board_firmwares = find_downloaded_firmware(
+            fw_folder=fw_folder,
+            board_id=mcu.board,
+            version=target_version,
+            port=mcu.port,
+            selector=selector,
+        )
+
+        if not board_firmwares:
+            log.error(f"No {target_version} firmware found for {mcu.board} on {mcu.serialport}.")
+            continue
+        if len(board_firmwares) > 1:
+            log.debug(f"Multiple {target_version} firmwares found for {mcu.board} on {mcu.serialport}.")
+
+        # just use the last firmware
+        fw_info = board_firmwares[-1]
+        log.info(f"Found {target_version} firmware {fw_info.filename} for {mcu.board} on {mcu.serialport}.")
+        wl.append((mcu, fw_info))
+    return wl
+
+
+def manual_worklist(
+    serial: str,
+    *,
+    board_id: str,
+    version: str,
+    fw_folder: Path,
+) -> WorkList:
+    """Create a worklist for a single board specified manually.
+
+    Args:
+        serial (str): Serial port of the board
+        board (str): Board_ID
+        version (str): Firmware version
+        fw_folder (Path): Path to the firmware folder
+
+    Returns:
+        WorkList: List of boards and firmware information to update
+    """
+    log.trace(f"Manual updating {serial} to {board_id} {version}")
+    mcu = MPRemoteBoard(serial)
+    # Lookup the matching port and cpu in board_info based in the board name
+    try:
+        info = find_known_board(board_id)
+        mcu.port = info.port
+        # need the CPU type for the esptool
+        mcu.cpu = info.cpu
+    except (LookupError, MPFlashError) as e:
+        log.error(f"Board {board_id} not found in board_info.zip")
+        log.exception(e)
+        return []
+    mcu.board = board_id
+    firmwares = find_downloaded_firmware(fw_folder=fw_folder, board_id=board_id, version=version, port=mcu.port)
+    if not firmwares:
+        log.error(f"No firmware found for {mcu.port} {board_id} version {version}")
+        return []
+    # use the most recent matching firmware
+    return [(mcu, firmwares[-1])]  # type: ignore
+
+
+def single_auto_worklist(
+    serial: str,
+    *,
+    version: str,
+    fw_folder: Path,
+) -> WorkList:
+    """Create a worklist for a single serial-port.
+
+    Args:
+        serial_port (str): Serial port of the board
+        version (str): Firmware version
+        fw_folder (Path): Path to the firmware folder
+
+    Returns:
+        WorkList: List of boards and firmware information to update
+    """
+    log.trace(f"Auto updating {serial} to {version}")
+    conn_boards = [MPRemoteBoard(serial)]
+    todo = auto_update(conn_boards, version, fw_folder)  # type: ignore # List / list
+    show_mcus(conn_boards)  # type: ignore
+    return todo
+
+
+def full_auto_worklist(
+    all_boards: List[MPRemoteBoard], *, include: List[str], ignore: List[str], version: str, fw_folder: Path
+) -> WorkList:
+    """
+    Create a worklist for all connected micropython boards based on the information retrieved from the board.
+    This allows the firmware version of one or moae boards to be changed without needing to specify the port or board_id manually.
+
+    Args:
+        version (str): Firmware version
+        fw_folder (Path): Path to the firmware folder
+
+    Returns:
+        WorkList: List of boards and firmware information to update
+    """
+    log.trace(f"Auto updating all boards to {version}")
+    if selected_boards := filter_boards(all_boards, include=include, ignore=ignore):
+        return auto_update(selected_boards, version, fw_folder)
+    else:
+        return []
+
+
+def filter_boards(
+    all_boards: List[MPRemoteBoard],
+    *,
+    include: List[str],
+    ignore: List[str],
+):
+    try:
+        comports = [
+            p.device
+            for p in filtered_comports(
+                ignore=ignore,
+                include=include,
+                bluetooth=False,
+            )
+        ]
+        selected_boards = [b for b in all_boards if b.serialport in comports]
+        # [MPRemoteBoard(port.device, update=True) for port in comports]
+    except ConnectionError as e:
+        log.error(f"Error connecting to boards: {e}")
+        return []
+    return selected_boards  # type: ignore

{mpflash-0.8.6.dist-info → mpflash-0.8.7.dist-info}/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2024 Jos Verlinde
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
+Copyright (c) 2024 Jos Verlinde
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

{mpflash-0.8.6.dist-info → mpflash-0.8.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mpflash
-Version: 0.8.6
+Version: 0.8.7
 Summary: Flash and download tool for MicroPython firmwares
 Home-page: https://github.com/Josverl/micropython-stubber/blob/main/src/mpflash/README.md
 License: MIT