mpflash 1.25.0.post1__py3-none-any.whl → 1.25.0rc1__py3-none-any.whl

mpflash/mpboard_id/add_boards.py

@@ -1,260 +0,0 @@
-"""
-Collects board name and description information from MicroPython and writes it to JSON and CSV files.
-"""
-
-import re
-from pathlib import Path
-from typing import List, Optional
-
-import inquirer
-import rich
-import rich.table
-from rich.console import Console
-from rich.progress import track
-
-import mpflash.basicgit as git
-from mpflash.logger import log
-from mpflash.mpboard_id import Board
-from mpflash.mpboard_id.store import write_boardinfo_json
-from mpflash.versions import get_preview_mp_version, micropython_versions
-
-# look for all mpconfigboard.h files and extract the board name
-# from the #define MICROPY_HW_BOARD_NAME "PYBD_SF6"
-# and the #define MICROPY_HW_MCU_NAME "STM32F767xx"
-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 boards and variants 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_MCU_NAME = re.compile(r"MICROPY_HW_MCU_NAME\s?=\s?\"(?P<variant>[\w\s\S]*)\"")
-# TODO: normal make files
-
-
-def boards_from_repo(mpy_path: Path, version: str, family: Optional[str] = None) -> List[Board]:
-    """Collects board name and decriptions from mpconfigboard.h files.
-
-    Args:
-        mpy_path (Path): The path to the MicroPython repository.
-        version (str): The version of MicroPython.
-
-    Returns:
-        List[Board]: A list of Board objects containing the board information.
-    """
-    if not mpy_path.exists() or not mpy_path.is_dir():
-        raise FileNotFoundError(f"MicroPython path {mpy_path} does not exist.")
-    family = family or "micropython"
-    version = version or git.get_local_tag()  # type: ignore
-    if not version:
-        raise ValueError("No version provided and no local tag found.")
-    elif version in ["main", "master"]:
-        version = get_preview_mp_version()
-
-    board_list: List[Board] = []
-    # look in mpconfigboard.h files
-    board_list = boards_from_cmake(mpy_path, version, family)
-
-    # look for boards in the .cmake files
-    board_list.extend(boards_from_headers(mpy_path, version, family))
-
-    # TODO:? look for variants in the board.json files
-
-    return board_list
-
-
-def boards_from_cmake(mpy_path: Path, version: str, family: str):
-    """Get boards from the mpconfigboard.cmake files to the board_list."""
-    board_list = []
-    for path in mpy_path.glob("ports/**/mpconfigboard*.cmake"):
-        board = path.parent.name
-        port = path.parent.parent.parent.name
-        with open(path, "r") as f:
-            board_name = mcu_name = "-"
-            for line in f:
-                line = line.strip()
-                if match := RE_CMAKE_MICROPY_HW_BOARD_NAME.match(line):
-                    description = match["variant"]
-                    board_list.append(
-                        Board(
-                            board_id=board,
-                            port=port,
-                            board_name=board_name,
-                            mcu_name=mcu_name,
-                            description=description,
-                            path=path.relative_to(mpy_path),
-                            version=version,
-                            family=family,
-                        )
-                    )
-                elif match := RE_CMAKE_MICROPY_HW_MCU_NAME.match(line):
-                    description = match["variant"]
-                    board_list.append(
-                        Board(
-                            board_id=board,
-                            port=port,
-                            board_name=board_name,
-                            mcu_name=mcu_name,
-                            description=description,
-                            path=path.relative_to(mpy_path),
-                            version=version,
-                            family=family,
-                        )
-                    )
-    return board_list
-
-
-def boards_from_headers(mpy_path: Path, version: str, family: str):
-    """Get boards from the mpconfigboard.h files to the board_list."""
-    board_list = []
-    for path in mpy_path.glob("ports/**/mpconfigboard.h"):
-        board = path.parent.name
-        port = path.parent.parent.parent.name
-        with open(path, "r") as f:
-            board_name = mcu_name = "-"
-            found = 0
-            for line in f:
-                if match := RE_H_MICROPY_HW_BOARD_NAME.match(line):
-                    board_name = match[1]
-                    found += 1
-                elif match := RE_H_MICROPY_HW_MCU_NAME.match(line):
-                    mcu_name = match[1]
-                    found += 1
-                if found == 2:
-                    description = f"{board_name} with {mcu_name}" if mcu_name != "-" else board_name
-                    board_list.append(
-                        Board(
-                            board_id=board,
-                            port=port,
-                            board_name=board_name,
-                            mcu_name=mcu_name,
-                            description=description,
-                            path=path.relative_to(mpy_path),
-                            version=version,
-                            family=family,
-                        )
-                    )
-                    found = 0
-            if found == 1:
-                description = board_name
-                board_list.append(
-                    Board(
-                        board_id=board,
-                        port=port,
-                        board_name=board_name,
-                        mcu_name=mcu_name,
-                        description=description,
-                        path=path.relative_to(mpy_path),
-                        version=version,
-                        family=family,
-                    )
-                )
-    return board_list
-
-
-def boards_for_versions(versions: List[str], mpy_path: Path):
-    """Gets the list of boards for multiple versions of MicroPython.
-
-    Args:
-        versions (List[str]): The list of MicroPython versions.
-        mpy_path (Path): The path to the MicroPython repository.
-
-    Returns:
-        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")
-            print(f"Found {len(new_ones)} board definitions for {version}.")
-            board_list += new_ones
-        else:
-            print(f"Could not checkout version {version}.")
-
-    # sort the board_list by description and board
-    print("Total number of boards found:", len(board_list))
-
-    board_list = unique_boards(board_list)
-    print("Unique board descriptions found:", len(board_list))
-    return board_list
-
-
-def unique_boards(board_list: List[Board], *, key_version: bool = True):
-    """Remove duplicate boards by 'BOARD_ID description' from the list."""
-    seen = set()
-    result = []
-    for x in board_list:
-        if key_version:
-            key = f"{x.board_id}|{x.version}|{x.description}"
-        else:
-            key = f"{x.board_id}|{x.description}"
-        if key not in seen:
-            result.append(x)
-            seen.add(key)
-    result.sort(key=lambda x: x.description.lower())
-    return result
-
-
-def make_table(board_list: List[Board]) -> rich.table.Table:
-    """Creates a rich table with board information."""
-    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("Board Name", justify="left", style="blue")
-    if is_wide:
-        table.add_column("MCU Name", justify="left", style="blue")
-    table.add_column("Detection", justify="left", style="yellow")
-    table.add_column("Version", justify="left", style="blue")
-    if is_wide:
-        table.add_column("Family", justify="left", style="blue")
-
-    for board in board_list:
-        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))
-        if is_wide:
-            row.append(board.family)
-        table.add_row(*row)
-
-    return 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",
-        )
-    ]
-    if answers := inquirer.prompt(questions):
-        return Path(answers["mpy_path"])
-    else:
-        raise ValueError("No path provided.")
-
-
-def main():
-    """Main function to collect and write board information."""
-
-    console = Console()
-
-    mpy_path = ask_mpy_path()
-    versions = micropython_versions(minver="v1.10") + ["master"]
-    board_list = boards_for_versions(versions, mpy_path)
-
-    here = Path(__file__).parent
-    log.info(write_boardinfo_json(board_list, folder=here))
-    # write_files(board_list, folder=CONFIG.board_path)
-
-    # table of when the board was added
-    table = make_table(unique_boards(board_list, key_version=False))
-    console.print(table)
-
-
-if __name__ == "__main__":
-    main()

mpflash/mpboard_id/board.py

@@ -1,40 +0,0 @@
-from dataclasses import dataclass, field
-from pathlib import Path
-from typing import Union
-
-
-# - source : get_boardnames.py
-@dataclass
-class Board:
-    """
-    MicroPython Board definitions, parsed from the make and header files
-    """
-
-    port: str  # micropython port
-    board_id: str  # BOARD_ID (Foldername) as used in the make files
-    board_name: str  # Short board description
-    description: str  # Long board description
-    path: Union[Path, str]
-    version: str = field(default="")  # version of MicroPython""
-    # versions: List[str] = field(default=[])  # version of MicroPython""
-    family: str = field(default="micropython")
-    mcu_name: str = field(default="")
-    cpu: str = field(default="")
-    variant: str = field(default="")
-    mcu: str = field(default="")
-
-    def __post_init__(self):
-        if not self.cpu:
-            if " with " in self.description:
-                self.cpu = self.description.rsplit(" with ")[-1]
-            else:
-                self.cpu = self.port
-
-    @staticmethod
-    def from_dict(data: dict) -> "Board":
-        valid_keys = {field.name for field in Board.__dataclass_fields__.values()}
-        filtered_data = {k: v for k, v in data.items() if k in valid_keys}
-        return Board(**filtered_data)
-
-    def to_dict(self) -> dict:
-        return self.__dict__

mpflash/mpboard_id/store.py

@@ -1,47 +0,0 @@
-import functools
-import zipfile
-from pathlib import Path
-from typing import Final, List, Optional
-from mpflash.logger import log
-
-import jsons
-
-from mpflash.mpboard_id.board import Board
-
-###############################################################################################
-HERE: Final = Path(__file__).parent
-###############################################################################################
-
-
-def write_boardinfo_json(board_list: List[Board], *, folder: Optional[Path] = None):
-    """Writes the board information to a JSON file.
-
-    Args:
-        board_list (List[Board]): The list of Board objects.
-        folder (Path): The folder where the compressed JSON file will be saved.
-    """
-
-    if not folder:
-        folder = HERE
-    # create a zip file with the json file
-    with zipfile.ZipFile(folder / "board_info.zip", "w", compression=zipfile.ZIP_DEFLATED) as zipf:
-        # write the list to json file inside the zip
-        with zipf.open("board_info.json", "w") as fp:
-            fp.write(jsons.dumps(board_list, jdkwargs={"indent": 4}).encode())
-
-
-@functools.lru_cache(maxsize=20)
-def read_known_boardinfo(board_info: Optional[Path] = None) -> List[Board]:
-    """Reads the board information from a JSON file in a zip file."""
-    log.warning("read_known_boardinfo() is deprecated")
-
-    if not board_info:
-        board_info = HERE / "board_info.zip"
-    if not board_info.exists():
-        raise FileNotFoundError(f"Board info file not found: {board_info}")
-
-    with zipfile.ZipFile(board_info, "r") as zf:
-        with zf.open("board_info.json", "r") as file:
-            info = jsons.loads(file.read().decode(encoding="utf-8"), List[Board])
-
-    return info

mpflash-1.25.0.post1.dist-info/RECORD

@@ -1,62 +0,0 @@
-mpflash/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mpflash/add_firmware.py,sha256=1h0HsA-EVi3HXLmoEvzwY_a-GuWYzPwulTYHHBB8THg,3428
-mpflash/ask_input.py,sha256=piwMuW7QlYsIvDdJFN1lVCkCGsmsSyyMaUOtvf_S330,8885
-mpflash/basicgit.py,sha256=AGqFZeEHjb_o7QtZyJ_M9aOXHN-JEGvUi6W01fpOGzc,9676
-mpflash/bootloader/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mpflash/bootloader/activate.py,sha256=orQOw4XTkXVZI-rMInRb0T5Wp3qA_BlzbJUA2gyBToU,2361
-mpflash/bootloader/detect.py,sha256=OagP2QVWeLLWkZt2paqEF6r4_x3QDcBGNCPOWfMy9NQ,2686
-mpflash/bootloader/manual.py,sha256=C3PVLW3lwz66zG2mOekAJdwXD8PZcIyI3VuLEkusMpI,3168
-mpflash/bootloader/micropython.py,sha256=v_kZkvg0uWZDbMrT78gmiYHbD83QLdnrctvEClI8iRg,529
-mpflash/bootloader/touch1200.py,sha256=VND7_YniS9Vx6WEaAxjI72RZZ6WBOwmBTsKJkbuaAHk,1105
-mpflash/cli_download.py,sha256=6p83u0Iqyq-V6zS_zQbngSgnCnE0thNPR02r_12_d_Y,3660
-mpflash/cli_flash.py,sha256=6ZOHChF1cUyQEDzUpgJKko8EX__55Ol-fQkZNfTJpB8,8337
-mpflash/cli_group.py,sha256=_Wj4EvRkmPri6wyJWT8cQ0WRMwrj9xtCDLaxFJs7ssM,2617
-mpflash/cli_list.py,sha256=U4lrlE7O6o1BamHD0K_cJhuINanKNgXkg-WTU5RetF4,2354
-mpflash/cli_main.py,sha256=aVlsA-ZHBKJyuGwSCbpO2Ky0X52wPeOOGumvuPPTFzQ,1136
-mpflash/common.py,sha256=1mEsilJd3HpL7wFPsJ0EScYoJj7JqGFWDjSFEKJdjeU,7488
-mpflash/config.py,sha256=GMuqhrof3lkG7x_CxitYRkm4mxHEYZ_uPFNO3QxSJCY,2166
-mpflash/connected.py,sha256=oxZdk1o-AfNPhJsSxr3KrMH_gdYfrjqc_IpT6J8Ng9k,3496
-mpflash/db/boards.py,sha256=KvpJ45oPwoxuXCzNpAPIyMOiXOpO72LBJowQ4QBJPiU,1960
-mpflash/db/downloads.py,sha256=sHJzKLf5cYFftIcweoBfCqMY0MPJMmFYVRT7mprspvU,2975
-mpflash/download/__init__.py,sha256=kI9zYSjFUO2vVbRofJmQw44ftlM5r1HnjmkdZenzo2c,8451
-mpflash/download/from_web.py,sha256=ddUd7MZJj19e_nR9Iw79v3UuCPwvkWwQtuBEyu-XsbY,7860
-mpflash/downloaded.py,sha256=kfUt07vDARZYw64TToXLxA-UlP7zFTGRjnBzIEDL5cU,4163
-mpflash/errors.py,sha256=IAidY3qkZsXy6Pm1rdmVFmGyg81ywHhse3itaPctA2w,247
-mpflash/flash/__init__.py,sha256=V--YRwDGtCCLVfCe9p9SGV1Cbi0FNd9zenKlIb-HFw0,2820
-mpflash/flash/esp.py,sha256=N71fPMYhYexEF3YeJGJ74B3GtceXa-FdGqiBpa2qboI,3225
-mpflash/flash/stm32.py,sha256=dqp9BZ4Vr-6GlQcF12TSmRf-5TXkov9qvCpMgeUJc7Y,574
-mpflash/flash/stm32_dfu.py,sha256=W-3JsRQyf3DduoIRXDmGZ35RogqtjQgcJnk-GOtQoLE,3090
-mpflash/flash/uf2/__init__.py,sha256=haL84hP2p1ZjKF6dXJJHAB_NTf7jT91MuZvmvg9SpIA,3617
-mpflash/flash/uf2/boardid.py,sha256=U5wGM8VA3wEpUxQCMtuXpMZZomdVH8J_Zd5_GekUMuU,423
-mpflash/flash/uf2/linux.py,sha256=uTgqyS7C7xfQ25RrTcSUkt-m2u2Ks_o7bPLzIecPoC8,4355
-mpflash/flash/uf2/macos.py,sha256=JTaIpqnR_0k4oSEvzs9amhmK-PMxUJyZLnZ_wZwxa-0,1228
-mpflash/flash/uf2/uf2disk.py,sha256=4_P2l-kedM7VSliA2u706LQLxvu3xWSod1-lj-xjZis,298
-mpflash/flash/uf2/windows.py,sha256=S---sVjVrC00ZcnpOewtJIBfSCj2cr7FGQwEm_ZEDnY,1334
-mpflash/flash/worklist.py,sha256=eOD7BigUEshwcc5p7SaSeegpSpIOX1zE_6HuOzssrqM,6083
-mpflash/list.py,sha256=AjsVTWWTcfUhoT2lYJf2KvcOgMen9MgXY6fDYJvd0Mc,4014
-mpflash/logger.py,sha256=D6S-KDhXTLl7bYMKfu71iVO1YlpGSd0BcHvkVFOCW5c,1080
-mpflash/mpboard_id/__init__.py,sha256=i-HxDi4UPvQu2zFhWK5HENr_HmTdsnaqkLfNyxjOelg,515
-mpflash/mpboard_id/add_boards.py,sha256=XCSyZC9v-B5gzW4dIWdqQVIiE8JviKx0GpyGEQ64dm8,9949
-mpflash/mpboard_id/board.py,sha256=hzP_SNyigjRQsP3FmTCvuCDtPPalfkL5IfjrnATlVS0,1367
-mpflash/mpboard_id/board_id.py,sha256=mJqVW_D8uHnuON7xpKBRRs2e3ExQGNYC2bSA2ItZBKY,5439
-mpflash/mpboard_id/board_info.json,sha256=A3ZIt38KvAy2NMB5srHorSBd3Q3wOZIXufWiIs3XLrs,1019745
-mpflash/mpboard_id/board_info.zip,sha256=-2bnQGRsIQuJUfz-7_-GQ8pMWJ1evhCez6yfjhXocNw,23213
-mpflash/mpboard_id/known.py,sha256=ySTOVDFjqhoeVcGtJcpaY6Cy2blTbLovD5z-IsdZhco,3769
-mpflash/mpboard_id/store.py,sha256=UR5nWwywqSPY_2DBP2w8td3b7N6iS-B5rMcyh-s2JOQ,1750
-mpflash/mpremoteboard/__init__.py,sha256=jj4FVK237BmQ1-N4ANePWEJFY7yyhbb0XvJx8n00vuc,11993
-mpflash/mpremoteboard/mpy_fw_info.py,sha256=xhEjifU7pAUpey5T23k6x_1bhuS2XcVbSM21ZynWDdM,5148
-mpflash/mpremoteboard/runner.py,sha256=-PgzAeBGbyXaAUlwyiw4mcINsP2U1XRRjP1_QdBrxpg,4786
-mpflash/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mpflash/vendor/board_database.py,sha256=Cb8fEhJaZ2siMkLPW5rPwV9yzBsTtKGOqWUd9TxNgFM,8763
-mpflash/vendor/click_aliases.py,sha256=adLhqLxNpJEPjSCIRSTkR-QzSgavGFKT0cwRbjxpzRU,5395
-mpflash/vendor/dfu.py,sha256=6rqGCBS8mTxxaLtkdzJ8O6nc74kFk8jrkmKvxw-x-u8,5693
-mpflash/vendor/pico-universal-flash-nuke/LICENSE.txt,sha256=Zkc2iTNbib2NCMwtLjMEz0vFCPglgvaw6Mj7QiWldpQ,1484
-mpflash/vendor/pico-universal-flash-nuke/universal_flash_nuke.uf2,sha256=QuPMppqHMVOt3vDVU0bikHRLsTiDRQYNUcGQ_OLRFGI,28160
-mpflash/vendor/pydfu.py,sha256=uD0esm1iPHap7T93M_fli1LlXwn8RxKDFRnt8inxJu8,20389
-mpflash/vendor/readme.md,sha256=BQ7Uxf8joeYMjTUuSLLBG49ob6a9MgFPIEwuc72-Mfw,415
-mpflash/versions.py,sha256=zDAUEMae0hvB8CFmVnf_VWtnVIpAiMGXKpvk2FgnWcg,4878
-mpflash-1.25.0.post1.dist-info/entry_points.txt,sha256=Jk_visOhYOsZIcSP2Ms9hKqfKy1iorR-6dYltSoWCpY,52
-mpflash-1.25.0.post1.dist-info/LICENSE,sha256=mWpNhsIxWzetYNnTpr4eb3HtgsxGIC8KcYWxXEcxQvE,1077
-mpflash-1.25.0.post1.dist-info/METADATA,sha256=JvqTGcAdnDOMzvMK3JVqNqE8OKtBcV986kDTdtTG-KY,23936
-mpflash-1.25.0.post1.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-mpflash-1.25.0.post1.dist-info/RECORD,,