micropython-stubber 1.23.1__py3-none-any.whl → 1.23.1.post1__py3-none-any.whl

mpflash/mpflash/mpremoteboard/__init__.py

@@ -8,16 +8,20 @@ from pathlib import Path
 from typing import List, Optional, Union
 
 import serial.tools.list_ports
-from loguru import logger as log
 from rich.progress import track
 from tenacity import retry, stop_after_attempt, wait_fixed
 
 from mpflash.errors import MPFlashError
+from mpflash.logger import log
 from mpflash.mpboard_id.board_id import find_board_id_by_description
 from mpflash.mpremoteboard.runner import run
 
+if sys.version_info >= (3, 11):
+    import tomllib  # type: ignore
+else:
+    import tomli as tomllib  # type: ignore
+
 ###############################################################################################
-# TODO : make this a bit nicer
 HERE = Path(__file__).parent
 
 OK = 0
@@ -52,6 +56,7 @@ class MPRemoteBoard:
         self.mpy = ""
         self.build = ""
         self.location = location
+        self.toml = {}
         if update:
             self.get_mcu_info()
 
@@ -111,13 +116,14 @@ class MPRemoteBoard:
             ["run", str(HERE / "mpy_fw_info.py")],
             no_info=True,
             timeout=timeout,
+            resume=True,  # Avoid restarts
         )
         if rc != OK:
             raise ConnectionError(f"Failed to get mcu_info for {self.serialport}")
         # Ok we have the info, now parse it
-        s = result[0].strip()
-        if s.startswith("{") and s.endswith("}"):
-            info = eval(s)
+        raw_info = result[0].strip()
+        if raw_info.startswith("{") and raw_info.endswith("}"):
+            info = eval(raw_info)
             self.family = info["family"]
             self.version = info["version"]
             self.build = info["build"]
@@ -132,6 +138,43 @@ class MPRemoteBoard:
                 self.board = board_name
             else:
                 self.board = "UNKNOWN_BOARD"
+            # get the board_info.toml
+            self.get_board_info_toml()
+        # now we know the board is connected
+        self.connected = True
+
+    @retry(stop=stop_after_attempt(RETRIES), wait=wait_fixed(0.2), reraise=True)  # type: ignore ## retry_error_cls=ConnectionError,
+    def get_board_info_toml(self, timeout: int = 1):
+        """
+        Reads the content of the board_info.toml file from the connected board,
+        and adds that to the board object.
+
+        Parameters:
+        - timeout (int): The timeout value in seconds.
+
+        Raises:
+        - ConnectionError: If failed to communicate with the serial port.
+        """
+        try:
+            rc, result = self.run_command(
+                ["cat", ":board_info.toml"],
+                no_info=True,
+                timeout=timeout,
+                log_errors=False,
+            )
+        except Exception as e:
+            raise ConnectionError(f"Failed to get board_info.toml for {self.serialport}: {e}")
+        # this is optional - so only parse if we got the file
+        self.toml = {}
+        if rc in [OK]:  # sometimes we get an -9 ???
+            try:
+                # Ok we have the info, now parse it
+                self.toml = tomllib.loads("".join(result))
+                log.debug(f"board_info.toml: {self.toml}")
+            except Exception as e:
+                log.error(f"Failed to parse board_info.toml: {e}")
+        else:
+            log.trace(f"Failed to read board_info.toml: {result}")
 
     def disconnect(self) -> bool:
         """
@@ -159,6 +202,7 @@ class MPRemoteBoard:
         log_errors: bool = True,
         no_info: bool = False,
         timeout: int = 60,
+        resume: bool = False,
         **kwargs,
     ):
         """
@@ -179,7 +223,7 @@ class MPRemoteBoard:
         if self.serialport:
             prefix += ["connect", self.serialport]
         # if connected add resume to keep state between commands
-        if self.connected:
+        if self.connected or resume:
             prefix += ["resume"]
         cmd = prefix + cmd
         log.debug(" ".join(cmd))

