mpflash 1.24.6__py3-none-any.whl → 1.24.8__py3-none-any.whl

mpflash/ask_input.py

@@ -11,8 +11,7 @@ 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 .mpboard_id import get_known_boards_for_port, get_known_ports, known_stored_boards
 from .mpremoteboard import MPRemoteBoard
 from .versions import micropython_versions
 
@@ -73,11 +72,11 @@ def ask_missing_params(
         #  params.ports = [p for p in params.ports if p != "?"]  # remove the "?" if present
         if isinstance(answers["port"], str):
             params.ports.append(answers["port"])
-        elif isinstance(answers["port"], list): # type: ignore
+        elif isinstance(answers["port"], list):  # type: ignore
             params.ports.extend(answers["port"])
         else:
             raise ValueError(f"Unexpected type for answers['port']: {type(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"]])
@@ -157,23 +156,24 @@ def ask_port_board(*, multi_select: bool, action: str):
         ),
         inquirer_ux(
             "boards",
-            message=(
-                "Which {port} board firmware do you want to {action} " + "to {serial} ?" if action == "flash" else "?"
-            ),
+            message=("Which {port} board firmware do you want to {action} " + "to {serial} ?" if action == "flash" else "?"),
             choices=filter_matching_boards,
             validate=at_least_one_validation,  # type: ignore
             # validate=lambda _, x: True if x else "Please select at least one board",  # type: ignore
         ),
     ]
 
+
 def at_least_one_validation(answers, current) -> bool:
     import inquirer.errors
+
     if not current:
         raise inquirer.errors.ValidationError("", reason="Please select at least one item.")
     if isinstance(current, list) and not any(current):
         raise inquirer.errors.ValidationError("", reason="Please select at least one item.")
     return True
 
+
 def ask_mp_version(multi_select: bool, action: str):
     """
     Asks the user for the version selection.

mpflash/basicgit.py

@@ -4,28 +4,25 @@ Simple Git module, where needed via powershell
 Some of the functions are based on the PyGithub module
 """
 
-import os
 import subprocess
 from pathlib import Path
 from typing import List, Optional, Union
 
 import cachetools.func
-from github import Auth, BadCredentialsException, Github
 from loguru import logger as log
-from packaging.version import parse
 
-# from mpflash.versions import SET_PREVIEW
+from mpflash.config import config
 
-# 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_"
-    + "11AAHPVFQ0G4NTaQ73Bw5J"
-    + "_fAp7K9sZ1qL8VFnI9g78eUlCdmOXHB3WzSdj2jtEYb4XF3N7PDJBl32qIxq"
-)
-PAT = os.environ.get("GITHUB_TOKEN") or PAT_NO_ACCESS
-GH_CLIENT = Github(auth=Auth.Token(PAT))
+# from github import Auth, BadCredentialsException, Github
 
