mpflash 1.0.1__py3-none-any.whl → 1.0.2__py3-none-any.whl

mpflash/cli_list.py

@@ -1,87 +1,87 @@
-import json
-from typing import List
-
-import rich_click as click
-from rich import print
-
-from .cli_group import cli
-from .connected import list_mcus
-from .list import show_mcus
-from .logger import make_quiet
-
-
-@cli.command(
-    "list",
-    help="List the connected MCU boards. alias: devs",
-    aliases=["devs"],
-)
-@click.option(
-    "--json",
-    "-j",
-    "as_json",
-    is_flag=True,
-    default=False,
-    show_default=True,
-    help="""Output in json format""",
-)
-@click.option(
-    "--serial",
-    "--serial-port",
-    "-s",
-    "serial",
-    default=["*"],
-    multiple=True,
-    show_default=True,
-    help="Serial port(s) (or globs) to list. ",
-    metavar="SERIALPORT",
-)
-@click.option(
-    "--ignore",
-    "-i",
-    is_eager=True,
-    help="Serial port(s) (or globs) to ignore. Defaults to MPFLASH_IGNORE.",
-    multiple=True,
-    default=[],
-    envvar="MPFLASH_IGNORE",
-    show_default=True,
-    metavar="SERIALPORT",
-)
-@click.option(
-    "--bluetooth/--no-bluetooth",
-    "-b/-nb",
-    is_flag=True,
-    default=False,
-    show_default=True,
-    help="""Include bluetooth ports in the list""",
-)
-@click.option(
-    "--progress/--no-progress",
-    # "-p/-np", -p is already used for --port
-    "progress",
-    is_flag=True,
-    default=True,
-    show_default=True,
-    help="""Show progress""",
-)
-def cli_list_mcus(serial: List[str], ignore: List[str], bluetooth: bool, as_json: bool, progress: bool = True) -> int:
-    """List the connected MCU boards, and output in a nice table or json."""
-    serial = list(serial)
-    ignore = list(ignore)
-    if as_json:
-        # avoid noise in json output
-        make_quiet()
-    # TODO? Ask user to select a serialport if [?] is given ?
-
-    conn_mcus = list_mcus(ignore=ignore, include=serial, bluetooth=bluetooth)
-    # ignore boards that have the [micropython-stubber] ignore flag set
-    conn_mcus = [item for item in conn_mcus if not (item.toml.get("mpflash", {}).get("ignore", False))]    
-    if as_json:
-        # remove the path and firmware attibutes from the json output as they are always empty
-        for mcu in conn_mcus:
-            del mcu.path
-            del mcu.firmware
-        print(json.dumps([mcu.__dict__ for mcu in conn_mcus], indent=4))
-        progress = False
-    if progress:
-        show_mcus(conn_mcus, refresh=False)
-    return 0 if conn_mcus else 1
+import json
+from typing import List
+
+import rich_click as click
+from rich import print
+
+from .cli_group import cli
+from .connected import list_mcus
+from .list import show_mcus
+from .logger import make_quiet
+
+
+@cli.command(
+    "list",
+    help="List the connected MCU boards. alias: devs",
+    aliases=["devs"],
+)
+@click.option(
+    "--json",
+    "-j",
+    "as_json",
+    is_flag=True,
+    default=False,
+    show_default=True,
+    help="""Output in json format""",
+)
+@click.option(
+    "--serial",
+    "--serial-port",
+    "-s",
+    "serial",
+    default=["*"],
+    multiple=True,
+    show_default=True,
+    help="Serial port(s) (or globs) to list. ",
+    metavar="SERIALPORT",
+)
+@click.option(
+    "--ignore",
+    "-i",
+    is_eager=True,
+    help="Serial port(s) (or globs) to ignore. Defaults to MPFLASH_IGNORE.",
+    multiple=True,
+    default=[],
+    envvar="MPFLASH_IGNORE",
+    show_default=True,
+    metavar="SERIALPORT",
+)
+@click.option(
+    "--bluetooth/--no-bluetooth",
+    "-b/-nb",
+    is_flag=True,
+    default=False,
+    show_default=True,
+    help="""Include bluetooth ports in the list""",
+)
+@click.option(
+    "--progress/--no-progress",
+    # "-p/-np", -p is already used for --port
+    "progress",
+    is_flag=True,
+    default=True,
+    show_default=True,
+    help="""Show progress""",
+)
+def cli_list_mcus(serial: List[str], ignore: List[str], bluetooth: bool, as_json: bool, progress: bool = True) -> int:
+    """List the connected MCU boards, and output in a nice table or json."""
+    serial = list(serial)
+    ignore = list(ignore)
+    if as_json:
+        # avoid noise in json output
+        make_quiet()
+    # TODO? Ask user to select a serialport if [?] is given ?
+
+    conn_mcus = list_mcus(ignore=ignore, include=serial, bluetooth=bluetooth)
+    # ignore boards that have the [micropython-stubber] ignore flag set
+    conn_mcus = [item for item in conn_mcus if not (item.toml.get("mpflash", {}).get("ignore", False))]    
+    if as_json:
+        # remove the path and firmware attibutes from the json output as they are always empty
+        for mcu in conn_mcus:
+            del mcu.path
+            del mcu.firmware
+        print(json.dumps([mcu.__dict__ for mcu in conn_mcus], indent=4))
+        progress = False
+    if progress:
+        show_mcus(conn_mcus, refresh=False)
+    return 0 if conn_mcus else 1