mpflash/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mpflash"
-version = "0.9.1.Post2"
+version = "1.0.0"
 description = "Flash and download tool for MicroPython firmwares"
 authors = ["Jos Verlinde <jos_verlinde@hotmail.com>"]
 license = "MIT"

stubber/bulk/mcu_stubber.py

@@ -11,11 +11,13 @@ from pathlib import Path
 from tempfile import mkdtemp
 from typing import List, Optional, Tuple
 
-from loguru import logger as log
 from rich.console import Console
 from rich.table import Table
 from tenacity import retry, stop_after_attempt, wait_fixed
 
+from mpflash.connected import list_mcus
+from mpflash.list import show_mcus
+from mpflash.logger import log
 from mpflash.mpremoteboard import ERROR, OK, MPRemoteBoard
 from stubber import utils
 from stubber.publish.merge_docstubs import merge_all_docstubs
@@ -250,7 +252,10 @@ def copy_boardname_to_board(mcu: MPRemoteBoard):
         None
     """
     if mcu.board:
-        cmd = ["exec", f"with open('lib/boardname.py', 'w') as f: f.write('BOARDNAME=\"{mcu.board}\"')"]
+        cmd = [
+            "exec",
+            f"with open('lib/boardname.py', 'w') as f: f.write('BOARDNAME=\"{mcu.board}\"')",
+        ]
         log.info(f"Writing BOARDNAME='{mcu.board}' to boardname.py")
     else:
         cmd = ["rm", "boardname.py"]
@@ -284,30 +289,7 @@ def copy_scripts_to_board(mcu: MPRemoteBoard, variant: Variant, form: Form):
 
 
 def get_stubfolder(out: List[str]):
-    return (
-        lines[-1].split("/remote/")[-1].strip() if (lines := [l for l in out if l.startswith("INFO  : Path: ")]) else ""
-    )
-
-
-def scan_boards(optimistic: bool = False) -> List[MPRemoteBoard]:
-    """
-    This function scans for boards and returns a list of MPRemoteBoard objects.
-    :return: list of MPRemoteBoard objects
-    """
-    boards = []
-    for mpr_port in MPRemoteBoard.connected_boards():
-        board = MPRemoteBoard(mpr_port)
-        log.debug(f"Attempt to connect to: {board.serialport}")
-        try:
-            board.get_mcu_info()
-            log.success(f"Detected board {board.description} {board.version}")
-            boards.append(board)
-        except Exception:
-            log.error(f"Failed to get mcu_info for {board.serialport}")
-            if optimistic:
-                boards.append(board)
-            continue
-    return boards
+    return lines[-1].split("/remote/")[-1].strip() if (lines := [l for l in out if l.startswith("INFO  : Path: ")]) else ""
 
 
 def set_loglevel(verbose: int) -> str:
@@ -347,7 +329,14 @@ def copy_to_repo(source: Path, fw: dict) -> Optional[Path]:
         return None
 
 
-def stub_connected_mcus(variant: str, format: str, debug: bool) -> int:
+def stub_connected_mcus(
+    variant: str,
+    format: str,
+    debug: bool,
+    serial: List[str],
+    ignore: List[str],
+    bluetooth: bool,
+) -> int:
     """
     Runs the stubber to generate stubs for connected MicroPython boards.
 
@@ -372,27 +361,19 @@ def stub_connected_mcus(variant: str, format: str, debug: bool) -> int:
     all_built = []
 
     # scan boards and just work with the ones that respond with understandable data
-    connected_boards = scan_boards(True)
-    if not connected_boards:
+    connected_mcus = list_mcus(ignore=ignore, include=serial, bluetooth=bluetooth)
+    # ignore boards that have the [micropython-stubber] ignore flag set
+    connected_mcus = [item for item in connected_mcus if not (item.toml.get("micropython-stubber", {}).get("ignore", False))]
+
+    if not connected_mcus:
         log.error("No micropython boards were found")
         return ERROR
 
-    table = Table(show_header=True, header_style="bold magenta")
-    table.add_column("Serial Port")
-    table.add_column("Port")
-    table.add_column("Description")
-    table.add_column("Version")
-
-    for b in connected_boards:
-        table.add_row(b.serialport, b.port, b.description, b.version)
-    console = Console()
-    console.print(table)
+    show_mcus(connected_mcus, refresh=False)
 
     # scan boards and generate stubs
