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

mpflash/mpflash/cli_download.py

@@ -1,18 +1,18 @@
 """CLI to Download MicroPython firmware for specific ports, boards and versions."""
 
 from pathlib import Path
-from typing import List, Tuple
 
 import rich_click as click
 from loguru import logger as log
 
+from mpflash.connected import connected_ports_boards
 from mpflash.errors import MPFlashError
-from mpflash.mpboard_id import find_stored_board
+from mpflash.mpboard_id import find_known_board
 from mpflash.vendor.versions import clean_version
 
-from .ask_input import DownloadParams, ask_missing_params
+from .ask_input import ask_missing_params
 from .cli_group import cli
-from .cli_list import list_mcus
+from .common import DownloadParams
 from .config import config
 from .download import download
 
@@ -50,6 +50,28 @@ from .download import download
     help="The board(s) to download the firmware for.",
     metavar="BOARD_ID or ?",
 )
+@click.option(
+    "--serial",
+    "--serial-port",
+    "-s",
+    "serial",
+    default=["*"],
+    show_default=True,
+    multiple=True,
+    help="Which serial port(s) to flash",
+    metavar="SERIALPORT",
+)
+@click.option(
+    "--ignore",
+    "-i",
+    is_eager=True,
+    help="Serial port(s) to ignore. Defaults to MPFLASH_IGNORE.",
+    multiple=True,
+    default=[],
+    envvar="MPFLASH_IGNORE",
+    show_default=True,
+    metavar="SERIALPORT",
+)
 @click.option(
     "--clean/--no-clean",
     default=True,
@@ -67,14 +89,25 @@ def cli_download(**kwargs) -> int:
     params = DownloadParams(**kwargs)
     params.versions = list(params.versions)
     params.boards = list(params.boards)
+    params.serial = list(params.serial)
+    params.ignore = list(params.ignore)
+
+    # all_boards: List[MPRemoteBoard] = []
     if params.boards:
-        pass
-        # TODO Clean board - same as in cli_flash.py
+        if not params.ports:
+            # no ports specified - resolve ports from specified boards by resolving board IDs
+            for board in params.boards:
+                if board != "?":
+                    try:
+                        board_ = find_known_board(board)
+                        params.ports.append(board_.port)
+                    except MPFlashError as e:
+                        log.error(f"{e}")
     else:
-        # no boards specified - detect connected boards
-        params.ports, params.boards = connected_ports_boards()
+        # no boards specified - detect connected ports and boards
+        params.ports, params.boards, _ = connected_ports_boards(include=params.serial, ignore=params.ignore)
 
-    params = ask_missing_params(params, action="download")
+    params = ask_missing_params(params)
     if not params:  # Cancelled by user
         return 2
     params.versions = [clean_version(v, drop_v=True) for v in params.versions]
@@ -93,19 +126,3 @@ def cli_download(**kwargs) -> int:
     except MPFlashError as e:
         log.error(f"{e}")
         return 1
-
-
-def connected_ports_boards() -> Tuple[List[str], List[str]]:
-    """
-    Returns a tuple containing lists of unique ports and boards from the connected MCUs.
-    Boards that are physically connected, but give no tangible response are ignored.
-
-    Returns:
-        A tuple containing two lists:
-            - A list of unique ports where MCUs are connected.
-            - A list of unique board names of the connected MCUs.
-    """
-    mpr_boards = [b for b in list_mcus() if b.connected]
-    ports = list({b.port for b in mpr_boards})
-    boards = list({b.board for b in mpr_boards})
-    return ports, boards

mpflash/mpflash/cli_flash.py

@@ -1,19 +1,23 @@
 from pathlib import Path
+from typing import List
 
 import rich_click as click
 from loguru import logger as log
 
+# from mpflash.common import filtered_comports
 from mpflash.errors import MPFlashError
-from mpflash.mpboard_id import find_stored_board
+from mpflash.mpboard_id import find_known_board
+from mpflash.mpremoteboard import MPRemoteBoard
 from mpflash.vendor.versions import clean_version
 
-from .ask_input import FlashParams, ask_missing_params
+from .ask_input import ask_missing_params
 from .cli_download import connected_ports_boards
 from .cli_group import cli
 from .cli_list import show_mcus
+from .common import FlashParams
 from .config import config
 from .flash import flash_list
-from .worklist import MPRemoteBoard, WorkList, full_auto_worklist, manual_worklist, single_auto_worklist
+from .worklist import WorkList, full_auto_worklist, manual_worklist, single_auto_worklist
 
 # #########################################################################################################
 # CLI
@@ -48,10 +52,22 @@ from .worklist import MPRemoteBoard, WorkList, full_auto_worklist, manual_workli
     "--serial-port",
     "-s",
     "serial",
-    default="auto",
+    default=["*"],
+    multiple=True,
     show_default=True,
     help="Which serial port(s) to flash",
-    metavar="SERIAL_PORT",
+    metavar="SERIALPORT",
+)
+@click.option(
+    "--ignore",
+    "-i",
+    is_eager=True,
+    help="Serial port(s) to ignore. Defaults to MPFLASH_IGNORE.",
+    multiple=True,
+    default=[],
+    envvar="MPFLASH_IGNORE",
+    show_default=True,
+    metavar="SERIALPORT",
 )
 @click.option(
     "--port",
@@ -101,31 +117,31 @@ def cli_flash_board(**kwargs) -> int:
         kwargs["boards"] = [kwargs.pop("board")]
 
     params = FlashParams(**kwargs)
+    params.versions = list(params.versions)
+    params.boards = list(params.boards)
+    params.serial = list(params.serial)
+    params.ignore = list(params.ignore)
+
+    # make it simple for the user to flash one board by asking for the serial port if not specified
+    if params.boards == ["?"] and params.serial == "*":
+        params.serial = ["?"]
+
+    # Detect connected boards if not specified,
+    # and ask for input if boards cannot be detected
+    all_boards: List[MPRemoteBoard] = []
     if not params.boards or params.boards == []:
         # nothing specified - detect connected boards
-        params.ports, params.boards = connected_ports_boards()
+        params.ports, params.boards, all_boards = connected_ports_boards(include=params.ports, ignore=params.ignore)
         if params.boards == []:
             # No MicroPython boards detected, but it could be unflashed or not in bootloader mode
             # Ask for serial port and board_id to flash
-            params.serial = "?"
+            params.serial = ["?"]
             params.boards = ["?"]
     else:
-        for board_id in params.boards:
-            if board_id == "":
-                params.boards.remove(board_id)
-                continue
-            if " " in board_id:
-                try:
-                    info = find_stored_board(board_id)
-                    if info:
-                        log.info(f"Resolved board description: {info['board']}")
-                        params.boards.remove(board_id)
-                        params.boards.append(info["board"])
-                except Exception as e:
-                    log.warning(f"unable to resolve board description: {e}")
+        resolve_board_ids(params)
 
     # Ask for missing input if needed
-    params = ask_missing_params(params, action="flash")
+    params = ask_missing_params(params)
     if not params:  # Cancelled by user
         return 2
     # TODO: Just in time Download of firmware
@@ -135,27 +151,33 @@ def cli_flash_board(**kwargs) -> int:
     if len(params.versions) > 1:
         log.error(f"Only one version can be flashed at a time, not {params.versions}")
         raise MPFlashError("Only one version can be flashed at a time")
-    # if len(params.boards) > 1:
-    #     log.error(f"Only one board can be flashed at a time, not {params.boards}")
-    #     raise MPFlashError("Only one board can be flashed at a time")
 
     params.versions = [clean_version(v) for v in params.versions]
     worklist: WorkList = []
     # if serial port == auto and there are one or more specified/detected boards
-    if params.serial == "auto" and params.boards:
-        worklist = full_auto_worklist(version=params.versions[0], fw_folder=params.fw_folder)
+    if params.serial == ["*"] and params.boards:
+        if not all_boards:
+            log.trace("No boards detected yet, scanning for connected boards")
+            _, _, all_boards = connected_ports_boards(include=params.ports, ignore=params.ignore)
+        worklist = full_auto_worklist(
+            all_boards=all_boards,
+            version=params.versions[0],
+            fw_folder=params.fw_folder,
+            include=params.serial,
+            ignore=params.ignore,
+        )
     elif params.versions[0] and params.boards[0] and params.serial:
-        # A single serial port including the board / variant
+        # A one or more  serial port including the board / variant
         worklist = manual_worklist(
-            params.versions[0],
-            params.fw_folder,
-            params.serial,
-            params.boards[0],
+            params.serial[0],
+            board_id=params.boards[0],
+            version=params.versions[0],
+            fw_folder=params.fw_folder,
         )
     else:
         # just this serial port on auto
         worklist = single_auto_worklist(
-            serial_port=params.serial,
+            serial=params.serial[0],
             version=params.versions[0],
             fw_folder=params.fw_folder,
         )
@@ -172,3 +194,19 @@ def cli_flash_board(**kwargs) -> int:
     else:
         log.error("No boards were flashed")
         return 1
+
+
+def resolve_board_ids(params):
+    """Resolve board descriptions to board_id, and remove empty strings from list of boards"""
+    for board_id in params.boards:
+        if board_id == "":
+            params.boards.remove(board_id)
+            continue
+        if " " in board_id:
+            try:
+                if info := find_known_board(board_id):
+                    log.info(f"Resolved board description: {info.board_id}")
+                    params.boards.remove(board_id)
+                    params.boards.append(info.board_id)
+            except Exception as e:
+                log.warning(f"Unable to resolve board description: {e}")

mpflash/mpflash/cli_group.py

@@ -12,23 +12,26 @@ from .logger import make_quiet, set_loglevel
 def cb_verbose(ctx, param, value):
     """Callback to set the log level to DEBUG if verbose is set"""
     if value and not config.quiet:
-        set_loglevel("DEBUG")
         config.verbose = True
+        if value > 1:
+            set_loglevel("TRACE")
+        else:
+            set_loglevel("DEBUG")
     else:
         set_loglevel("INFO")
         config.verbose = False
     return value
 
 
-def cb_ignore(ctx, param, value):
+def cb_interactive(ctx, param, value):
     if value:
-        config.ignore_ports = list(value)
+        config.interactive = value
     return value
 
 
-def cb_interactive(ctx, param, value):
+def cb_test(ctx, param, value):
     if value:
-        config.interactive = value
+        config.tests = value
     return value
 
 
@@ -64,21 +67,20 @@ def cb_quiet(ctx, param, value):
     "-V",
     "--verbose",
     is_eager=True,
-    is_flag=True,
+    count=True,
     help="Enables verbose mode.",
     callback=cb_verbose,
 )
 @click.option(
-    "--ignore",
-    "-i",
+    "--test",
     is_eager=True,
-    help="Serial port(s) to ignore. Defaults to MPFLASH_IGNORE.",
-    callback=cb_ignore,
+    help="test a specific feature",
+    callback=cb_test,
     multiple=True,
     default=[],
-    envvar="MPFLASH_IGNORE",
+    envvar="MPFLASH_TEST",
     show_default=True,
-    metavar="SERIALPORT",
+    metavar="TEST",
 )
 def cli(**kwargs):
     """mpflash - MicroPython Tool.

mpflash/mpflash/cli_list.py

@@ -1,11 +1,13 @@
 import json
+from typing import List
 
 import rich_click as click
 from rich import print
 
 from .cli_group import cli
-from .list import list_mcus, show_mcus
+from .list import show_mcus
 from .logger import make_quiet
+from .connected import list_mcus
 
 
 @cli.command("list", help="List the connected MCU boards.")
@@ -18,21 +20,55 @@ from .logger import make_quiet
     show_default=True,
     help="""Output in json format""",
 )
+@click.option(
+    "--serial",
+    "--serial-port",
+    "-s",
+    "serial",
+    default=["*"],
+    multiple=True,
+    show_default=True,
+    help="Which serial port(s) to list. ",
+    metavar="SERIALPORT",
+)
+@click.option(
+    "--ignore",
+    "-i",
+    is_eager=True,
+    help="Serial port(s) 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(as_json: bool, progress: bool = True) -> int:
+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()
+    conn_mcus = list_mcus(ignore=ignore, include=serial, bluetooth=bluetooth)
     if as_json:
         print(json.dumps([mcu.__dict__ for mcu in conn_mcus], indent=4))
         progress = False

mpflash/mpflash/cli_main.py

@@ -2,7 +2,10 @@
 
 # import rich_click as click
 
+import os
+
 import click
+from loguru import logger as log
 
 from .cli_download import cli_download
 from .cli_flash import cli_flash_board
@@ -11,16 +14,24 @@ from .cli_list import cli_list_mcus
 
 
 def mpflash():
-    cli.add_command(cli_flash_board)
     cli.add_command(cli_list_mcus)
     cli.add_command(cli_download)
+    cli.add_command(cli_flash_board)
+
     # cli(auto_envvar_prefix="MPFLASH")
-    try:
+    if False and os.environ.get("COMPUTERNAME") == "JOSVERL-S4":
+        # intentional less error suppression on dev machine
         result = cli(standalone_mode=False)
-        exit(result)
-    except AttributeError as e:
-        print(f"Error: {e}")
-        exit(-1)
+    else:
+        try:
+            result = cli(standalone_mode=False)
+            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)
 
 
 if __name__ == "__main__":

mpflash/mpflash/common.py

@@ -1,11 +1,16 @@
+import fnmatch
 import os
-import time
-from typing import TypedDict
+import sys
+from dataclasses import dataclass, field
+from pathlib import Path
+from typing import List, Optional, Union
 
 from github import Auth, Github
-from rich.progress import track
+from serial.tools import list_ports
+from serial.tools.list_ports_common import ListPortInfo
+
+from .logger import log
 
-from mpflash.errors import MPFlashError
 # from mpflash.mpremoteboard import MPRemoteBoard
 
 PORT_FWTYPES = {
@@ -14,6 +19,7 @@ PORT_FWTYPES = {
     "esp8266": [".bin"],
     "rp2": [".uf2"],
     "samd": [".uf2"],
+    # below this not yet implemented / tested
     "mimxrt": [".hex"],
     "nrf": [".uf2"],
     "renesas-ra": [".hex"],
@@ -28,11 +34,118 @@ PAT = os.environ.get("GITHUB_TOKEN") or PAT_NO_ACCESS
 GH_CLIENT = Github(auth=Auth.Token(PAT))
 
 
-class FWInfo(TypedDict):
-    filename: str
-    port: str
-    board: str
-    variant: str
-    preview: bool
-    version: str
-    build: str
+@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
+    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
+
+
+@dataclass
+class FlashParams(Params):
+    """Parameters for flashing a board"""
+
+    erase: bool = True
+    bootloader: bool = True
+    cpu: str = ""
+
+
+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.
+    """
+    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)]
+    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)