+# # 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_" + "11AAHPVFQ0G4NTaQ73Bw5J" + "_fAp7K9sZ1qL8VFnI9g78eUlCdmOXHB3WzSdj2jtEYb4XF3N7PDJBl32qIxq"
+# PAT = os.environ.get("GITHUB_TOKEN") or PAT_NO_ACCESS
+
+# # GH_CLIENT = Github(auth=Auth.Token(PAT))
+
+# GH_CLIENT = None
 
 def _run_local_git(
     cmd: List[str],
@@ -47,10 +44,9 @@ def _run_local_git(
                 encoding="utf-8",
             )
         else:
-            result = subprocess.run(
-                cmd, capture_output=capture_output, check=True, encoding="utf-8"
-            )
+            result = subprocess.run(cmd, capture_output=capture_output, check=True, encoding="utf-8")
     except (NotADirectoryError, FileNotFoundError) as e:  # pragma: no cover
+        log.error(f"Not a directory: {e}")
         return None
     except subprocess.CalledProcessError as e:  # pragma: no cover
         # add some logging for github actions
@@ -88,9 +84,7 @@ def clone(remote_repo: str, path: Path, shallow: bool = False, tag: Optional[str
         return False
 
 
-def get_local_tag(
-    repo: Optional[Union[str, Path]] = None, abbreviate: bool = True
-) -> Union[str, None]:
+def get_local_tag(repo: Optional[Union[str, Path]] = None, abbreviate: bool = True) -> Union[str, None]:
     """
     get the most recent git version tag of a local repo
     repo Path should be in the form of : repo = "./repo/micropython"
@@ -123,6 +117,9 @@ def get_local_tags(repo: Optional[Path] = None, minver: Optional[str] = None) ->
     """
     get list of all tags of a local repo
     """
+    # Just in time import
+    from packaging.version import parse
+
     if not repo:
         repo = Path(".")
 
@@ -136,19 +133,22 @@ def get_local_tags(repo: Optional[Path] = None, minver: Optional[str] = None) ->
     return sorted(tags)
 
 
-from github.GithubException import BadCredentialsException
-
-
 @cachetools.func.ttl_cache(maxsize=16, ttl=60)  # 60 seconds
 def get_tags(repo: str, minver: Optional[str] = None) -> List[str]:
     """
     Get list of tag of a repote github repo.
     only the last -preview tag is kept
     """
+    # Just in time import
+    from github import BadCredentialsException
+    from packaging.version import parse
+
     if not repo or not isinstance(repo, str) or "/" not in repo:  # type: ignore
         return []
+
+    gh_client = config.gh_client
     try:
-        gh_repo = GH_CLIENT.get_repo(repo)
+        gh_repo = gh_client.get_repo(repo)
     except BadCredentialsException as e:
         log.error(f"Github authentication error - {e}")
         return []
@@ -179,40 +179,6 @@ def checkout_tag(tag: str, repo: Optional[Union[str, Path]] = None) -> bool:
     return True
 
 
-def sync_submodules(repo: Union[Path, str]) -> bool:
-    """
-    make sure any submodules are in sync
-    """
-    cmds = [
-        ["git", "submodule", "sync", "--quiet"],
-        # ["git", "submodule", "update", "--quiet"],
-        ["git", "submodule", "update", "--init", "lib/micropython-lib"],
-    ]
-    for cmd in cmds:
-        if result := _run_local_git(cmd, repo=repo, expect_stderr=True):
-            # actually a good result
-            log.debug(result.stderr)
-        else:
-            return False
-    checkout_arduino_lib(Path(repo))
-    return True
-
-
-def checkout_arduino_lib(mpy_path: Path):
-    """
-    Checkout the arduino-lib submodule repo if it exists
-
-    This is needed as some of the arduino boards freeze modules originationg from the arduino-lib
-    """
-    # arduino_lib_path = mpy_path / "lib/arduino-lib"
-    if (mpy_path / "lib/arduino-lib").exists():
-        cmd = ["git", "submodule", "update", "--init", "lib/arduino-lib"]
-        try:
-            result = subprocess.run(cmd, cwd=mpy_path, check=True)
-            log.info(f"checkout arduino-lib: {result.returncode}")
-        except subprocess.CalledProcessError as e:
-            log.warning("Could not check out arduino-lib, error: ", e)
-
 
 def checkout_commit(commit_hash: str, repo: Optional[Union[Path, str]] = None) -> bool:
     """

mpflash/bootloader/__init__.py

@@ -1,2 +0,0 @@
-from .activate import enter_bootloader  # type: ignore
-from .detect import in_bootloader  # type: ignore

mpflash/bootloader/activate.py

@@ -12,7 +12,7 @@ from .touch1200 import enter_bootloader_touch_1200bps
 
 BL_OPTIONS = {
     "stm32": [BootloaderMethod.TOUCH_1200, BootloaderMethod.MPY, BootloaderMethod.MANUAL],
-    "rp2": [BootloaderMethod.TOUCH_1200, BootloaderMethod.MPY, BootloaderMethod.MANUAL],
+    "rp2": [BootloaderMethod.MPY, BootloaderMethod.TOUCH_1200, BootloaderMethod.MANUAL],
     "samd": [BootloaderMethod.TOUCH_1200, BootloaderMethod.MPY, BootloaderMethod.MANUAL],
     "esp32": [BootloaderMethod.NONE],
     "esp8266": [BootloaderMethod.NONE],

mpflash/bootloader/detect.py

@@ -1,5 +1,4 @@
-""" Detect if a board is in bootloader mode 
-"""
+"""Detect if a board is in bootloader mode"""
 
 import os
 

mpflash/bootloader/manual.py

@@ -52,7 +52,6 @@ mcu_theme = Theme(
 
 
 def enter_bootloader_manual(mcu: MPRemoteBoard, timeout: int = 10):
-
     message: str
     if mcu.port == "rp2":
         message = f"""\

mpflash/bootloader/touch1200.py

@@ -27,10 +27,10 @@ def enter_bootloader_touch_1200bps(mcu: MPRemoteBoard, timeout: int = 10):
 
     except serial.SerialException as e:
         log.exception(e)
-        raise MPFlashError("pySerial error: " + str(e) + "\n") from e
+        raise MPFlashError(f"pySerial error: {str(e)}") from e
     except Exception as e:
         log.exception(e)
-        raise MPFlashError("Error: " + str(e) + "\n") from e
+        raise MPFlashError(f"Error: {str(e)}") from e
 
     # be optimistic
     return True

mpflash/cli_flash.py

@@ -92,6 +92,14 @@ from mpflash.versions import clean_version
     help="The MicroPython board ID to flash. If not specified will try to read the BOARD_ID from the connected MCU.",
     metavar="BOARD_ID or ?",
 )
+@click.option(
+    "--variant",
+    "-var",
+    "variant",  # single board
+    multiple=False,
+    help="The board VARIANT to flash or '-'. If not specified will try to read the variant from the connected MCU.",
+    metavar="VARIANT",
+)
 @click.option(
     "--cpu",
     "--chip",
@@ -102,9 +110,9 @@ from mpflash.versions import clean_version
 )
 @click.option(
     "--erase/--no-erase",
-    default=True,
+    default=False,
     show_default=True,
-    help="""Erase flash before writing new firmware. (Not supported on UF2 boards)""",
+    help="""Erase flash before writing new firmware.""",
 )
 @click.option(
     "--bootloader",
@@ -115,14 +123,21 @@ from mpflash.versions import clean_version
     show_default=True,
     help="""How to enter the (MicroPython) bootloader before flashing.""",
 )
+@click.option(
+    "--flash_mode", "-fm",
+    type=click.Choice(["keep", "qio", "qout", "dio", "dout"]),
+    default="keep",
+    show_default=True,
+    help="""Flash mode for ESP boards. (default: keep)""",
+)
 def cli_flash_board(**kwargs) -> int:
     # version to versions, board to boards
-    kwargs["versions"] = [kwargs.pop("version")] if kwargs["version"] != None else []
+    kwargs["versions"] = [kwargs.pop("version")] if kwargs["version"] is not None else []
     if kwargs["board"] is None:
         kwargs["boards"] = []
         kwargs.pop("board")
     else:
-        kwargs["boards"] = [kwargs.pop("board")]
+        kwargs["boards"] = [kwargs.pop("board")]   
 
     params = FlashParams(**kwargs)
     params.versions = list(params.versions)
@@ -141,7 +156,9 @@ def cli_flash_board(**kwargs) -> int:
     all_boards: List[MPRemoteBoard] = []
     if not params.boards:
         # nothing specified - detect connected boards
-        params.ports, params.boards, all_boards = connected_ports_boards(include=params.ports, ignore=params.ignore, bluetooth=params.bluetooth)
+        params.ports, params.boards, all_boards = connected_ports_boards(
+            include=params.ports, ignore=params.ignore, bluetooth=params.bluetooth
+        )
         if params.boards == []:
             # No MicroPython boards detected, but it could be unflashed or in bootloader mode
             # Ask for serial port and board_id to flash
@@ -171,6 +188,11 @@ def cli_flash_board(**kwargs) -> int:
         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)
+        # if variant id provided on the cmdline, treat is as an override
+        if params.variant:
+            for b in all_boards:
+                b.variant = params.variant if (params.variant != "-") else ""
+
         worklist = full_auto_worklist(
             all_boards=all_boards,
             version=params.versions[0],
@@ -199,6 +221,7 @@ def cli_flash_board(**kwargs) -> int:
         params.fw_folder,
         params.erase,
         params.bootloader,
+        flash_mode = params.flash_mode,
     ):
         log.info(f"Flashed {len(flashed)} boards")
         show_mcus(flashed, title="Updated boards after flashing")

mpflash/cli_group.py

@@ -39,6 +39,7 @@ def cb_test(ctx, param, value):
         config.tests = value
     return value
 
+
 def cb_usb(ctx, param, value: bool):
     config.usb = bool(value)
     return value

mpflash/cli_list.py

@@ -73,8 +73,8 @@ def cli_list_mcus(serial: List[str], ignore: List[str], bluetooth: bool, as_json
     # 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))]    
+    # ignore boards that have the [mpflash] 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:

mpflash/cli_main.py

@@ -30,7 +30,7 @@ def mpflash():
         except click_exceptions.ClickException as e:
             log.error(f"Error: {e}")
             exit(-2)
-        except click_exceptions.Abort as e:
+        except click_exceptions.Abort:
             # Aborted - Ctrl-C
             exit(-3)
 

mpflash/common.py

@@ -10,12 +10,10 @@ from typing import List, Optional, Union
 from serial.tools import list_ports
 from serial.tools.list_ports_common import ListPortInfo
 
-from mpflash.basicgit import GH_CLIENT as GH_CLIENT
 
+# from mpflash.flash.esp import FlashMode
 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"],
@@ -28,6 +26,7 @@ PORT_FWTYPES = {
     "renesas-ra": [".hex"],
 }
 
+UF2_PORTS = [port for port, exts in PORT_FWTYPES.items() if ".uf2" in exts]
 
 @dataclass
 class FWInfo:
@@ -71,6 +70,7 @@ class Params:
 
     ports: List[str] = field(default_factory=list)
     boards: List[str] = field(default_factory=list)
+    variant: str = ""
     versions: List[str] = field(default_factory=list)
     fw_folder: Path = Path()
     serial: List[str] = field(default_factory=list)
@@ -101,6 +101,7 @@ class FlashParams(Params):
     erase: bool = True
     bootloader: BootloaderMethod = BootloaderMethod.NONE
     cpu: str = ""
+    flash_mode: str = "keep"  # keep, qio, qout, dio, dout
 
     def __post_init__(self):
         if isinstance(self.bootloader, str):
@@ -137,14 +138,7 @@ def filtered_comports(
     # 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 False:
-        import jsons
-
-        print(jsons.dumps(comports).replace('{"description":', '\n{"description":'))
+    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
@@ -156,9 +150,7 @@ def filtered_comports(
 
     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)
-        ]
+        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

mpflash/config.py

@@ -3,34 +3,34 @@
 import os
 from importlib.metadata import version
 from pathlib import Path
-from typing import List
+from typing import List, Optional
 
 import platformdirs
 
-from mpflash.logger import log
-
 
 def get_version():
     name = __package__ or "mpflash"
     return version(name)
 
 
-class MPtoolConfig:
+class MPFlashConfig:
     """Centralized configuration for mpflash"""
 
     quiet: bool = False
     verbose: bool = False
     usb: bool = False
     ignore_ports: List[str] = []
-    firmware_folder: Path = platformdirs.user_downloads_path() / "firmware"
+    _firmware_folder: Optional[Path] = None
     # test options specified on the commandline
     tests: List[str] = []
     _interactive: bool = True
+    _gh_client = None
 
     @property
     def interactive(self):
         # No interactions in CI
         if os.getenv("GITHUB_ACTIONS") == "true":
+            from mpflash.logger import log
             log.warning("Disabling interactive mode in CI")
             return False
         return self._interactive
@@ -39,6 +39,25 @@ class MPtoolConfig:
     def interactive(self, value: bool):
         self._interactive = value
 
-
-config = MPtoolConfig()
+    @property
+    def firmware_folder(self) -> Path:
+        """The folder where firmware files are stored"""
+        if not self._firmware_folder:
+            self._firmware_folder = platformdirs.user_downloads_path() / "firmware"
+        return self._firmware_folder
+    
+    @property
+    def gh_client(self):
+        """The gh client to use"""
+        if not self._gh_client:
+            from github import Auth, Github
+            # 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_" + "11AAHPVFQ0G4NTaQ73Bw5J" + "_fAp7K9sZ1qL8VFnI9g78eUlCdmOXHB3WzSdj2jtEYb4XF3N7PDJBl32qIxq"
+            PAT = os.environ.get("GITHUB_TOKEN") or PAT_NO_ACCESS
+            self._gh_client = Github(auth=Auth.Token(PAT))
+        return self._gh_client
+
+
+config = MPFlashConfig()
 __version__ = get_version()

mpflash/connected.py

@@ -4,11 +4,9 @@ from rich import print
 from rich.progress import BarColumn, Progress, SpinnerColumn, TextColumn, TimeElapsedColumn
 from rich.table import Column
 
-from mpflash.common import filtered_comports
+from mpflash.common import filtered_comports, find_serial_by_path
 from mpflash.mpremoteboard import MPRemoteBoard
 
-from mpflash.common import find_serial_by_path
-
 
 def connected_ports_boards(
     *, include: List[str], ignore: List[str], bluetooth: bool = False
@@ -23,13 +21,9 @@ def connected_ports_boards(
             - A list of unique board names of the connected MCUs.
             - A list of MPRemoteBoard instances of the connected MCUs.
     """
-    conn_mcus = [
-        b for b in list_mcus(include=include, ignore=ignore, bluetooth=bluetooth) if b.connected
-    ]
-    # 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))
-    ]
+    conn_mcus = [b for b in list_mcus(include=include, ignore=ignore, bluetooth=bluetooth) if b.connected]
+    # ignore boards that have the [mpflash] ignore flag set
+    conn_mcus = [item for item in conn_mcus if not (item.toml.get("mpflash", {}).get("ignore", False))]
 
     ports = list({b.port for b in conn_mcus})
     boards = list({b.board for b in conn_mcus})
@@ -42,9 +36,7 @@ rp_text = TextColumn("{task.description} {task.fields[device]}", table_column=Co
 rp_bar = BarColumn(bar_width=None, table_column=Column())
 
 
-def list_mcus(
-    *, ignore: List[str], include: List[str], bluetooth: bool = False
-) -> List[MPRemoteBoard]:
+def list_mcus(*, ignore: List[str], include: List[str], bluetooth: bool = False) -> List[MPRemoteBoard]:
     """
     Retrieves information about connected microcontroller boards.
 
@@ -63,7 +55,7 @@ def list_mcus(
     connected_mcus = [
         MPRemoteBoard(
             c.device,
-            location=find_serial_by_path(c.device) or c.location or c.hwid or  "?",
+            location=find_serial_by_path(c.device) or c.location or c.hwid or "?",
         )
         for c in comports
     ]