-    for board in connected_boards:
-        log.info(
-            f"Connecting using {board.serialport} to {board.port} {board.board} {board.version}: {board.description}"
-        )
+    for board in connected_mcus:
+        log.info(f"Connecting using {board.serialport} to {board.port} {board.board} {board.version}: {board.description}")
         # remove the modulelist.done file before starting createstubs on each board
         (temp_path / "modulelist.done").unlink(missing_ok=True)
 
@@ -428,14 +409,16 @@ def stub_connected_mcus(variant: str, format: str, debug: bool) -> int:
                 all_built.extend(built)
 
     if all_built:
-        print_result_table(all_built, console)
+        print_result_table(all_built)
         log.success("Done")
         return OK
     log.error(f"Failed to generate stubs for {board.serialport}")
     return ERROR
 
 
-def print_result_table(all_built: List, console: Console):
+def print_result_table(all_built: List, console: Optional[Console] = None):
+    if not console:
+        console = Console()
     # create a rich table of the results and print it'
     table = Table(title="Results")
 

stubber/codemod/enrich.py

@@ -8,7 +8,7 @@ from typing import Any, Dict, Optional
 
 from libcst.codemod import CodemodContext, diff_code, exec_transform_with_prettyprint
 from libcst.tool import _default_config  # type: ignore
-from loguru import logger as log
+from mpflash.logger import log
 
 import stubber.codemod.merge_docstub as merge_docstub
 from stubber.utils.post import run_black

stubber/codemod/merge_docstub.py

@@ -13,7 +13,7 @@ import libcst as cst
 from libcst.codemod import CodemodContext, VisitorBasedCodemodCommand
 from libcst.codemod.visitors import AddImportsVisitor, GatherImportsVisitor, ImportItem
 from libcst.helpers.module import insert_header_comments
