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

stubber/board/createstubs_db.py

@@ -18,7 +18,7 @@ Create stubs for (all) modules on a MicroPython board.
     - cross compilation, using mpy-cross, to avoid the compilation step on the micropython device 
 
 
-This variant was generated from createstubs.py by micropython-stubber v1.23.0
+This variant was generated from createstubs.py by micropython-stubber v1.23.1
 """
 
 # Copyright (c) 2019-2024 Jos Verlinde
@@ -43,7 +43,7 @@ try:
 except ImportError:
     from ucollections import OrderedDict  # type: ignore
 
-__version__ = "v1.23.0"
+__version__ = "v1.23.1"
 ENOENT = 2
 _MAX_CLASS_LEVEL = 2  # Max class nesting
 LIBS = ["lib", "/lib", "/sd/lib", "/flash/lib", "."]
@@ -501,7 +501,7 @@ def ensure_folder(path: str):
 
 def _build(s):
     # extract build from sys.version or os.uname().version if available
-    # sys.version: 'MicroPython v1.23.0-preview.6.g3d0b6276f'
+    # sys.version: 'MicroPython v1.23.1-preview.6.g3d0b6276f'
     # sys.implementation.version: 'v1.13-103-gb137d064e'
     if not s:
         return ""
@@ -606,10 +606,10 @@ def _info():  # type:() -> dict[str, str]
         if (
             info["version"]
             and info["version"].endswith(".0")
-            and info["version"] >= "1.10.0"  # versions from 1.10.0 to 1.23.0 do not have a micro .0
+            and info["version"] >= "1.10.0"  # versions from 1.10.0 to 1.23.1 do not have a micro .0
             and info["version"] <= "1.19.9"
         ):
-            # versions from 1.10.0 to 1.23.0 do not have a micro .0
+            # versions from 1.10.0 to 1.23.1 do not have a micro .0
             info["version"] = info["version"][:-2]
 
     # spell-checker: disable

stubber/board/createstubs_db_min.py

@@ -51,7 +51,7 @@ try:from machine import reset
 except O:pass
 try:from collections import OrderedDict as l
 except O:from ucollections import OrderedDict as l
-__version__='v1.23.0'
+__version__='v1.23.1'
 A3=2
 A4=2
 A5=['lib','/lib','/sd/lib','/flash/lib',J]

stubber/board/createstubs_mem.py

@@ -9,7 +9,7 @@
     - cross compilation, using mpy-cross, 
       to avoid the compilation step on the micropython device 
 
-This variant was generated from createstubs.py by micropython-stubber v1.23.0
+This variant was generated from createstubs.py by micropython-stubber v1.23.1
 """
 
 # Copyright (c) 2019-2024 Jos Verlinde
@@ -34,7 +34,7 @@ try:
 except ImportError:
     from ucollections import OrderedDict  # type: ignore
 
-__version__ = "v1.23.0"
+__version__ = "v1.23.1"
 ENOENT = 2
 _MAX_CLASS_LEVEL = 2  # Max class nesting
 LIBS = ["lib", "/lib", "/sd/lib", "/flash/lib", "."]
@@ -492,7 +492,7 @@ def ensure_folder(path: str):
 
 def _build(s):
     # extract build from sys.version or os.uname().version if available
-    # sys.version: 'MicroPython v1.23.0-preview.6.g3d0b6276f'
+    # sys.version: 'MicroPython v1.23.1-preview.6.g3d0b6276f'
     # sys.implementation.version: 'v1.13-103-gb137d064e'
     if not s:
         return ""
@@ -597,10 +597,10 @@ def _info():  # type:() -> dict[str, str]
         if (
             info["version"]
             and info["version"].endswith(".0")
-            and info["version"] >= "1.10.0"  # versions from 1.10.0 to 1.23.0 do not have a micro .0
+            and info["version"] >= "1.10.0"  # versions from 1.10.0 to 1.23.1 do not have a micro .0
             and info["version"] <= "1.19.9"
         ):
-            # versions from 1.10.0 to 1.23.0 do not have a micro .0
+            # versions from 1.10.0 to 1.23.1 do not have a micro .0
             info["version"] = info["version"][:-2]
 
     # spell-checker: disable

stubber/board/createstubs_mem_min.py