mpflash/mpflash/config.py

@@ -14,6 +14,8 @@ class MPtoolConfig:
     ignore_ports: List[str] = []
     interactive: bool = True
     firmware_folder: Path = platformdirs.user_downloads_path() / "firmware"
+    # test options specified on the commandline
+    tests: List[str] = []
 
 
 config = MPtoolConfig()

mpflash/mpflash/connected.py

@@ -0,0 +1,74 @@
+from typing import List, Tuple
+
+from rich import print
+from rich.progress import BarColumn, Progress, SpinnerColumn, TextColumn, TimeElapsedColumn
+from rich.table import Column
+
+from mpflash.mpremoteboard import MPRemoteBoard
+
+from .common import filtered_comports
+
+
+def connected_ports_boards(
+    *, include: List[str], ignore: List[str]
+) -> Tuple[List[str], List[str], List[MPRemoteBoard]]:
+    """
+    Returns a tuple containing lists of unique ports and boards from the connected MCUs.
+    Boards that are physically connected, but give no tangible response are ignored.
+
+    Returns:
+        A tuple containing three lists:
+            - A list of unique ports where MCUs are connected.
+            - A list of unique board names of the connected MCUs.
+            - A list of MPRemoteBoard instances of the connected MCUs.
+    """
+    mpr_boards = [b for b in list_mcus(include=include, ignore=ignore) if b.connected]
+    ports = list({b.port for b in mpr_boards})
+    boards = list({b.board for b in mpr_boards})
+    return (ports, boards, mpr_boards)
+
+
+# #########################################################################################################
+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 list_mcus(*, ignore: List[str], include: List[str], 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]
+
+    comports = filtered_comports(
+        ignore=ignore,
+        include=include,
+        bluetooth=bluetooth,
+    )
+    conn_mcus = [MPRemoteBoard(c.device) for c in comports]
+
+    # a lot of boilerplate to show a progress bar with the comport currently scanned
+    # low update rate to facilitate screen readers/narration
+    with Progress(rp_spinner, rp_text, rp_bar, TimeElapsedColumn(), refresh_per_second=2) 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