-from loguru import logger as log
+from mpflash.logger import log
 
 from stubber.cst_transformer import (
     MODULE_KEY,

stubber/commands/build_cmd.py

@@ -3,7 +3,7 @@
 from typing import List, Union
 
 import rich_click as click
-from loguru import logger as log
+from mpflash.logger import log
 from tabulate import tabulate
 
 from stubber.commands.cli import stubber_cli

stubber/commands/cli.py

@@ -4,12 +4,13 @@ command line interface - main group
 
 import sys
 
+from mpflash.vendor.click_aliases import ClickAliasedGroup
 import rich_click as click
-from loguru import logger as log
+from mpflash.logger import log, set_loglevel as mpf_set_loglevel
 from stubber import __version__
 
 
-@click.group(chain=True)
+@click.group(chain=True, cls=ClickAliasedGroup)
 @click.version_option(package_name="micropython-stubber", prog_name="micropython-stubber✏️ ")
 @click.option(
     "-V",
@@ -41,15 +42,8 @@ def set_loglevel(verbose: int) -> str:
     Add the handler to the logger, with the level and format string.
     Return the level
     """
-    log.remove()
     level = {0: "INFO", 1: "DEBUG", 2: "TRACE"}.get(verbose, "TRACE")
-    if level == "INFO":
-        format_str = "<green>{time:HH:mm:ss}</green> | <level>{level: <8}</level> | <cyan>{module: <18}</cyan> - <level>{message}</level>"
-    else:
-        format_str = "<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | <level>{level: <8}</level> | <cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> - <level>{message}</level>"
-
-    log.add(
-        sys.stderr, level=level, backtrace=True, diagnose=True, colorize=True, format=format_str
-    )
+    # reuse mpflash logger
+    mpf_set_loglevel(level)
     log.info(f"micropython-stubber {__version__}")
     return level

stubber/commands/clone_cmd.py

@@ -9,7 +9,7 @@ from typing import List, Tuple, Union
 
 import rich_click as click
 import mpflash.basicgit as git
-from loguru import logger as log
+from mpflash.logger import log
 from stubber.utils.config import CONFIG
 
 from .cli import stubber_cli

stubber/commands/config_cmd.py

@@ -2,7 +2,7 @@
 
 # pragma: no cover
 
-from loguru import logger as log
+from mpflash.logger import log
 
 from stubber.utils.config import CONFIG
 

stubber/commands/enrich_folder_cmd.py

@@ -6,7 +6,7 @@ from pathlib import Path
 from typing import Union
 
 import rich_click as click
-from loguru import logger as log
+from mpflash.logger import log
 
 from stubber.codemod.enrich import enrich_folder
 from stubber.utils.config import CONFIG

stubber/commands/get_core_cmd.py

@@ -8,7 +8,7 @@ from pathlib import Path
 from typing import List
 
 import rich_click as click
-from loguru import logger as log
+from mpflash.logger import log
 
 import stubber.get_cpython as get_cpython
 import stubber.utils as utils

stubber/commands/get_docstubs_cmd.py

@@ -7,7 +7,7 @@ from pathlib import Path
 from typing import Optional
 
 import rich_click as click
-from loguru import logger as log
+from mpflash.logger import log
 
 import mpflash.basicgit as git
 import stubber.utils as utils
@@ -22,7 +22,10 @@ from .cli import stubber_cli
 #########################################################################################
 
 
-@stubber_cli.command(name="get-docstubs")
+@stubber_cli.command(
+    name="get-docstubs",
+    aliases=["get-doc-stubs", "docstubs"],
+)
 @click.option(
     "--path",
     "-p",

stubber/commands/get_frozen_cmd.py

@@ -7,7 +7,7 @@ from pathlib import Path
 from typing import List, Optional
 
 import rich_click as click
-from loguru import logger as log
+from mpflash.logger import log
 
 import stubber.utils as utils
 from stubber.codemod.enrich import enrich_folder
@@ -20,7 +20,10 @@ from .cli import stubber_cli
 ##########################################################################################
 
 
-@stubber_cli.command(name="get-frozen")
+@stubber_cli.command(
+    name="get-frozen",
+    aliases=["get-frozen-stubs", "frozen"],
+)
 @click.option(
     "--stub-folder",
     "-stubs",

stubber/commands/get_mcu_cmd.py

@@ -5,8 +5,9 @@
 ##########################################################################################
 
 
+from typing import List
 import rich_click as click
-from loguru import logger as log
+from mpflash.logger import log
 
 from stubber.bulk.mcu_stubber import stub_connected_mcus
 from stubber.utils.config import CONFIG
@@ -18,7 +19,10 @@ from .cli import stubber_cli
 #########################################################################################
 
 
-@stubber_cli.command(name="get-mcu-stubs")
+@stubber_cli.command(
+    name="get-mcu-stubs",
+    aliases=["get-mcu-stubs", "mcu-stubs", "mcu"],
+)
 @click.option(
     "--variant",
     # "-v",
@@ -35,22 +39,50 @@ from .cli import stubber_cli
     show_default=True,
     help="Python source or pre-compiled.",
 )
-@click.option("--debug/--no-debug", default=False, show_default=True, help="Debug mode.")
 @click.option(
-    "--reset/--no-reset",
-    default=False,
+    "--serial",
+    "--serial-port",
+    "-s",
+    "serial",
+    default=["*"],
+    multiple=True,
     show_default=True,
-    help="Reset the board before running createstubs.",
+    help="Which serial port(s) (or globs) to list. ",
+    metavar="SERIALPORT",
 )
 @click.option(
-    "--github/--local",
-    default=True,
+    "--ignore",
+    "-i",
+    is_eager=True,
+    help="Serial port(s) (or globs) to ignore. Defaults to MPFLASH_IGNORE.",
+    multiple=True,
+    default=[],
+    envvar="MPFLASH_IGNORE",
     show_default=True,
-    help="where to install the board files from. local is intended for development.",
+    metavar="SERIALPORT",
 )
-def cli_create_mcu_stubs(variant: str, format: str, debug: bool, reset: bool, github: bool) -> int:
+@click.option(
+    "--bluetooth/--no-bluetooth",
+    "-b/-nb",
+    is_flag=True,
+    default=False,
+    show_default=True,
+    help="""Include bluetooth ports in the list""",
+)
+@click.option("--debug/--no-debug", default=False, show_default=True, help="Debug mode.")
+def cli_create_mcu_stubs(
+    variant: str,
+    format: str,
+    debug: bool,
+    serial: List[str],
+    ignore: List[str],
+    bluetooth: bool,
+) -> int:
     """Run createstubs on one or more MCUs, and add the stubs to the micropython-stub repo."""
     # check if all repos have been cloned
+    serial = list(serial)
+    ignore = list(ignore)
+
     for repo in CONFIG.repos:
         if not repo.exists():
             log.error(
@@ -58,4 +90,13 @@ def cli_create_mcu_stubs(variant: str, format: str, debug: bool, reset: bool, gi
             )
             exit(1)
 
-    exit(stub_connected_mcus(variant=variant, format=format, debug=debug))
+    exit(
+        stub_connected_mcus(
+            variant=variant,
+            format=format,
+            debug=debug,
+            serial=serial,
+            ignore=ignore,
+            bluetooth=bluetooth,
+        )
+    )

stubber/commands/merge_cmd.py

@@ -5,7 +5,7 @@ enrich machinestubs with docstubs
 from typing import List, Union
 
 import rich_click as click
-from loguru import logger as log
+from mpflash.logger import log
 
 from stubber.publish.merge_docstubs import merge_all_docstubs
 from stubber.publish.package import GENERIC_L

stubber/commands/publish_cmd.py

@@ -5,7 +5,7 @@ Commandline interface to publish stubs.
 from typing import List, Union
 
 import rich_click as click
-from loguru import logger as log
+from mpflash.logger import log
 from tabulate import tabulate
 
 from stubber.commands.cli import stubber_cli

stubber/commands/stub_cmd.py

@@ -4,7 +4,7 @@
 # stub
 ##########################################################################################
 
-from loguru import logger as log
+from mpflash.logger import log
 from pathlib import Path
 from typing import Union
 

stubber/commands/variants_cmd.py

@@ -3,7 +3,7 @@
 from pathlib import Path
 
 import rich_click as click
-from loguru import logger as log
+from mpflash.logger import log
 from stubber.utils.config import CONFIG
 from stubber.variants import create_variants
 import stubber

stubber/downloader.py

@@ -1,11 +1,12 @@
 """Download files from a public github repo"""
+
 # Copyright (c) 2020 Jos Verlinde
 # MIT license
 # pylint: disable= invalid-name
 import os
 
 import requests
-from loguru import logger as log
+from mpflash.logger import log
 
 # # log = logging.getLogger(__name__)
 # log.setLevel(level=logging.INFO)

stubber/freeze/common.py

@@ -5,7 +5,7 @@ import shutil
 from pathlib import Path
 from typing import Tuple
 
-from loguru import logger as log
+from mpflash.logger import log
 
 from stubber.publish.defaults import GENERIC_U
 
@@ -17,7 +17,9 @@ def get_portboard(manifest_path: Path):
     raises an ValueError if neither a port or board can be found
     """
     # https://regex101.com/r/tv7JX4/1
-    re_pb = r".*micropython[\/\\]ports[\/\\](?P<port>[\w_-]*)([\/\\]boards[\/\\](?P<board>\w*))?[\/\\]"
+    re_pb = (
+        r".*micropython[\/\\]ports[\/\\](?P<port>[\w_-]*)([\/\\]boards[\/\\](?P<board>\w*))?[\/\\]"
+    )
     mpy_port = mpy_board = ""
     if matches := re.search(re_pb, manifest_path.absolute().as_posix()):
         # port and board
@@ -50,7 +52,9 @@ def apply_frozen_module_fixes(freeze_path: Path, mpy_path: Path):
     apply common fixes to the fozen modules to improve stub generation
     """
     # NOTE: FIX 1 add __init__.py to umqtt
-    if (freeze_path / "umqtt/robust.py").exists():  # and not (freeze_path / "umqtt" / "__init__.py").exists():
+    if (
+        freeze_path / "umqtt/robust.py"
+    ).exists():  # and not (freeze_path / "umqtt" / "__init__.py").exists():
         log.debug("add missing : umqtt/__init__.py")
         with open(freeze_path / "umqtt" / "__init__.py", "a") as f:
             f.write("")

stubber/freeze/freeze_folder.py

@@ -6,7 +6,7 @@ import shutil
 import warnings
 from pathlib import Path  # start moving from os & glob to pathlib
 
-from loguru import logger as log
+from mpflash.logger import log
 from stubber.utils.repos import match_lib_with_mpy
 
 from .. import utils
@@ -25,7 +25,7 @@ def freeze_folders(stub_folder: str, mpy_folder: str, lib_folder: str, version:
     - 'ports/<port>/modules/*.py'
     - 'ports/<port>/boards/<board>/modules/*.py'
     """
-    match_lib_with_mpy(version_tag=version, mpy_path=Path(mpy_folder),lib_path=Path(lib_folder))
+    match_lib_with_mpy(version_tag=version, mpy_path=Path(mpy_folder), lib_path=Path(lib_folder))
 
     targets = []
     scripts = glob.glob(mpy_folder + "/ports/**/modules/*.py", recursive=True)

stubber/freeze/freeze_manifest_2.py

@@ -9,7 +9,7 @@ import shutil
 from pathlib import Path
 from typing import List, Optional
 
-from loguru import logger as log
+from mpflash.logger import log
 
 from stubber import utils
 from stubber.tools.manifestfile import MODE_FREEZE, ManifestFile, ManifestFileError, ManifestOutput
@@ -51,7 +51,9 @@ def make_path_vars(
     }
 
 
-def freeze_one_manifest_2(manifest: Path, frozen_stub_path: Path, mpy_path: Path, mpy_lib_path: Path, version: str):
+def freeze_one_manifest_2(
+    manifest: Path, frozen_stub_path: Path, mpy_path: Path, mpy_lib_path: Path, version: str
+):
     # apparently there can be multiple manifest files to a board ?
     # save cwd for 'misbehaving' older esp8266 manifest files
     cwd = Path.cwd()
@@ -61,7 +63,9 @@ def freeze_one_manifest_2(manifest: Path, frozen_stub_path: Path, mpy_path: Path
 
     log.info("port-board: {}".format((port + "-" + board).rstrip("-")))
 
-    path_vars = make_path_vars(port=port, board=board, mpy_path=mpy_path, mpy_lib_path=mpy_lib_path)
+    path_vars = make_path_vars(
+        port=port, board=board, mpy_path=mpy_path, mpy_lib_path=mpy_lib_path
+    )
     upy_manifest = ManifestFile(MODE_FREEZE, path_vars)
     try:
         # assume manifestneeds to be run from the port's folder
@@ -75,11 +79,18 @@ def freeze_one_manifest_2(manifest: Path, frozen_stub_path: Path, mpy_path: Path
     # restore working directory
     os.chdir(cwd)
     # save the frozen files to the stubs
-    copy_frozen_to_stubs(frozen_stub_path, port, board, upy_manifest.files(), version, mpy_path=mpy_path)
+    copy_frozen_to_stubs(
+        frozen_stub_path, port, board, upy_manifest.files(), version, mpy_path=mpy_path
+    )
 
 
 def copy_frozen_to_stubs(
-    stub_path: Path, port: str, board: str, files: List[ManifestOutput], version: str, mpy_path: Path
+    stub_path: Path,
+    port: str,
+    board: str,
+    files: List[ManifestOutput],
+    version: str,
+    mpy_path: Path,
 ):
     """
     copy the frozen files from the manifest to the stubs folder
@@ -110,4 +121,6 @@ def copy_frozen_to_stubs(
 
     # make a module manifest
     FAMILY = "micropython"
-    utils.make_manifest(freeze_path, FAMILY, port=port, board=board, version=version, stubtype="frozen")
+    utils.make_manifest(
+        freeze_path, FAMILY, port=port, board=board, version=version, stubtype="frozen"
+    )