mpflash/cli_main.py

@@ -1,39 +1,39 @@
-"""mpflash is a CLI to download and flash MicroPython firmware to various boards."""
-
-import os
-
-import click.exceptions as click_exceptions
-from loguru import logger as log
-
-from .cli_download import cli_download
-from .cli_flash import cli_flash_board
-from .cli_group import cli
-from .cli_list import cli_list_mcus
-
-
-def mpflash():
-    cli.add_command(cli_list_mcus)
-    cli.add_command(cli_download)
-    cli.add_command(cli_flash_board)
-
-    # cli(auto_envvar_prefix="MPFLASH")
-    if False and os.environ.get("COMPUTERNAME").startswith("JOSVERL"):
-        # intentional less error suppression on dev machine
-        result = cli(standalone_mode=False)
-    else:
-        try:
-            result = cli(standalone_mode=True)
-            exit(result)
-        except AttributeError as e:
-            log.error(f"Error: {e}")
-            exit(-1)
-        except click_exceptions.ClickException as e:
-            log.error(f"Error: {e}")
-            exit(-2)
-        except click_exceptions.Abort as e:
-            # Aborted - Ctrl-C
-            exit(-3)
-
-
-if __name__ == "__main__":
-    mpflash()
+"""mpflash is a CLI to download and flash MicroPython firmware to various boards."""
+
+import os
+
+import click.exceptions as click_exceptions
+from loguru import logger as log
+
+from .cli_download import cli_download
+from .cli_flash import cli_flash_board
+from .cli_group import cli
+from .cli_list import cli_list_mcus
+
+
+def mpflash():
+    cli.add_command(cli_list_mcus)
+    cli.add_command(cli_download)
+    cli.add_command(cli_flash_board)
+
+    # cli(auto_envvar_prefix="MPFLASH")
+    if False and os.environ.get("COMPUTERNAME").startswith("JOSVERL"):
+        # intentional less error suppression on dev machine
+        result = cli(standalone_mode=False)
+    else:
+        try:
+            result = cli(standalone_mode=True)
+            exit(result)
+        except AttributeError as e:
+            log.error(f"Error: {e}")
+            exit(-1)
+        except click_exceptions.ClickException as e:
+            log.error(f"Error: {e}")
+            exit(-2)
+        except click_exceptions.Abort as e:
+            # Aborted - Ctrl-C
+            exit(-3)
+
+
+if __name__ == "__main__":
+    mpflash()

mpflash/common.py