@@ -47,7 +47,7 @@ try:from machine import reset
 except N:pass
 try:from collections import OrderedDict as g
 except N:from ucollections import OrderedDict as g
-__version__='v1.23.0'
+__version__='v1.23.1'
 y=2
 z=2
 A0=['lib','/lib','/sd/lib','/flash/lib',J]

stubber/board/createstubs_min.py

@@ -50,7 +50,7 @@ try:from machine import reset
 except N:pass
 try:from collections import OrderedDict as h
 except N:from ucollections import OrderedDict as h
-__version__='v1.23.0'
+__version__='v1.23.1'
 A0=2
 A1=2
 A5=['lib','/lib','/sd/lib','/flash/lib',J]

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/codemod/utils.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 from libcst import matchers as m
-from libcst.matchers._visitors import _gather_constructed_leave_funcs, _gather_constructed_visit_funcs
+from libcst.matchers._visitors import _gather_constructed_leave_funcs, _gather_constructed_visit_funcs # type: ignore
 from typing import Any, Optional
 from types import FunctionType
 import itertools
@@ -13,14 +13,13 @@ def shallow_copy_function(func: Any) -> FunctionType:
     attributes defined on the function.
 
     """
-    ret = FunctionType(
+    return FunctionType(
         func.__code__,
         func.__globals__,
         name=func.__name__,
         argdefs=getattr(func, "__defaults__", None),
         closure=getattr(func, "__closure__", None),
     )
-    return ret
 
 
 class ScopeableMatcherTransformer(m.MatcherDecoratableTransformer):

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,16 +4,17 @@ 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",
-    "-v",
+    "-V",
     "--verbose",
     count=True,
     default=0,
@@ -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

@@ -8,8 +8,8 @@ from pathlib import Path
 from typing import List, Tuple, Union
 
 import rich_click as click
-import stubber.basicgit as git
-from loguru import logger as log
+import mpflash.basicgit as git
+from mpflash.logger import log
 from stubber.utils.config import CONFIG
 
 from .cli import stubber_cli
@@ -27,6 +27,7 @@ from .cli import stubber_cli
     type=click.Path(file_okay=False, dir_okay=True),
 )
 @click.option(
+    "--stubs/--no-stubs",
     "--add-stubs/--no-stubs",
     "stubs",
     default=False,

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,9 +7,9 @@ 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 stubber.basicgit as git
+import mpflash.basicgit as git
 import stubber.utils as utils
 from stubber.stubs_from_docs import generate_from_rst
 from stubber.utils.config import CONFIG
@@ -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",
@@ -31,7 +34,7 @@ from .cli import stubber_cli
 @click.option(
     "--version",
     "--Version",
-    "-V",
+    "-v",
     "version",
     default="",
     # default=[CONFIG.stable_version],

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,10 +19,13 @@ 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",
+    # "-v",
     type=click.Choice(["Full", "Mem", "DB"], case_sensitive=False),
     default="DB",
     show_default=True,
@@ -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
@@ -18,8 +18,7 @@ from .cli import stubber_cli
 @click.option("--family", default="micropython", type=str, show_default=True)
 @click.option(
     "--version",
-    "--Version",
-    "-V",
+    "-v",
     "versions",
     multiple=True,
     default=["all"],

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
@@ -18,8 +18,7 @@ from stubber.utils.config import CONFIG
 @click.option("--family", default="micropython", type=str, show_default=True)
 @click.option(
     "--version",
-    "--Version",
-    "-V",
+    "-v",
     "versions",
     multiple=True,
     default=[CONFIG.stable_version],

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/switch_cmd.py

@@ -7,10 +7,10 @@ from typing import Optional, Union
 
 import rich_click as click
 
-import stubber.basicgit as git
+import mpflash.basicgit as git
 from stubber.utils.config import CONFIG
 from stubber.utils.repos import fetch_repos, repo_paths
-from stubber.utils.versions import SET_PREVIEW, V_PREVIEW
+from mpflash.versions import SET_PREVIEW, V_PREVIEW
 
 from .cli import stubber_cli
 

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
@@ -13,8 +13,7 @@ from .cli import stubber_cli
 
 @click.option(
     "--version",
-    "--Version",
-    "-V",
+    "-v",
     "version",
     default=CONFIG.stable_version,
     show_default=True,

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)