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

mpflash/flash_uf2_linux.py

@@ -1,123 +1,123 @@
-""" Flashing UF2 based MCU on Linux"""
-
-# sourcery skip: snake-case-functions
-from __future__ import annotations
-
-import subprocess
-import sys
-import time
-from pathlib import Path
-from typing import List
-
-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] = []
-
-
-def get_uf2_drives():
-    """
-    Get a list of all the (un)mounted UF2 drives
-    """
-    # 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 pmount(disk: UF2Disk):
-    """
-    Mount a UF2 drive if there is no mountpoint yet.
-    """
-    global glb_dismount_me
-    if not disk.mountpoint:
-        if not disk.label:
-            disk.label = "UF2BOOT"
-        disk.mountpoint = f"/media/{disk.label}"
-        # capture error if pmount is not installed
-        try:
-            subprocess.run(["pmount", disk.device_path, disk.mountpoint])
-        except FileNotFoundError:
-            log.error("pmount not found, please install it using 'sudo apt install pmount'")
-            return
-        log.debug(f"Mounted {disk.label} at {disk.mountpoint}")
-        glb_dismount_me.append(disk)
-    else:
-        log.debug(f"\n{disk.label} already mounted at {disk.mountpoint}")
-
-
-def pumount(disk: UF2Disk):
-    """
-    Unmount a UF2 drive
-    """
-    if sys.platform != "linux":
-        log.error("pumount only works on Linux")
-        return
-    if disk.mountpoint:
-        subprocess.run(["pumount", disk.mountpoint])  # ), f"/media/{disk.label}"])
-        log.info(f"Unmounted {disk.label} from {disk.mountpoint}")
-        disk.mountpoint = f""
-    else:
-        log.warning(f"{disk.label} already dismounted")
-
-
-def dismount_uf2_linux():
-    global glb_dismount_me
-    for disk in glb_dismount_me:
-        pumount(disk)
-    glb_dismount_me = []
-
-
-def wait_for_UF2_linux(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():
-            pmount(drive)
-            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
+""" Flashing UF2 based MCU on Linux"""
+
+# sourcery skip: snake-case-functions
+from __future__ import annotations
+
+import subprocess
+import sys
+import time
+from pathlib import Path
+from typing import List
+
+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] = []
+
+
+def get_uf2_drives():
+    """
+    Get a list of all the (un)mounted UF2 drives
+    """
+    # 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 pmount(disk: UF2Disk):
+    """
+    Mount a UF2 drive if there is no mountpoint yet.
+    """
+    global glb_dismount_me
+    if not disk.mountpoint:
+        if not disk.label:
+            disk.label = "UF2BOOT"
+        disk.mountpoint = f"/media/{disk.label}"
+        # capture error if pmount is not installed
+        try:
+            subprocess.run(["pmount", disk.device_path, disk.mountpoint])
+        except FileNotFoundError:
+            log.error("pmount not found, please install it using 'sudo apt install pmount'")
+            return
+        log.debug(f"Mounted {disk.label} at {disk.mountpoint}")
+        glb_dismount_me.append(disk)
+    else:
+        log.debug(f"\n{disk.label} already mounted at {disk.mountpoint}")
+
+
+def pumount(disk: UF2Disk):
+    """
+    Unmount a UF2 drive
+    """
+    if sys.platform != "linux":
+        log.error("pumount only works on Linux")
+        return
+    if disk.mountpoint:
+        subprocess.run(["pumount", disk.mountpoint])  # ), f"/media/{disk.label}"])
+        log.info(f"Unmounted {disk.label} from {disk.mountpoint}")
+        disk.mountpoint = f""
+    else:
+        log.warning(f"{disk.label} already dismounted")
+
+
+def dismount_uf2_linux():
+    global glb_dismount_me
+    for disk in glb_dismount_me:
+        pumount(disk)
+    glb_dismount_me = []
+
+
+def wait_for_UF2_linux(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():
+            pmount(drive)
+            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/flash_uf2_macos.py

@@ -1,34 +1,34 @@
-""" Flashing UF2 based MCU on macos"""
-
-# sourcery skip: snake-case-functions
-from __future__ import annotations
-
-import time
-from pathlib import Path
-from typing import Optional
-
-from rich.progress import track
-
-
-
-def wait_for_UF2_macos(s_max: int = 10) -> Optional[Path]:
-    """Wait for the MCU to mount as a drive"""
-    if s_max < 1:
-        s_max = 10
-    destination = None
-    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")
-        vol_mounts = Path("/Volumes").iterdir()
-        for vol in vol_mounts:
-            try:
-                if Path(vol, "INFO_UF2.TXT").exists():
-                    destination = Path(vol)
-                    break
-            except OSError:
-                pass
-        if destination:
-            break
-        time.sleep(1)
-    return destination
+""" Flashing UF2 based MCU on macos"""
+
+# sourcery skip: snake-case-functions
+from __future__ import annotations
+
+import time
+from pathlib import Path
+from typing import Optional
+
+from rich.progress import track
+
+
+
+def wait_for_UF2_macos(s_max: int = 10) -> Optional[Path]:
+    """Wait for the MCU to mount as a drive"""
+    if s_max < 1:
+        s_max = 10
+    destination = None
+    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")
+        vol_mounts = Path("/Volumes").iterdir()
+        for vol in vol_mounts:
+            try:
+                if Path(vol, "INFO_UF2.TXT").exists():
+                    destination = Path(vol)
+                    break
+            except OSError:
+                pass
+        if destination:
+            break
+        time.sleep(1)
+    return destination

mpflash/flash_uf2_windows.py

@@ -1,34 +1,34 @@
-# sourcery skip: snake-case-functions
-"""Flash a MCU with a UF2 bootloader on Windows"""
-
-from __future__ import annotations
-
-import time
-from pathlib import Path
-from typing import Optional
-
-import psutil
-from rich.progress import track
-
-
-
-
-def wait_for_UF2_windows(s_max: int = 10) -> Optional[Path]:
-    """Wait for the MCU to mount as a drive"""
-    if s_max < 1:
-        s_max = 10
-    destination = None
-    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:
-            try:
-                if Path(drive, "INFO_UF2.TXT").exists():
-                    destination = Path(drive)
-                    break
-            except OSError:
-                pass
-        if destination:
-            break
-        time.sleep(1)
-    return destination
+# sourcery skip: snake-case-functions
+"""Flash a MCU with a UF2 bootloader on Windows"""
+
+from __future__ import annotations
+
+import time
+from pathlib import Path
+from typing import Optional
+
+import psutil
+from rich.progress import track
+
+
+
+
+def wait_for_UF2_windows(s_max: int = 10) -> Optional[Path]:
+    """Wait for the MCU to mount as a drive"""
+    if s_max < 1:
+        s_max = 10
+    destination = None
+    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:
+            try:
+                if Path(drive, "INFO_UF2.TXT").exists():
+                    destination = Path(drive)
+                    break
+            except OSError:
+                pass
+        if destination:
+            break
+        time.sleep(1)
+    return destination

mpflash/list.py

@@ -1,89 +1,89 @@
-from typing import List
-
-from rich.progress import track
-from rich.table import Table
-
-from mpflash.mpremoteboard import MPRemoteBoard
-from mpflash.vendor.versions import clean_version
-
-from .logger import console
-
-
-def show_mcus(
-    conn_mcus: List[MPRemoteBoard],
-    title: str = "Connected boards",
-    refresh: bool = True,
-):
-    console.print(mcu_table(conn_mcus, title, refresh))
-
-
-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 mcu_table(
-    conn_mcus: List[MPRemoteBoard],
-    title: str = "Connected boards",
-    refresh: bool = True,
-):
-    """
-    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,
-        padding=(0, 0),
-    )
-    # 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
-    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, 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 ""
-        row = [
-            mcu.serialport.replace("/dev/", ""),
-            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
+from typing import List
+
+from rich.progress import track
+from rich.table import Table
+
+from mpflash.mpremoteboard import MPRemoteBoard
+from mpflash.vendor.versions import clean_version
+
+from .logger import console
+
+
+def show_mcus(
+    conn_mcus: List[MPRemoteBoard],
+    title: str = "Connected boards",
+    refresh: bool = True,
+):
+    console.print(mcu_table(conn_mcus, title, refresh))
+
+
+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 mcu_table(
+    conn_mcus: List[MPRemoteBoard],
+    title: str = "Connected boards",
+    refresh: bool = True,
+):
+    """
+    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,
+        padding=(0, 0),
+    )
+    # 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
+    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, 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 ""
+        row = [
+            mcu.serialport.replace("/dev/", ""),
+            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/logger.py

@@ -1,41 +1,41 @@
-"""Logging."""
-
-from loguru import logger as log
-from rich.console import Console
-
-from .config import config
-
-console = Console()
-
-
-def _log_formatter(record: dict) -> str:
-    """Log message formatter to combine loguru and rich formatting."""
-    color_map = {
-        "TRACE": "dim blue",
-        "DEBUG": "cyan",
-        "INFO": "bold",
-        "SUCCESS": "bold green",
-        "WARNING": "yellow",
-        "ERROR": "bold red",
-        "CRITICAL": "bold white on red",
-    }
-    lvl_color = color_map.get(record["level"].name, "cyan")
-    return (
-        "[not bold green]{time:HH:mm:ss}[/not bold green] | {level.icon} " + f"[{lvl_color}]{{message}}[/{lvl_color}]"
-    )
-
-
-def set_loglevel(loglevel: str):
-    """Set the log level for the logger"""
-    try:
-        log.remove()
-    except ValueError:
-        pass
-    log.add(console.print, level=loglevel.upper(), colorize=False, format=_log_formatter)  # type: ignore
-
-
-def make_quiet():
-    """Make the logger quiet"""
-    config.quiet = True
-    console.quiet = True
-    set_loglevel("CRITICAL")
+"""Logging."""
+
+from loguru import logger as log
+from rich.console import Console
+
+from .config import config
+
+console = Console()
+
+
+def _log_formatter(record: dict) -> str:
+    """Log message formatter to combine loguru and rich formatting."""
+    color_map = {
+        "TRACE": "dim blue",
+        "DEBUG": "cyan",
+        "INFO": "bold",
+        "SUCCESS": "bold green",
+        "WARNING": "yellow",
+        "ERROR": "bold red",
+        "CRITICAL": "bold white on red",
+    }
+    lvl_color = color_map.get(record["level"].name, "cyan")
+    return (
+        "[not bold green]{time:HH:mm:ss}[/not bold green] | {level.icon} " + f"[{lvl_color}]{{message}}[/{lvl_color}]"
+    )
+
+
+def set_loglevel(loglevel: str):
+    """Set the log level for the logger"""
+    try:
+        log.remove()
+    except ValueError:
+        pass
+    log.add(console.print, level=loglevel.upper(), colorize=False, format=_log_formatter)  # type: ignore
+
+
+def make_quiet():
+    """Make the logger quiet"""
+    config.quiet = True
+    console.quiet = True
+    set_loglevel("CRITICAL")