mpflash 1.24.1__py3-none-any.whl → 1.24.3__py3-none-any.whl

mpflash/basicgit.py

@@ -10,7 +10,7 @@ from pathlib import Path
 from typing import List, Optional, Union
 
 import cachetools.func
-from github import Auth, Github
+from github import Auth, BadCredentialsException, Github
 from loguru import logger as log
 from packaging.version import parse
 
@@ -18,7 +18,11 @@ from packaging.version import parse
 
 # 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_NO_ACCESS = (
+    "github_pat_"
+    + "11AAHPVFQ0G4NTaQ73Bw5J"
+    + "_fAp7K9sZ1qL8VFnI9g78eUlCdmOXHB3WzSdj2jtEYb4XF3N7PDJBl32qIxq"
+)
 PAT = os.environ.get("GITHUB_TOKEN") or PAT_NO_ACCESS
 GH_CLIENT = Github(auth=Auth.Token(PAT))
 
@@ -35,9 +39,17 @@ def _run_local_git(
         if repo:
             if isinstance(repo, str):
                 repo = Path(repo)
-            result = subprocess.run(cmd, capture_output=capture_output, check=True, cwd=repo.absolute().as_posix(), encoding="utf-8")
+            result = subprocess.run(
+                cmd,
+                capture_output=capture_output,
+                check=True,
+                cwd=repo.absolute().as_posix(),
+                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
         return None
     except subprocess.CalledProcessError as e:  # pragma: no cover
@@ -76,7 +88,9 @@ 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"
@@ -125,12 +139,16 @@ def get_local_tags(repo: Optional[Path] = None, minver: Optional[str] = None) ->
 @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
+    Get list of tag of a repote github repo.
+    only the last -preview tag is kept
     """
     if not repo or not isinstance(repo, str) or "/" not in repo:  # type: ignore
         return []
     try:
         gh_repo = GH_CLIENT.get_repo(repo)
+    except BadCredentialsException as e:
+        log.error(f"Github authentication error - {e}")
+        return []
     except ConnectionError as e:
         # TODO: unable to capture the exeption
         log.warning(f"Unable to get tags - {e}")
@@ -138,7 +156,9 @@ def get_tags(repo: str, minver: Optional[str] = None) -> List[str]:
     tags = [tag.name for tag in gh_repo.get_tags()]
     if minver:
         tags = [tag for tag in tags if parse(tag) >= parse(minver)]
-    return sorted(tags)
+    # remove all but the last preview
+    tags = [t for t in sorted(tags[:-1]) if "-preview" not in t] + sorted(tags)[-1:]
+    return tags
 
 
 def checkout_tag(tag: str, repo: Optional[Union[str, Path]] = None) -> bool:
@@ -222,7 +242,7 @@ def switch_branch(branch: str, repo: Optional[Union[Path, str]] = None) -> bool:
 
 def fetch(repo: Union[Path, str]) -> bool:
     """
-    fetches a repo
+    fetches a repo and all tags
     repo should be in the form of : path/.git
     repo = '../micropython/.git'
     returns True on success

mpflash/common.py

@@ -30,11 +30,8 @@ PORT_FWTYPES = {
 
 # 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"
-    + "_11AAHPVFQ0K6OKbI9xPFWG"
-    + "_3KossOkuuxRJ6MZrP5o2vMsAW2i3QFZx2BECNjL4o30S2XQBWF77JgQbJda"
-)
+PAT_NO_ACCESS = "github_pat_"+"11AAHPVFQ0G4NTaQ73Bw5J"+"_fAp7K9sZ1qL8VFnI9g78eUlCdmOXHB3WzSdj2jtEYb4XF3N7PDJBl32qIxq"
+
 PAT = os.environ.get("GITHUB_TOKEN") or PAT_NO_ACCESS
 GH_CLIENT = Github(auth=Auth.Token(PAT))
 

mpflash/mpboard_id/__init__.py

@@ -24,7 +24,9 @@ def get_known_ports() -> List[str]:
     return sorted(list(ports))
 
 
-def get_known_boards_for_port(port: Optional[str] = "", versions: Optional[List[str]] = None) -> List[Board]:
+def get_known_boards_for_port(
+    port: Optional[str] = "", versions: Optional[List[str]] = None
+) -> List[Board]:
     """
     Returns a list of boards for the given port and version(s)
 
@@ -77,13 +79,16 @@ def known_stored_boards(port: str, versions: Optional[List[str]] = None) -> List
 @lru_cache(maxsize=20)
 def find_known_board(board_id: str) -> Board:
     """Find the board for the given BOARD_ID or 'board description' and return the board info as a Board object"""
-    # FIXME : functional overlap with:
+    # Some functional overlap with:
     # mpboard_id\board_id.py _find_board_id_by_description
     info = read_known_boardinfo()
     for board_info in info:
-        if board_id in (board_info.board_id, board_info.description):
+        if board_id in (
+            board_info.board_id,
+            board_info.description,
+        ) or board_info.description.startswith(board_id):
             if not board_info.cpu:
-                # safeguard for older board_info.json files
+                # failsafe for older board_info.json files
                 print(f"Board {board_id} has no CPU info, using port as CPU")
                 if " with " in board_info.description:
                     board_info.cpu = board_info.description.split(" with ")[-1]

mpflash/mpboard_id/add_boards.py

@@ -25,7 +25,9 @@ RE_H_MICROPY_HW_BOARD_NAME = re.compile(r"#define\s+MICROPY_HW_BOARD_NAME\s+\"(.
 RE_H_MICROPY_HW_MCU_NAME = re.compile(r"#define\s+MICROPY_HW_MCU_NAME\s+\"(.+)\"")
 # find in the mpconfigboard.cmake files
 
-RE_CMAKE_MICROPY_HW_BOARD_NAME = re.compile(r"MICROPY_HW_BOARD_NAME\s?=\s?\"(?P<variant>[\w\s\S]*)\"")
+RE_CMAKE_MICROPY_HW_BOARD_NAME = re.compile(
+    r"MICROPY_HW_BOARD_NAME\s?=\s?\"(?P<variant>[\w\s\S]*)\""
+)
 RE_CMAKE_MICROPY_HW_MCU_NAME = re.compile(r"MICROPY_HW_MCU_NAME\s?=\s?\"(?P<variant>[\w\s\S]*)\"")
 # TODO: normal make files
 
@@ -118,7 +120,9 @@ def boards_from_headers(mpy_path: Path, version: str, family: str):
                     mcu_name = match[1]
                     found += 1
                 if found == 2:
-                    description = f"{board_name} with {mcu_name}" if mcu_name != "-" else board_name
+                    description = (
+                        f"{board_name} with {mcu_name}" if mcu_name != "-" else board_name
+                    )
                     board_list.append(
                         Board(
                             board_id=board,
@@ -160,6 +164,8 @@ def boards_for_versions(versions: List[str], mpy_path: Path):
         List[Board]: The list of Board objects.
     """
     board_list: List[Board] = []
+    # first fetch all tags from the repository
+    git.fetch(mpy_path)
     for version in track(versions, description="Searching MicroPython versions"):
         if git.checkout_tag(tag=version, repo=mpy_path):
             new_ones = boards_from_repo(mpy_path, version, family="micropython")
@@ -197,9 +203,10 @@ def make_table(board_list: List[Board]) -> rich.table.Table:
     is_wide = True
 
     table = rich.table.Table(title="MicroPython Board Information")
+    table.add_column("Port", justify="left", style="magenta")
     table.add_column("BOARD_ID", justify="left", style="green")
+    table.add_column("Variant(s)", justify="left", style="blue")
     table.add_column("Description", justify="left", style="cyan")
-    table.add_column("Port", justify="left", style="magenta")
     table.add_column("Board Name", justify="left", style="blue")
     if is_wide:
         table.add_column("MCU Name", justify="left", style="blue")
@@ -209,7 +216,7 @@ def make_table(board_list: List[Board]) -> rich.table.Table:
         table.add_column("Family", justify="left", style="blue")
 
     for board in board_list:
-        row = [board.board_id, board.description, *(board.port, board.board_name)]
+        row = [board.port, board.board_id, board.variant, board.description, board.board_name]
         if is_wide:
             row.append(board.mcu_name)
         row.extend((str(Path(board.path).suffix), board.version))
@@ -222,7 +229,13 @@ def make_table(board_list: List[Board]) -> rich.table.Table:
 
 def ask_mpy_path():
     """Ask the user for the path to the MicroPython repository."""
-    questions = [inquirer.Text("mpy_path", message="Enter the path to the MicroPython repository", default=".\\repos\\micropython")]
+    questions = [
+        inquirer.Text(
+            "mpy_path",
+            message="Enter the path to the MicroPython repository",
+            default=".\\repos\\micropython",
+        )
+    ]
     if answers := inquirer.prompt(questions):
         return Path(answers["mpy_path"])
     else:

mpflash/mpboard_id/board.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 from pathlib import Path
-from typing import  Union
+from typing import Union
 
 
 # - source : get_boardnames.py
@@ -20,7 +20,7 @@ class Board:
     family: str = field(default="micropython")
     mcu_name: str = field(default="")
     cpu: str = field(default="")
-    # TODO: add variant
+    variant: str = field(default="")
 
     def __post_init__(self):
         if not self.cpu:

mpflash/mpboard_id/board_id.py

@@ -56,14 +56,12 @@ def _find_board_id_by_description(
         Path to the board_info.json file (optional)
 
     """
-    # FIXME: functional overlap with
+    # Some functional overlap with
     # src\mpflash\mpflash\mpboard_id\__init__.py find_known_board
 
+    candidate_boards = read_known_boardinfo(board_info)
     if not short_descr and " with " in descr:
         short_descr = descr.split(" with ")[0]
-
-    candidate_boards = read_known_boardinfo(board_info)
-
     if version:
         # filter for matching version
         if version in ("preview", "stable"):
@@ -71,16 +69,22 @@ def _find_board_id_by_description(
             version = get_stable_mp_version()
         known_versions = sorted({b.version for b in candidate_boards})
         if version not in known_versions:
-            # FIXME if latest stable is newer than the last version in the boardlist this will fail
             log.trace(f"Version {version} not found in board info, using latest known version {known_versions[-1]}")
-            version = known_versions[-1]
+            version = '.'.join(known_versions[-1].split('.')[:2]) # take only major.minor
         if version_matches := [b for b in candidate_boards if b.version.startswith(version)]:
             candidate_boards = version_matches
         else:
             raise MPFlashError(f"No board info found for version {version}")
+    # First try full match on description, then partial match
     matches = [b for b in candidate_boards if b.description == descr]
     if not matches and short_descr:
         matches = [b for b in candidate_boards if b.description == short_descr]
+    if not matches:
+        # partial match (for added VARIANT)
+        matches = [b for b in candidate_boards if b.description.startswith(descr)]
+        if not matches and short_descr:
+            matches = [b for b in candidate_boards if b.description.startswith(short_descr)]
     if not matches:
         raise MPFlashError(f"No board info found for description '{descr}' or '{short_descr}'")
     return sorted(matches, key=lambda x: x.version)
+

mpflash/versions.py

@@ -105,7 +105,9 @@ def micropython_versions(minver: str = "v1.20", reverse: bool = False, cache_it=
         cache_it = False
     versions = [v for v in versions if parse(v) >= parse(minver)]
     # remove all but the most recent (preview) version
-    versions = versions[:1] + [v for v in versions if "preview" not in v]
+    versions = [v for v in versions if "preview" in v][:1] + [
+        v for v in versions if "preview" not in v
+    ]
     versions = sorted(versions, reverse=reverse)
     if cache_it:
         return versions

{mpflash-1.24.1.dist-info → mpflash-1.24.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mpflash
-Version: 1.24.1
+Version: 1.24.3
 Summary: Flash and download tool for MicroPython firmwares
 Home-page: https://github.com/Josverl/micropython-stubber/blob/main/src/mpflash/README.md
 License: MIT
@@ -51,7 +51,7 @@ Description-Content-Type: text/markdown
 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:  
- - OS: Windows x64, Linux X64, but not (yet) macOS.
+ - OS: Windows x64, Linux X64, and macOS.
  - Micropython (hardware) ports: 
     - `rp2`, using `.uf2`, using filecopy 
     - `samd`, using ` .uf2`, using filecopy 
@@ -59,7 +59,7 @@ This tool was initially created to be used in a CI/CD pipeline to automate the p
     - `esp8266`, using `.bin`, using esptool
     - `stm32`, using ` .dfu`, using pydfu
 
-Not yet implemented: `nrf`, `cc3200`, `mimxrt`
+Not yet implemented: `nrf`, `cc3200`, `mimxrt`, `renesas`
  
 ## Features
  1. List the connected boards including their firmware details, in a tabular or json format

{mpflash-1.24.1.dist-info → mpflash-1.24.3.dist-info}/RECORD

@@ -1,7 +1,7 @@
 mpflash/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mpflash/add_firmware.py,sha256=1h0HsA-EVi3HXLmoEvzwY_a-GuWYzPwulTYHHBB8THg,3428
 mpflash/ask_input.py,sha256=RJHGGrhYniSu-bdoKnKptE3DtpiCREJGRTZmFazvG-E,8946
-mpflash/basicgit.py,sha256=li6g0AsOEp2hTfGy25y-ZKvC9QFTDlv1cr6dmY_pTyY,9497
+mpflash/basicgit.py,sha256=ClFBBfx6jXvRfU1e0p7HI-MEUzGwBrqE0lcO5JjeWQ0,9972
 mpflash/bootloader/__init__.py,sha256=Qy3E6tETPnzMga9LgD5UgOvJ0zZIBEqhtEVb4v8CTWQ,107
 mpflash/bootloader/activate.py,sha256=FlO4XQlKyoOuvmDdj_0u_mjNPhjGwB_K17jQ-8nSXRA,2361
 mpflash/bootloader/detect.py,sha256=fBrILi7-ICRaregqms3PYqwiQVAJC0rXVhpyzDkoPQI,2690
@@ -13,7 +13,7 @@ mpflash/cli_flash.py,sha256=pVqEsDocDT3KmIMTpXdym-ZlzThLSIp6oVtYib65dys,7595
 mpflash/cli_group.py,sha256=VWwYHiPVV19sQEr5lL8LlcPyZ-A6Gs79eMDJy8LLt90,2615
 mpflash/cli_list.py,sha256=ja21AZ4yghGTtOHkEtV1EOmT6EYxOiU2gzJc-mZaDto,2427
 mpflash/cli_main.py,sha256=5EkvzsqOUDXvNaW814oSUcPWeNhnwh78Sg0MteDv_fk,1133
-mpflash/common.py,sha256=hgt-B0kIIrTMuOyXMQODN3KyodXB_Gpr-C-ytH7iXvo,7398
+mpflash/common.py,sha256=dyVpCUzBnL1GLbTDHND-C9w6oMmj3fl2oW_cO3zXn3Q,7376
 mpflash/config.py,sha256=tdpvAvAlpco1GfeG2evn5tAKYluLEanqwrrvkir7QcQ,1073
 mpflash/connected.py,sha256=woYhuXoWpfzRMDUpBLVQZbVTGtMsKWNd5z1rsR1ELXA,3578
 mpflash/download.py,sha256=wE4uBSFFMAKOBH4jwHweL0wVYh4vi74t1673ku_IeoA,14305
@@ -32,11 +32,11 @@ mpflash/flash/uf2/windows.py,sha256=v89eXA3QwZxilCazi3Z--yY8UNtZ94trNEJ6U7XUuXA,
 mpflash/flash/worklist.py,sha256=owS3xJbWC-SzbK9z6jQER0Kat3OIV09IxnV-f-tjGlY,5998
 mpflash/list.py,sha256=lP_S5xbC0Men9HsXcIxOsP0bFRlCYh5CynMLFJx8cEE,3607
 mpflash/logger.py,sha256=dI_H_a7EOdQJyvoeRHQuYeZuTKYVUS3DUPTLhE9rkdM,1098
-mpflash/mpboard_id/__init__.py,sha256=5xSmiAHafjT00MG30S7Uv5hufOFKJy0ZvrXuUfaCmsU,3809
-mpflash/mpboard_id/add_boards.py,sha256=47TtN98FVc6PvuOr-3-g3LacYW8JvXpM5Gr_jhdUGEU,9630
-mpflash/mpboard_id/board.py,sha256=CwtBux8y7GDUe7CADVxL8YefGRl9Fg8OAJBUhgaBYCI,1151
-mpflash/mpboard_id/board_id.py,sha256=3Qeo9cQOfn6EQ0gr5MHsl0Nk7is_piYrz0mMbV2LC-Q,2957
-mpflash/mpboard_id/board_info.zip,sha256=XkIk35v6LotRMClCU-zEvo1zQiKXZAqkHfwLP4JhfaM,20102
+mpflash/mpboard_id/__init__.py,sha256=b9PJiKFqmfyYgfi0-pbWGp2mrljdgvO6DNy0ABS8izU,3898
+mpflash/mpboard_id/add_boards.py,sha256=sM32QWguCRuLhKO0H8KUoy4MVr_8dzJpYHUSS5KNPgw,9906
+mpflash/mpboard_id/board.py,sha256=JKb4T67HmK7widW-4c1PgilvywMbZYToLk9Fyokm-6Q,1163
+mpflash/mpboard_id/board_id.py,sha256=MnDWPqp0OqCkWD3E1Mhg-g20qASgPVHdROOCdr5TpOU,3249
+mpflash/mpboard_id/board_info.zip,sha256=DC_yHwL8A8IC0YsA2ZXjlRLZkLKiw03k4FR2HSTfBXw,21328
 mpflash/mpboard_id/store.py,sha256=n85vnUAxGKv1C23wkm22ZFAFGK6AZZiCFvc1lGJJjis,1703
 mpflash/mpremoteboard/__init__.py,sha256=3F6vZHM1znUOnAo0ne-FalApM6vwbTNYg4kJwkS1gNI,9521
 mpflash/mpremoteboard/mpy_fw_info.py,sha256=eRjhqN7MpmYE9TiS4iukquZZs3QE_lD5zv_vOPSjNrk,4821
@@ -45,9 +45,9 @@ mpflash/vendor/click_aliases.py,sha256=c853EHSlkE2DvFqeFvFpwXKuJj3_jsXDP7iotVOKa
 mpflash/vendor/dfu.py,sha256=ZXMcE6aH4-43Wh4tbQT4U-q-BU3RUiL3JAxmP_QAK2s,5755
 mpflash/vendor/pydfu.py,sha256=_MdBRo1EeNeKDqFPSTB5tNL1jGSBJgsVeVjE5e7Pb8s,20542
 mpflash/vendor/readme.md,sha256=iIIZxuLUIGHQ0KODzYVtMezsztvyxCXcNJp_AzwTIPk,86
-mpflash/versions.py,sha256=5XhbR5Ef2291zBaDTcrfDjCl8iAIiuJKVfV6oNpPofY,4628
-mpflash-1.24.1.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
-mpflash-1.24.1.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
-mpflash-1.24.1.dist-info/METADATA,sha256=_nDL8N-jdz-CNAw-MOaEtZmX1ZnAkcSRmubfn_7lR80,17650
-mpflash-1.24.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-mpflash-1.24.1.dist-info/RECORD,,
+mpflash/versions.py,sha256=PKJyBF7iK3nAQ3kE06-31QQqmvRA8JPHtCphhzIkScQ,4675
+mpflash-1.24.3.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
+mpflash-1.24.3.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
+mpflash-1.24.3.dist-info/METADATA,sha256=d11Vn2rmmYmtInvpQ2ts23ycuKoDlEqA1ryZa5waPBo,17651
+mpflash-1.24.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+mpflash-1.24.3.dist-info/RECORD,,