micropython-stubber 1.20.0__py3-none-any.whl → 1.20.2__py3-none-any.whl

mpflash/mpflash/downloaded.py

@@ -16,11 +16,11 @@ def downloaded_firmwares(fw_folder: Path) -> List[FWInfo]:
     firmwares: List[FWInfo] = []
     try:
         with jsonlines.open(fw_folder / "firmware.jsonl") as reader:
-            firmwares.extend(iter(reader))
+            firmwares = [FWInfo.from_dict(item) for item in reader]
     except FileNotFoundError:
         log.error(f"No firmware.jsonl found in {fw_folder}")
     # sort by filename
-    firmwares.sort(key=lambda x: x["filename"])
+    firmwares.sort(key=lambda x: x.filename)
     return firmwares
 
 
@@ -68,7 +68,7 @@ def find_downloaded_firmware(
         )
         # hope we have a match now for the board
     # sort by filename
-    fw_list.sort(key=lambda x: x["filename"])
+    fw_list.sort(key=lambda x: x.filename)
     return fw_list
 
 
@@ -84,23 +84,23 @@ def filter_downloaded_fwlist(
     """Filter the downloaded firmware list based on the provided parameters"""
     if "preview" in version:
         # never get a preview for an older version
-        fw_list = [fw for fw in fw_list if fw["preview"]]
+        fw_list = [fw for fw in fw_list if fw.preview]
     else:
-        fw_list = [fw for fw in fw_list if fw["version"] == version]
+        fw_list = [fw for fw in fw_list if fw.version == version]
 
     # filter by port
     if port:
-        fw_list = [fw for fw in fw_list if fw["port"] == port]
+        fw_list = [fw for fw in fw_list if fw.port == port]
 
     if board_id:
         if variants:
             # any variant of this board_id
-            fw_list = [fw for fw in fw_list if fw["board"] == board_id]
+            fw_list = [fw for fw in fw_list if fw.board == board_id]
         else:
             # the firmware variant should match exactly the board_id
-            fw_list = [fw for fw in fw_list if fw["variant"] == board_id]
+            fw_list = [fw for fw in fw_list if fw.variant == board_id]
     if selector and port in selector:
-        fw_list = [fw for fw in fw_list if fw["filename"].endswith(selector[port])]
+        fw_list = [fw for fw in fw_list if fw.filename.endswith(selector[port])]
     return fw_list
 
 

mpflash/mpflash/flash.py

@@ -23,11 +23,11 @@ def flash_list(
     """Flash a list of boards with the specified firmware."""
     flashed = []
     for mcu, fw_info in todo:
-        fw_file = fw_folder / fw_info["filename"]  # type: ignore
+        fw_file = fw_folder / fw_info.filename
         if not fw_file.exists():
             log.error(f"File {fw_file} does not exist, skipping {mcu.board} on {mcu.serialport}")
             continue
-        log.info(f"Updating {mcu.board} on {mcu.serialport} to {fw_info['version']}")
+        log.info(f"Updating {mcu.board} on {mcu.serialport} to {fw_info.version}")
         updated = None
         # try:
         if mcu.port in [port for port, exts in PORT_FWTYPES.items() if ".uf2" in exts] and fw_file.suffix == ".uf2":

mpflash/mpflash/flash_esp.py

@@ -10,7 +10,7 @@ from typing import List, Optional
 import esptool
 from loguru import logger as log
 
-from mpflash.mpboard_id import find_stored_board
+from mpflash.mpboard_id import find_known_board
 from mpflash.mpremoteboard import MPRemoteBoard
 
 
@@ -22,7 +22,7 @@ def flash_esp(mcu: MPRemoteBoard, fw_file: Path, *, erase: bool = True) -> Optio
     log.info(f"Flashing {fw_file} on {mcu.board} on {mcu.serialport}")
     if not mcu.cpu:
         # Lookup CPU based on the board name
-        mcu.cpu = find_stored_board(mcu.board)["cpu"]
+        mcu.cpu = find_known_board(mcu.board).cpu
 
     cmds: List[List[str]] = []
     if erase:

mpflash/mpflash/flash_uf2.py

@@ -14,7 +14,9 @@ from rich.progress import track
 from mpflash.mpremoteboard import MPRemoteBoard
 
 from .common import PORT_FWTYPES
-from .flash_uf2_linux import dismount_uf2, wait_for_UF2_linux
+from .config import config
+from .flash_uf2_linux import dismount_uf2_linux, wait_for_UF2_linux
+from .flash_uf2_macos import wait_for_UF2_macos
 from .flash_uf2_windows import wait_for_UF2_windows
 
 
@@ -27,9 +29,9 @@ def flash_uf2(mcu: MPRemoteBoard, fw_file: Path, erase: bool) -> Optional[MPRemo
     - copy the firmware file to the drive
     - wait for the device to restart (5s)
 
-    for Lunix :
-    pmount and pumount are used to mount and unmount the drive
-    as this is not done automatically by the OS in headless mode.
+    for Linux - to support headless operation ( GH Actions ) :
+        pmount and pumount are used to mount and unmount the drive
+        as this is not done automatically by the OS in headless mode.
     """
     if ".uf2" not in PORT_FWTYPES[mcu.port]:
         log.error(f"UF2 not supported on {mcu.board} on {mcu.serialport}")
@@ -41,9 +43,15 @@ def flash_uf2(mcu: MPRemoteBoard, fw_file: Path, erase: bool) -> Optional[MPRemo
         destination = wait_for_UF2_linux()
     elif sys.platform == "win32":
         destination = wait_for_UF2_windows()
+    elif sys.platform == "darwin":
+        log.warning(f"OS {sys.platform} not tested/supported")
+        # TODO: test which of the options is best
+        if "macos_uf2" in config.tests:
+            destination = wait_for_UF2_macos()
+        else:
+            destination = wait_for_UF2_linux()
     else:
         log.warning(f"OS {sys.platform} not tested/supported")
-        destination = wait_for_UF2_linux()
         return None
 
     if not destination or not destination.exists() or not (destination / "INFO_UF2.TXT").exists():
@@ -54,8 +62,8 @@ def flash_uf2(mcu: MPRemoteBoard, fw_file: Path, erase: bool) -> Optional[MPRemo
     log.info(f"Copying {fw_file} to {destination}.")
     shutil.copy(fw_file, destination)
     log.success("Done copying, resetting the board and wait for it to restart")
-    if sys.platform in ["linux", "darwin"]:
-        dismount_uf2()
-    for _ in track(range(5 + 2), description="Waiting for the board to restart", transient=True):
+    if sys.platform in ["linux"]:
+        dismount_uf2_linux()
+    for _ in track(range(5 + 2), description="Waiting for the board to restart", transient=True, refresh_per_second=2):
         time.sleep(1)  # 5 secs to short on linux
     return mcu

mpflash/mpflash/flash_uf2_linux.py

@@ -13,28 +13,15 @@ from loguru import logger as log
 from rich.progress import track
 
 from .flash_uf2_boardid import get_board_id
+from .uf2disk import UF2Disk
 
 glb_dismount_me: List[UF2Disk] = []
 
 
-class UF2Disk:
-    """Info to support mounting and unmounting of UF2 drives on linux"""
-
-    device_path: str
-    label: str
-    mountpoint: str
-
-    def __repr__(self):
-        return repr(self.__dict__)
-
-
 def get_uf2_drives():
     """
     Get a list of all the (un)mounted UF2 drives
     """
-    if sys.platform != "linux":
-        log.error("pumount only works on Linux")
-        return
     # import blkinfo only on linux
     from blkinfo import BlkDiskInfo
 
@@ -101,7 +88,7 @@ def pumount(disk: UF2Disk):
         log.warning(f"{disk.label} already dismounted")
 
 
-def dismount_uf2():
+def dismount_uf2_linux():
     global glb_dismount_me
     for disk in glb_dismount_me:
         pumount(disk)
@@ -113,7 +100,9 @@ def wait_for_UF2_linux(s_max: int = 10):
     wait = 10
     uf2_drives = []
     # while not destination and wait > 0:
-    for _ in track(range(s_max), description="Waiting for mcu to mount as a drive", transient=True):
+    for _ in track(
+        range(s_max), description="Waiting for mcu to mount as a drive", transient=True, refresh_per_second=2
+    ):
         # log.info(f"Waiting for mcu to mount as a drive : {wait} seconds left")
         uf2_drives += list(get_uf2_drives())
         for drive in get_uf2_drives():

mpflash/mpflash/flash_uf2_macos.py

@@ -0,0 +1,78 @@
+""" Flashing UF2 based MCU on macos"""
+
+# sourcery skip: snake-case-functions
+from __future__ import annotations
+
+import sys
+import time
+from pathlib import Path
+
+from loguru import logger as log
+from rich.progress import track
+
+from .flash_uf2_boardid import get_board_id
+from .uf2disk import UF2Disk
+
+
+def get_uf2_drives():
+    """
+    Get a list of all the (un)mounted UF2 drives
+    """
+    if sys.platform != "linux":
+        log.error("pumount only works on Linux")
+        return
+    # import blkinfo only on linux
+    from blkinfo import BlkDiskInfo
+
+    myblkd = BlkDiskInfo()
+    filters = {
+        "tran": "usb",
+    }
+    usb_disks = myblkd.get_disks(filters)
+    for disk in usb_disks:
+        if disk["fstype"] == "vfat":
+            uf2_part = disk
+            # unpartioned usb disk or partition (e.g. /dev/sdb )
+            # SEEED WIO Terminal is unpartioned
+            # print( json.dumps(uf2_part, indent=4))
+            uf2 = UF2Disk()
+            uf2.device_path = "/dev/" + uf2_part["name"]
+            uf2.label = uf2_part["label"]
+            uf2.mountpoint = uf2_part["mountpoint"]
+            yield uf2
+        elif disk["type"] == "disk" and disk.get("children") and len(disk.get("children")) > 0:
+            if disk.get("children")[0]["type"] == "part" and disk.get("children")[0]["fstype"] == "vfat":
+                uf2_part = disk.get("children")[0]
+                # print( json.dumps(uf2_part, indent=4))
+                uf2 = UF2Disk()
+                uf2.device_path = "/dev/" + uf2_part["name"]
+                uf2.label = uf2_part["label"]
+                uf2.mountpoint = uf2_part["mountpoint"]
+                yield uf2
+
+
+def wait_for_UF2_macos(s_max: int = 10):
+    destination = ""
+    wait = 10
+    uf2_drives = []
+    # while not destination and wait > 0:
+    for _ in track(
+        range(s_max), description="Waiting for mcu to mount as a drive", transient=True, refresh_per_second=2
+    ):
+        # log.info(f"Waiting for mcu to mount as a drive : {wait} seconds left")
+        uf2_drives += list(get_uf2_drives())
+        for drive in get_uf2_drives():
+            time.sleep(1)
+            try:
+                if Path(drive.mountpoint, "INFO_UF2.TXT").exists():
+                    board_id = get_board_id(Path(drive.mountpoint))  # type: ignore
+                    destination = Path(drive.mountpoint)
+                    break
+            except PermissionError:
+                log.debug(f"Permission error on {drive.mountpoint}")
+                continue
+        if destination:
+            break
+        time.sleep(1)
+        wait -= 1
+    return destination

mpflash/mpflash/flash_uf2_windows.py

@@ -17,7 +17,7 @@ def wait_for_UF2_windows(s_max: int = 10):
     if s_max < 1:
         s_max = 10
     destination = ""
-    for _ in track(range(s_max), description="Waiting for mcu to mount as a drive", transient=True):
+    for _ in track(range(s_max), description="Waiting for mcu to mount as a drive", transient=True,refresh_per_second=2):
         # log.info(f"Waiting for mcu to mount as a drive : {n} seconds left")
         drives = [drive.device for drive in psutil.disk_partitions()]
         for drive in drives:

mpflash/mpflash/list.py

@@ -1,88 +1,89 @@
 from typing import List
 
-from rich import print
-from rich.progress import BarColumn, Progress, SpinnerColumn, TextColumn, TimeElapsedColumn, track
-from rich.table import Column, Table
+from rich.progress import track
+from rich.table import Table
 
 from mpflash.mpremoteboard import MPRemoteBoard
+from mpflash.vendor.versions import clean_version
 
-from .config import config
 from .logger import console
 
-rp_spinner = SpinnerColumn(finished_text="✅")
-rp_text = TextColumn("{task.description} {task.fields[device]}", table_column=Column())
-rp_bar = BarColumn(bar_width=None, table_column=Column())
 
+def show_mcus(
+    conn_mcus: List[MPRemoteBoard],
+    title: str = "Connected boards",
+    refresh: bool = True,
+):
+    console.print(mcu_table(conn_mcus, title, refresh))
 
-def list_mcus(bluetooth: bool = False):
-    """
-    Retrieves information about connected microcontroller boards.
-
-    Returns:
-        List[MPRemoteBoard]: A list of MPRemoteBoard instances with board information.
-    Raises:
-        ConnectionError: If there is an error connecting to a board.
-    """
-    conn_mcus = [MPRemoteBoard(sp) for sp in MPRemoteBoard.connected_boards(bluetooth) if sp not in config.ignore_ports]
 
-    # a lot of boilerplate to show a progress bar with the comport currenlty scanned
-    with Progress(rp_spinner, rp_text, rp_bar, TimeElapsedColumn()) as progress:
-        tsk_scan = progress.add_task("[green]Scanning", visible=False, total=None)
-        progress.tasks[tsk_scan].fields["device"] = "..."
-        progress.tasks[tsk_scan].visible = True
-        progress.start_task(tsk_scan)
-        try:
-            for mcu in conn_mcus:
-                progress.update(tsk_scan, device=mcu.serialport.replace("/dev/", ""))
-                try:
-                    mcu.get_mcu_info()
-                except ConnectionError as e:
-                    print(f"Error: {e}")
-                    continue
-        finally:
-            # transient
-            progress.stop_task(tsk_scan)
-            progress.tasks[tsk_scan].visible = False
-    return conn_mcus
+def abbrv_family(family: str, is_wide: bool) -> str:
+    if not is_wide:
+        ABRV = {"micropython": "upy", "circuitpython": "cpy", "unknown": "?"}
+        return ABRV.get(family, family[:4])
+    return family
 
 
-def show_mcus(
+def mcu_table(
     conn_mcus: List[MPRemoteBoard],
     title: str = "Connected boards",
     refresh: bool = True,
-):  # sourcery skip: extract-duplicate-method
-    """Show the list of connected boards in a nice table"""
+):
+    """
+    builds a rich table with the connected boards information
+    The columns of the table are adjusted to the terminal width
+    the columns are :
+                Narrow      Wide
+    - Serial    Yes         Yes
+    - Family    abbrv.      Yes
+    - Port      -           yes
+    - Board     Yes         Yes     BOARD_ID and Description
+    - CPU       -           Yes
+    - Version   Yes         Yes
+    - Build     *           *       only if any of the mcus have a build
+    """
     table = Table(
         title=title,
         title_style="magenta",
         header_style="bold magenta",
         collapse_padding=True,
-        width=110,
+        padding=(0, 0),
     )
-    table.add_column("Serial", overflow="fold")
-    table.add_column("Family")
-    table.add_column("Port")
+    # check if the terminal is wide enough to show all columns or if we need to collapse some
+    is_wide = console.width > 99
+    needs_build = any(mcu.build for mcu in conn_mcus)
+
+    table.add_column("Serial" if is_wide else "Ser.", overflow="fold")
+    table.add_column("Family" if is_wide else "Fam.", overflow="crop", max_width=None if is_wide else 4)
+    if is_wide:
+        table.add_column("Port")
     table.add_column("Board", overflow="fold")
     # table.add_column("Variant") # TODO: add variant
-    table.add_column("CPU")
-    table.add_column("Version")
-    table.add_column("build", justify="right")
+    if is_wide:
+        table.add_column("CPU")
+    table.add_column("Version", overflow="fold", min_width=5, max_width=16)
+    if needs_build:
+        table.add_column("Build" if is_wide else "Bld", justify="right")
 
-    for mcu in track(conn_mcus, description="Updating board info", transient=True, update_period=0.1):
+    for mcu in track(conn_mcus, description="Updating board info", transient=True, refresh_per_second=2):
         if refresh:
             try:
                 mcu.get_mcu_info()
             except ConnectionError:
                 continue
         description = f"[italic bright_cyan]{mcu.description}" if mcu.description else ""
-        table.add_row(
+        row = [
             mcu.serialport.replace("/dev/", ""),
-            mcu.family,
-            mcu.port,
-            f"{mcu.board}\n{description}".strip(),
-            # mcu.variant,
-            mcu.cpu,
-            mcu.version,
-            mcu.build,
-        )
-    console.print(table)
+            abbrv_family(mcu.family, is_wide),
+        ]
+        if is_wide:
+            row.append(mcu.port)
+        row.append(f"{mcu.board}\n{description}".strip())
+        if is_wide:
+            row.append(mcu.cpu)
+        row.append(clean_version(mcu.version))
+        if needs_build:
+            row.append(mcu.build)
+
+        table.add_row(*row)
+    return table

mpflash/mpflash/mpboard_id/__init__.py

@@ -4,53 +4,38 @@ that is included in the module.
 
 """
 
-import json
 from functools import lru_cache
-from pathlib import Path
-from typing import List, Optional, Tuple, TypedDict, Union
+from typing import List, Optional, Tuple
 
 from mpflash.errors import MPFlashError
-from mpflash.common import PORT_FWTYPES
+from mpflash.mpboard_id.board import Board
+from mpflash.mpboard_id.store import read_known_boardinfo
 from mpflash.vendor.versions import clean_version
 
+# KNOWN ports and boards are sourced from the micropython repo,
+# this info is stored in the board_info.json file
 
-# Board  based on the dataclass Board but changed to TypedDict
-# - source : get_boardnames.py
-class Board(TypedDict):
-    """MicroPython Board definition"""
 
-    description: str
-    port: str
-    board: str
-    board_name: str
-    mcu_name: str
-    path: Union[Path, str]
-    version: str
-    cpu: str
-
-
-@lru_cache(maxsize=None)
-def read_stored_boardinfo() -> List[Board]:
-    """Reads the board_info.json file and returns the data as a list of Board objects"""
-    with open(Path(__file__).parent / "board_info.json", "r") as file:
-        return json.load(file)
-
-
-def local_mp_ports() -> List[str]:
+def get_known_ports() -> List[str]:
     # TODO: Filter for Version
-    mp_boards = read_stored_boardinfo()
+    mp_boards = read_known_boardinfo()
     # select the unique ports from info
-    ports = set({board["port"] for board in mp_boards if board["port"] in PORT_FWTYPES.keys()})
+    ports = set({board.port for board in mp_boards if board.port})
     return sorted(list(ports))
 
 
-def get_stored_boards_for_port(port: str, versions: Optional[List[str]] = None):
+def get_known_boards_for_port(port: Optional[str] = "", versions: Optional[List[str]] = None) -> List[Board]:
     """
     Returns a list of boards for the given port and version(s)
 
-    port : str : The Micropython port to filter for
-    versions : List[str] : The Micropython versions to filter for (actual versions required)"""
-    mp_boards = read_stored_boardinfo()
+    port: The Micropython port to filter for
+    versions:  Optional, The Micropython versions to filter for (actual versions required)
+    """
+    mp_boards = read_known_boardinfo()
+    if versions:
+        preview_or_stable = "preview" in versions or "stable" in versions
+    else:
+        preview_or_stable = False
 
     # filter for 'preview' as they are not in the board_info.json
     # instead use stable version
@@ -62,9 +47,17 @@ def get_stored_boards_for_port(port: str, versions: Optional[List[str]] = None):
         # make sure of the v prefix
         versions = [clean_version(v) for v in versions]
         # filter for the version(s)
-        mp_boards = [board for board in mp_boards if board["version"] in versions]
+        mp_boards = [board for board in mp_boards if board.version in versions]
+        if not mp_boards and preview_or_stable:
+            # nothing found - perhaps there is a newer version for which we do not have the board info yet
+            # use the latest known version from the board info
+            mp_boards = read_known_boardinfo()
+            last_known_version = sorted({b.version for b in mp_boards})[-1]
+            mp_boards = [board for board in mp_boards if board.version == last_known_version]
+
     # filter for the port
-    mp_boards = [board for board in mp_boards if board["port"] == port]
+    if port:
+        mp_boards = [board for board in mp_boards if board.port == port]
     return mp_boards
 
 
@@ -75,22 +68,22 @@ def known_stored_boards(port: str, versions: Optional[List[str]] = None) -> List
     port : str : The Micropython port to filter for
     versions : List[str] : The Micropython versions to filter for (actual versions required)
     """
-    mp_boards = get_stored_boards_for_port(port, versions)
+    mp_boards = get_known_boards_for_port(port, versions)
 
-    boards = set({(f'{board["version"]} {board["description"]}', board["board"]) for board in mp_boards})
+    boards = set({(f"{board.version} {board.description}", board.board_id) for board in mp_boards})
     return sorted(list(boards))
 
 
 @lru_cache(maxsize=20)
-def find_stored_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"""
-    info = read_stored_boardinfo()
+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"""
+    info = read_known_boardinfo()
     for board_info in info:
-        if board_id in (board_info["board"], board_info["description"]):
-            if "cpu" not in board_info or not board_info["cpu"]:
-                if " with " in board_info["description"]:
-                    board_info["cpu"] = board_info["description"].split(" with ")[-1]
+        if board_id in (board_info.board_id, board_info.description):
+            if not board_info.cpu:
+                if " with " in board_info.description:
+                    board_info.cpu = board_info.description.split(" with ")[-1]
                 else:
-                    board_info["cpu"] = board_info["port"]
+                    board_info.cpu = board_info.port
             return board_info
     raise MPFlashError(f"Board {board_id} not found")