@@ -1,177 +1,210 @@
-import fnmatch
-import os
-import sys
-from dataclasses import dataclass, field
-from enum import Enum
-from pathlib import Path
-from typing import List, Optional, Union
-
-from github import Auth, Github
-from serial.tools import list_ports
-from serial.tools.list_ports_common import ListPortInfo
-
-from .logger import log
-
-# from mpflash.mpremoteboard import MPRemoteBoard
-
-PORT_FWTYPES = {
-    "stm32": [".dfu"],  # need .dfu for pydfu.py - .hex for cube cli/GUI
-    "esp32": [".bin"],
-    "esp8266": [".bin"],
-    "rp2": [".uf2"],
-    "samd": [".uf2"],
-    # below this not yet implemented / tested
-    "mimxrt": [".hex"],
-    "nrf": [".uf2"],
-    "renesas-ra": [".hex"],
-}
-
-# Token with no permissions to avoid throttling
-# https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#getting-a-higher-rate-limit
-PAT_NO_ACCESS = (
-    "github_pat"
-    + "_11AAHPVFQ0qAkDnSUaMKSp"
-    + "_ZkDl5NRRwBsUN6EYg9ahp1Dvj4FDDONnXVgimxC2EtpY7Q7BUKBoQ0Jq72X"
-)
-PAT = os.environ.get("GITHUB_TOKEN") or PAT_NO_ACCESS
-GH_CLIENT = Github(auth=Auth.Token(PAT))
-
-
-@dataclass
-class FWInfo:
-    """
-    Downloaded Firmware information
-    is somewhat related to the BOARD class in the mpboard_id module
-    """
-
-    port: str  # MicroPython port
-    board: str  # MicroPython board
-    filename: str = field(default="")  # relative filename of the firmware image
-    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 (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
-    family: str = field(default="micropython")  # The family of the firmware
-    custom: bool = field(default=False)  # True if the firmware is a custom build
-    description: str = field(default="")  # Description used by this firmware (custom only)
-
-    def to_dict(self) -> dict:
-        """Convert the object to a dictionary"""
-        return self.__dict__
-
-    @classmethod
-    def from_dict(cls, data: dict) -> "FWInfo":
-        """Create a FWInfo object from a dictionary"""
-        # add missing keys
-        if "ext" not in data:
-            data["ext"] = Path(data["firmware"]).suffix
-        if "family" not in data:
-            data["family"] = "micropython"
-        return cls(**data)
-
-
-@dataclass
-class Params:
-    """Common parameters for downloading and flashing firmware"""
-
-    ports: List[str] = field(default_factory=list)
-    boards: List[str] = field(default_factory=list)
-    versions: List[str] = field(default_factory=list)
-    fw_folder: Path = Path()
-    serial: List[str] = field(default_factory=list)
-    ignore: List[str] = field(default_factory=list)
-
-
-@dataclass
-class DownloadParams(Params):
-    """Parameters for downloading firmware"""
-
-    clean: bool = False
-    force: bool = False
-
-
-class BootloaderMethod(Enum):
-    AUTO = "auto"
-    MANUAL = "manual"
-    MPY = "mpy"
-    TOUCH_1200 = "touch1200"
-    NONE = "none"
-
-
-@dataclass
-class FlashParams(Params):
-    """Parameters for flashing a board"""
-
-    erase: bool = True
-    bootloader: BootloaderMethod = BootloaderMethod.NONE
-    cpu: str = ""
-
-    def __post_init__(self):
-        if isinstance(self.bootloader, str):
-            self.bootloader = BootloaderMethod(self.bootloader)
-
-
-ParamType = Union[DownloadParams, FlashParams]
-
-
-def filtered_comports(
-    ignore: Optional[List[str]] = None,
-    include: Optional[List[str]] = None,
-    bluetooth: bool = False,
-) -> List[ListPortInfo]:  # sourcery skip: assign-if-exp
-    """
-    Get a list of filtered comports using the include and ignore lists.
-    both can be globs (e.g. COM*) or exact port names (e.g. COM1)
-    """
-    if not ignore:
-        ignore = []
-    elif not isinstance(ignore, list):  # type: ignore
-        ignore = list(ignore)
-    if not include:
-        include = ["*"]
-    elif not isinstance(include, list):  # type: ignore
-        include = list(include)
-
-    # remove ports that are to be ignored
-    log.trace(f"{include=}, {ignore=}, {bluetooth=}")
-    # use p.location to filter out the bogus ports on newer Linux kernels
-    comports = [
-        p
-        for p in list_ports.comports()
-        if p.location and not any(fnmatch.fnmatch(p.device, i) for i in ignore)
-    ]
-    log.trace(f"comports: {[p.device for p in comports]}")
-    # remove bluetooth ports
-
-    if include != ["*"]:
-        # if there are explicit ports to include, add them to the list
-        explicit = [
-            p for p in list_ports.comports() if any(fnmatch.fnmatch(p.device, i) for i in include)
-        ]
-        log.trace(f"explicit: {[p.device for p in explicit]}")
-        if ignore == []:
-            # if nothing to ignore, just use the explicit list as a sinple sane default
-            comports = explicit
-        else:
-            # if there are ports to ignore, add the explicit list to the filtered list
-            comports = list(set(explicit) | set(comports))
-    if not bluetooth:
-        # filter out bluetooth ports
-        comports = [p for p in comports if "bluetooth" not in p.description.lower()]
-        comports = [p for p in comports if "BTHENUM" not in p.hwid]
-        if sys.platform == "darwin":
-            comports = [p for p in comports if ".Bluetooth" not in p.device]
-        log.trace(f"no Bluetooth: {[p.device for p in comports]}")
-    log.debug(f"filtered_comports: {[p.device for p in comports]}")
-    # sort
-    if sys.platform == "win32":
-        # Windows sort of comports by number - but fallback to device name
-        return sorted(
-            comports,
-            key=lambda x: int(x.device.split()[0][3:]) if x.device.split()[0][3:].isdigit() else x,
-        )
-    # sort by device name
-    return sorted(comports, key=lambda x: x.device)
+import fnmatch
+import glob
+import os
+import platform
+import sys
+from dataclasses import dataclass, field
+from enum import Enum
+from pathlib import Path
+from typing import List, Optional, Union
+
+from github import Auth, Github
+from serial.tools import list_ports
+from serial.tools.list_ports_common import ListPortInfo
+
+from .logger import log
+
+# from mpflash.mpremoteboard import MPRemoteBoard
+
+PORT_FWTYPES = {
+    "stm32": [".dfu"],  # need .dfu for pydfu.py - .hex for cube cli/GUI
+    "esp32": [".bin"],
+    "esp8266": [".bin"],
+    "rp2": [".uf2"],
+    "samd": [".uf2"],
+    # below this not yet implemented / tested
+    "mimxrt": [".hex"],
+    "nrf": [".uf2"],
+    "renesas-ra": [".hex"],
+}
+
+# Token with no permissions to avoid throttling
+# https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#getting-a-higher-rate-limit
+PAT_NO_ACCESS = (
+    "github_pat"
+    + "_11AAHPVFQ0qAkDnSUaMKSp"
+    + "_ZkDl5NRRwBsUN6EYg9ahp1Dvj4FDDONnXVgimxC2EtpY7Q7BUKBoQ0Jq72X"
+)
+PAT = os.environ.get("GITHUB_TOKEN") or PAT_NO_ACCESS
+GH_CLIENT = Github(auth=Auth.Token(PAT))
+
+
+@dataclass
+class FWInfo:
+    """
+    Downloaded Firmware information
+    is somewhat related to the BOARD class in the mpboard_id module
+    """
+
+    port: str  # MicroPython port
+    board: str  # MicroPython board
+    filename: str = field(default="")  # relative filename of the firmware image
+    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 (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
+    family: str = field(default="micropython")  # The family of the firmware
+    custom: bool = field(default=False)  # True if the firmware is a custom build
+    description: str = field(default="")  # Description used by this firmware (custom only)
+
+    def to_dict(self) -> dict:
+        """Convert the object to a dictionary"""
+        return self.__dict__
+
+    @classmethod
+    def from_dict(cls, data: dict) -> "FWInfo":
+        """Create a FWInfo object from a dictionary"""
+        # add missing keys
+        if "ext" not in data:
+            data["ext"] = Path(data["firmware"]).suffix
+        if "family" not in data:
+            data["family"] = "micropython"
+        return cls(**data)
+
+
+@dataclass
+class Params:
+    """Common parameters for downloading and flashing firmware"""
+
+    ports: List[str] = field(default_factory=list)
+    boards: List[str] = field(default_factory=list)
+    versions: List[str] = field(default_factory=list)
+    fw_folder: Path = Path()
+    serial: List[str] = field(default_factory=list)
+    ignore: List[str] = field(default_factory=list)
+    bluetooth: bool = False
+
+
+@dataclass
+class DownloadParams(Params):
+    """Parameters for downloading firmware"""
+
+    clean: bool = False
+    force: bool = False
+
+
+class BootloaderMethod(Enum):
+    AUTO = "auto"
+    MANUAL = "manual"
+    MPY = "mpy"
+    TOUCH_1200 = "touch1200"
+    NONE = "none"
+
+
+@dataclass
+class FlashParams(Params):
+    """Parameters for flashing a board"""
+
+    erase: bool = True
+    bootloader: BootloaderMethod = BootloaderMethod.NONE
+    cpu: str = ""
+
+    def __post_init__(self):
+        if isinstance(self.bootloader, str):
+            self.bootloader = BootloaderMethod(self.bootloader)
+
+
+ParamType = Union[DownloadParams, FlashParams]
+
+
+def filtered_comports(
+    ignore: Optional[List[str]] = None,
+    include: Optional[List[str]] = None,
+    bluetooth: bool = False,
+) -> List[ListPortInfo]:  # sourcery skip: assign-if-exp
+    """
+    Get a list of filtered comports using the include and ignore lists.
+    both can be globs (e.g. COM*) or exact port names (e.g. COM1)
+    """
+    if not ignore:
+        ignore = []
+    elif not isinstance(ignore, list):  # type: ignore
+        ignore = list(ignore)
+    if not include:
+        include = ["*"]
+    elif not isinstance(include, list):  # type: ignore
+        include = list(include)
+
+    # remove ports that are to be ignored
+    log.trace(f"{include=}, {ignore=}, {bluetooth=}")
+
+    comports = [
+        p for p in list_ports.comports() if not any(fnmatch.fnmatch(p.device, i) for i in ignore)
+    ]
+    if platform.system() == "Linux":
+        # use p.location to filter out the bogus ports on newer Linux kernels
+        # filter out the bogus ports on newer Linux kernels
+        comports = [p for p in comports if p.location]
+
+    log.trace(f"comports: {[p.device for p in comports]}")
+    # remove bluetooth ports
+
+    if include != ["*"]:
+        # if there are explicit ports to include, add them to the list
+        explicit = [
+            p for p in list_ports.comports() if any(fnmatch.fnmatch(p.device, i) for i in include)
+        ]
+        log.trace(f"explicit: {[p.device for p in explicit]}")
+        if ignore == []:
+            # if nothing to ignore, just use the explicit list as a sinple sane default
+            comports = explicit
+        else:
+            # if there are ports to ignore, add the explicit list to the filtered list
+            comports = list(set(explicit) | set(comports))
+    if not bluetooth:
+        # filter out bluetooth ports
+        comports = [p for p in comports if "bluetooth" not in p.description.lower()]
+        comports = [p for p in comports if "BTHENUM" not in p.hwid]
+        if sys.platform == "darwin":
+            comports = [p for p in comports if ".Bluetooth" not in p.device]
+        log.trace(f"no Bluetooth: {[p.device for p in comports]}")
+    log.debug(f"filtered_comports: {[p.device for p in comports]}")
+    # sort
+    if sys.platform == "win32":
+        # Windows sort of comports by number - but fallback to device name
+        return sorted(
+            comports,
+            key=lambda x: int(x.device.split()[0][3:]) if x.device.split()[0][3:].isdigit() else x,
+        )
+    # sort by device name
+    return sorted(comports, key=lambda x: x.device)
+
+
+def find_serial_by_path(target_port: str):
+    """Find the symbolic link path of a serial port by its device path."""
+    # sourcery skip: use-next
+
+    if os.name == "nt":
+        return None
+    # List all available serial ports
+    available_ports = list_ports.comports()
+    # Filter to get the device path of the target port
+    target_device_path = None
+    for port in available_ports:
+        if port.device == target_port:
+            target_device_path = port.device
+            break
+
+    if not target_device_path:
+        return None  # Target port not found among available ports
+
+    # Search for all symbolic links in /dev/serial/by-path/
+    for symlink in glob.glob("/dev/serial/by-path/*"):
+        # Resolve the symbolic link to its target
+        if os.path.realpath(symlink) == target_device_path:
+            return symlink  # Return the matching symlink path
+
+    return None  # Return None if no match is found