micropython-stubber 1.20.1__tar.gz → 1.20.2__tar.gz

{micropython_stubber-1.20.1 → micropython_stubber-1.20.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: micropython-stubber
-Version: 1.20.1
+Version: 1.20.2
 Summary: Tooling to create and maintain stubs for MicroPython
 Home-page: https://github.com/Josverl/micropython-stubber#readme
 License: MIT
@@ -129,8 +129,8 @@ cd my_stub_folder
 mkdir all-stubs
 
 # clone the micropython repo's and switch to a specific version 
-stubber clone
-stubber switch --version v1.18
+stubber clone --add-stubs
+stubber switch v1.22.2
 
 # get the document stubs for the current version ( v1.18 )
 stubber get-docstubs

{micropython_stubber-1.20.1 → micropython_stubber-1.20.2}/pyproject.toml

@@ -8,7 +8,7 @@ repo-path = "./repos"
 
 [tool.poetry]
 name = "micropython-stubber"
-version = "1.20.1"
+version = "1.20.2"
 description = "Tooling to create and maintain stubs for MicroPython"
 authors = ["Jos Verlinde <jos_verlinde@hotmail.com>"]
 license = "MIT"
@@ -97,6 +97,7 @@ pytest-mock = "^3.10.0"
 mock = "^4.0.3"
 distro = "^1.8.0"
 fasteners = "^0.19"
+jsons = "^1.6.3"
 
 [tool.poetry.group.dev]
 optional = true
@@ -141,6 +142,7 @@ exclude = [
 
     "**/all-stubs",
     "src/stubber/board/stubs",
+    "**/.venv"
 ]
 ignore = [
     "tests/mocks",
@@ -164,6 +166,7 @@ reportInvalidStringEscapeSequence = "information"
 reportUnboundVariable = "information"
 ReportSelfClsParameterName = "information"
 reportOptionalSubscript = "information"
+reportCallInDefaultInitializer = "error"
 # Section 3 -  reduce noise 
 reportMissingTypeStubs = "none"
 reportOptionalMemberAccess = "none"      # "read" is not a known member of "None" - occurs often in frozen code

{micropython_stubber-1.20.1 → micropython_stubber-1.20.2}/readme.md

@@ -79,8 +79,8 @@ cd my_stub_folder
 mkdir all-stubs
 
 # clone the micropython repo's and switch to a specific version 
-stubber clone
-stubber switch --version v1.18
+stubber clone --add-stubs
+stubber switch v1.22.2
 
 # get the document stubs for the current version ( v1.18 )
 stubber get-docstubs

{micropython_stubber-1.20.1 → micropython_stubber-1.20.2}/src/mpflash/README.md

@@ -1,12 +1,24 @@
 # MPFLASH
+  [![pypi version](https://badgen.net/pypi/v/mpflash)](https://pypi.org/project/mpflash/)
+  [![python versions](https://badgen.net/pypi/python/mpflash)](https://badgen.net/pypi/python/mpflash)
+[![Downloads](https://static.pepy.tech/badge/mpflash)](https://pepy.tech/project/mpflash)
+
 
 `mpflash` is a command-line tool for working with MicroPython firmware. It provides features to help you flash and update Micropython on one or more .
 
-This tool was initially created to be used in a CI/CD pipeline to automate the process of downloading and flashing MicroPython firmware to multiple boards, but it has been extend with a TUI to me be used for manual downloadig, flashing and development.
+This tool was initially created to be used in a CI/CD pipeline to automate the process of downloading and flashing MicroPython firmware to multiple boards, but it has been extend with a TUI to be used for manual downloadig, flashing and development.
 
-`mpflash` has been tested on Windows x64, Linux X64, but not (yet) macOS.
-Tested ports: `rp2`, `samd`, `esp32`, `esp32s3`, `esp32c3`, `esp8266` and `stm32`
+`mpflash` has been tested on:  
+ - OS: Windows x64, Linux X64, but not (yet) macOS.
+ - Micropython (hardware) ports: 
+    - `rp2`, using `.uf2`, using filecopy (macos not tested yet)
+    - `samd`, using ` .uf2`, using filecopy (macos not tested yet)
+    - `esp32`, using `.bin`, using esptool,
+    - `esp8266`, using `.bin`, using esptool
+    - `stm32`, using ` .dfu`, using pydfu
 
+Not yet implemented: `nrf`, `cc3200`, `mimxrt`
+ 
 ## Features
  1. List the connected boards including their firmware details, in a tabular or json format
  2. Download MicroPython firmware for versions, and matching a specified board or matches your current attached board.
@@ -34,8 +46,7 @@ On Windows this will not be an issue, but on Linux you can use  udev rules to gi
 ## Detailed usage
 You can list the connected boards using the following command:
 ```bash
-$ mpflash list
-D:\MyPython\micropython-stubber> mpflash list
+$> mpflash list
                                                Connected boards
 ┏━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━┓
 ┃ Serial  ┃Family       ┃Port  ┃Board                                      ┃CPU     ┃Version          ┃build ┃

micropython_stubber-1.20.2/src/mpflash/mpflash/add_firmware.py

@@ -0,0 +1,98 @@
+import shutil
+from pathlib import Path
+from typing import Union
+
+import jsonlines
+import requests
+from loguru import logger as log
+
+# re-use logic from mpremote
+from mpremote.mip import _rewrite_url as rewrite_url  # type: ignore
+
+from mpflash.common import FWInfo
+from mpflash.config import config
+from mpflash.vendor.versions import get_preview_mp_version, get_stable_mp_version
+
+
+def add_firmware(
+    source: Union[Path, str],
+    new_fw: FWInfo,
+    *,
+    force: bool = False,
+    custom: bool = False,
+    description: str = "",
+) -> bool:
+    """Add a firmware to the firmware folder.
+
+    stored in the port folder, with the same filename as the source.
+
+    """
+    # Check minimal info needed
+    if not new_fw.port or not new_fw.board:
+        log.error("Port and board are required")
+        return False
+    if not isinstance(source, Path) and not source.startswith("http"):
+        log.error(f"Invalid source {source}")
+        return False
+
+    # use sensible defaults
+    source_2 = Path(source)
+    new_fw.ext = new_fw.ext or source_2.suffix
+    new_fw.variant = new_fw.variant or new_fw.board
+    new_fw.custom = new_fw.custom or custom
+    new_fw.description = new_fw.description or description
+    if not new_fw.version:
+        # TODO: Get version from filename
+        # or use the last preview version
+        new_fw.version = get_preview_mp_version() if new_fw.preview else get_stable_mp_version()
+
+    config.firmware_folder.mkdir(exist_ok=True)
+
+    fw_filename = config.firmware_folder / new_fw.port / source_2.name
+
+    new_fw.filename = str(fw_filename.relative_to(config.firmware_folder))
+    new_fw.firmware = source.as_uri() if isinstance(source, Path) else source
+
+    if not copy_firmware(source, fw_filename, force):
+        log.error(f"Failed to copy {source} to {fw_filename}")
+        return False
+    # add to inventory
+    with jsonlines.open(config.firmware_folder / "firmware.jsonl", "a") as writer:
+        log.info(f"Adding {new_fw.port} {new_fw.board}")
+        log.info(f"    to {fw_filename}")
+
+        writer.write(new_fw.to_dict())
+    return True
+
+
+def copy_firmware(source: Union[Path, str], fw_filename: Path, force: bool = False):
+    """Add a firmware to the firmware folder.
+    stored in the port folder, with the same filename as the source.
+    """
+    if fw_filename.exists() and not force:
+        log.error(f" {fw_filename} already exists. Use --force to overwrite")
+        return False
+    fw_filename.parent.mkdir(exist_ok=True)
+    if isinstance(source, Path):
+        if not source.exists():
+            log.error(f"File {source} does not exist")
+            return False
+        # file copy
+        log.debug(f"Copy {source} to {fw_filename}")
+        shutil.copy(source, fw_filename)
+        return True
+    # handle github urls
+    url = rewrite_url(source)
+    if str(source).startswith("http://") or str(source).startswith("https://"):
+        log.debug(f"Download {url} to {fw_filename}")
+        response = requests.get(url)
+
+        if response.status_code == 200:
+            with open(fw_filename, "wb") as file:
+                file.write(response.content)
+                log.info("File downloaded and saved successfully.")
+                return True
+        else:
+            print("Failed to download the file.")
+            return False
+    return False

micropython_stubber-1.20.2/src/mpflash/mpflash/ask_input.py

@@ -0,0 +1,226 @@
+"""
+Interactive input for mpflash.
+
+Note: The prompts can use "{version}" and "{action}" to insert the version and action in the prompt without needing an f-string.
+The values are provided from the answers dictionary.
+"""
+
+from typing import List, Sequence, Tuple, Union
+
+from loguru import logger as log
+
+from .common import DownloadParams, FlashParams, ParamType
+from .config import config
+from .mpboard_id import get_known_boards_for_port, get_known_ports, known_stored_boards
+from .mpremoteboard import MPRemoteBoard
+from .vendor.versions import micropython_versions
+
+
+def ask_missing_params(
+    params: ParamType,
+) -> ParamType:
+    """
+    Asks the user for parameters that have not been supplied on the commandline and returns the updated params.
+
+    Args:
+        params (ParamType): The parameters to be updated.
+
+    Returns:
+        ParamType: The updated parameters.
+    """
+    import inquirer
+
+    log.trace(f"ask_missing_params: {params}")
+
+    # if action flash,  single input
+    # if action download, multiple input
+    multi_select = isinstance(params, DownloadParams)
+    action = "download" if isinstance(params, DownloadParams) else "flash"
+    if not config.interactive:
+        # no interactivity allowed
+        return params
+
+    questions = []
+    answers: dict[str, Union[str, List]] = {"action": action}
+    if not multi_select:
+        if not params.serial or "?" in params.serial:
+            questions.append(ask_serialport(multi_select=False, bluetooth=False))
+        else:
+            answers["serial"] = params.serial
+
+    if params.versions == [] or "?" in params.versions:
+        questions.append(ask_mp_version(multi_select=multi_select, action=action))
+    else:
+        # versions is used to show only the boards for the selected versions
+        answers["versions"] = params.versions  # type: ignore
+
+    if not params.boards or "?" in params.boards:
+        questions.extend(ask_port_board(multi_select=multi_select, action=action))
+    if questions:
+        answers = inquirer.prompt(questions, answers=answers)  # type: ignore
+    if not answers:
+        # input cancelled by user
+        return []  # type: ignore
+    log.trace(f"answers: {answers}")
+    if isinstance(params, FlashParams) and "serial" in answers:
+        if isinstance(answers["serial"], str):
+            answers["serial"] = [answers["serial"]]
+        params.serial = [s.split()[0] for s in answers["serial"]]  # split to remove the description
+    if "port" in answers:
+        params.ports = [p for p in params.ports if p != "?"]  # remove the "?" if present
+        params.ports.extend(answers["port"])
+    if "boards" in answers:
+        params.boards = [b for b in params.boards if b != "?"]  # remove the "?" if present
+        params.boards.extend(answers["boards"] if isinstance(answers["boards"], list) else [answers["boards"]])
+    if "versions" in answers:
+        params.versions = [v for v in params.versions if v != "?"]  # remove the "?" if present
+        # make sure it is a list
+        if isinstance(answers["versions"], (list, tuple)):
+            params.versions.extend(answers["versions"])
+        else:
+            params.versions.append(answers["versions"])
+    # remove duplicates
+    params.ports = list(set(params.ports))
+    params.boards = list(set(params.boards))
+    params.versions = list(set(params.versions))
+    log.trace(f"ask_missing_params returns: {params}")
+
+    return params
+
+
+def filter_matching_boards(answers: dict) -> Sequence[Tuple[str, str]]:
+    """
+    Filters the known boards based on the selected versions and returns the filtered boards.
+
+    Args:
+        answers (dict): The user's answers.
+
+    Returns:
+        Sequence[Tuple[str, str]]: The filtered boards.
+    """
+    versions = None
+    # if version is not asked ; then need to get the version from the inputs
+    if "versions" in answers:
+        versions = list(answers["versions"])
+        if "stable" in versions:
+            versions.remove("stable")
+            versions.append(micropython_versions()[-2])  # latest stable
+        elif "preview" in versions:
+            versions.remove("preview")
+            versions.extend((micropython_versions()[-1], micropython_versions()[-2]))  # latest preview and stable
+
+    some_boards = known_stored_boards(answers["port"], versions)  #    or known_mp_boards(answers["port"])
+
+    if some_boards:
+        # Create a dictionary where the keys are the second elements of the tuples
+        # This will automatically remove duplicates because dictionaries cannot have duplicate keys
+        unique_dict = {item[1]: item for item in some_boards}
+        # Get the values of the dictionary, which are the unique items from the original list
+        some_boards = list(unique_dict.values())
+    else:
+        some_boards = [(f"No {answers['port']} boards found for version(s) {versions}", "")]
+    return some_boards
+
+
+def ask_port_board(*, multi_select: bool, action: str):
+    """
+    Asks the user for the port and board selection.
+
+    Args:
+        questions (list): The list of questions to be asked.
+        action (str): The action to be performed.
+
+    Returns:
+        None
+    """
+    # import only when needed to reduce load time
+    import inquirer
+
+    # if action flash,  single input
+    # if action download, multiple input
+    inquirer_ux = inquirer.Checkbox if multi_select else inquirer.List
+    return [
+        inquirer.List(
+            "port",
+            message="Which port do you want to {action} " + "to {serial} ?" if action == "flash" else "?",
+            choices=get_known_ports(),
+            # autocomplete=True,
+        ),
+        inquirer_ux(
+            "boards",
+            message=(
+                "Which {port} board firmware do you want to {action} " + "to {serial} ?" if action == "flash" else "?"
+            ),
+            choices=filter_matching_boards,
+            validate=lambda _, x: True if x else "Please select at least one board",  # type: ignore
+        ),
+    ]
+
+
+def ask_mp_version(multi_select: bool, action: str):
+    """
+    Asks the user for the version selection.
+
+    Args:
+        questions (list): The list of questions to be asked.
+        action (str): The action to be performed.
+
+    Returns:
+
+    """
+    # import only when needed to reduce load time
+    import inquirer
+    import inquirer.errors
+
+    input_ux = inquirer.Checkbox if multi_select else inquirer.List
+
+    mp_versions: List[str] = micropython_versions()
+    mp_versions.reverse()  # newest first
+
+    # remove the versions for which there are no known boards in the board_info.json
+    # todo: this may be a little slow
+    mp_versions = [v for v in mp_versions if "preview" in v or get_known_boards_for_port("stm32", [v])]
+
+    def at_least_one_validation(answers, current) -> bool:
+        if not current:
+            raise inquirer.errors.ValidationError("", reason="Please select at least one version")
+        if isinstance(current, list) and not any(current):
+            raise inquirer.errors.ValidationError("", reason="Please select at least one version")
+        return True
+
+    message = "Which version(s) do you want to {action} " + ("to {serial} ?" if action == "flash" else "?")
+    q = input_ux(
+        # inquirer.List(
+        "versions",
+        message=message,
+        # Hints would be nice , but needs a hint for each and every option
+        # hints=["Use space to select multiple options"],
+        choices=mp_versions,
+        autocomplete=True,
+        validate=at_least_one_validation,  # type: ignore
+    )
+    return q
+
+
+def ask_serialport(*, multi_select: bool = False, bluetooth: bool = False):
+    """
+    Asks the user for the serial port selection.
+
+    Args:
+        questions (list): The list of questions to be asked.
+        action (str): The action to be performed.
+
+    Returns:
+        None
+    """
+    # import only when needed to reduce load time
+    import inquirer
+
+    comports = MPRemoteBoard.connected_boards(bluetooth=bluetooth, description=True)
+    return inquirer.List(
+        "serial",
+        message="Which serial port do you want to {action} ?",
+        choices=comports,
+        other=True,
+        validate=lambda _, x: True if x else "Please select or enter a serial port",  # type: ignore
+    )

{micropython_stubber-1.20.1 → micropython_stubber-1.20.2}/src/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