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

mpflash/mpflash/mpboard_id/add_boards.py

@@ -12,11 +12,11 @@ import rich.table
 from rich.console import Console
 from rich.progress import track
 
-import mpflash.vendor.basicgit as git
+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.vendor.versions import micropython_versions
+from mpflash.versions import micropython_versions
 
 # look for all mpconfigboard.h files and extract the board name
 # from the #define MICROPY_HW_BOARD_NAME "PYBD_SF6"
@@ -222,11 +222,7 @@ 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/mpflash/mpboard_id/board_id.py

@@ -9,7 +9,7 @@ from typing import Optional
 from mpflash.errors import MPFlashError
 from mpflash.logger import log
 from mpflash.mpboard_id.store import read_known_boardinfo
-from mpflash.vendor.versions import clean_version, get_stable_mp_version
+from mpflash.versions import clean_version, get_stable_mp_version
 
 
 def find_board_id_by_description(

mpflash/mpflash/mpremoteboard/__init__.py

@@ -29,7 +29,7 @@ RETRIES = 3
 class MPRemoteBoard:
     """Class to run mpremote commands"""
 
-    def __init__(self, serialport: str = "", update: bool = False):
+    def __init__(self, serialport: str = "", update: bool = False, *, location: str = ""):
         """
         Initialize MPRemoteBoard object.
 
@@ -37,7 +37,7 @@ class MPRemoteBoard:
         - serialport (str): The serial port to connect to. Default is an empty string.
         - update (bool): Whether to update the MCU information. Default is False.
         """
-        self.serialport = serialport
+        self.serialport: str = serialport
         self.firmware = {}
 
         self.connected = False
@@ -51,6 +51,7 @@ class MPRemoteBoard:
         self.arch = ""
         self.mpy = ""
         self.build = ""
+        self.location = location
         if update:
             self.get_mcu_info()
 
@@ -207,11 +208,11 @@ class MPRemoteBoard:
         """wait for the board to restart"""
         for _ in track(
             range(timeout),
-            description="Waiting for the board to restart",
+            description=f"Waiting for the board to restart ({timeout}s)",
             transient=True,
-            get_time=lambda: time.time(),
             show_speed=False,
             refresh_per_second=1,
+            total=timeout,
         ):
             time.sleep(1)
             try:

{stubber/utils → mpflash/mpflash}/versions.py

@@ -1,14 +1,17 @@
-"""Handle versions of micropython based on the git tags in the repo """
+"""
+#############################################################
+# Version handling copied from stubber/utils/versions.py
+#############################################################
+"""
 
-from functools import lru_cache
 from pathlib import Path
 
-from github import Github
+from cache_to_disk import NoCacheCondition, cache_to_disk
 from loguru import logger as log
 from packaging.version import parse
 
-import stubber.basicgit as git
-import stubber.utils as utils
+import mpflash.basicgit as git
+from mpflash.common import GH_CLIENT
 
 OLDEST_VERSION = "1.16"
 "This is the oldest MicroPython version to build the stubs on"
@@ -27,7 +30,7 @@ def clean_version(
     commit: bool = False,
     drop_v: bool = False,
     flat: bool = False,
-):
+):  # sourcery skip: assign-if-exp
     "Clean up and transform the many flavours of versions"
     # 'v1.13.0-103-gb137d064e' --> 'v1.13-103'
     if version in {"", "-"}:
@@ -48,14 +51,12 @@ def clean_version(
     if len(nibbles) == 1:
         version = nibbles[0]
     elif build and not is_preview:
+        # HACK: this is not always right, but good enough most of the time
         version = "-".join(nibbles) if commit else "-".join(nibbles[:-1])
+    elif is_preview:
+        version = "-".join((nibbles[0], V_PREVIEW))
     else:
-        # version = "-".join((nibbles[0], LATEST))
-        # HACK: this is not always right, but good enough most of the time
-        if is_preview:
-            version = "-".join((nibbles[0], V_PREVIEW))
-        else:
-            version = V_PREVIEW
+        version = V_PREVIEW
     if flat:
         version = version.strip().replace(".", "_").replace("-", "_")
     else:
@@ -70,20 +71,12 @@ def clean_version(
     return version
 
 
-@lru_cache(maxsize=10)
-def checkedout_version(path: Path, flat: bool = False) -> str:
-    """Get the checked-out version of the repo"""
-    version = git.get_local_tag(path.as_posix())
-    if not version:
-        raise ValueError("No valid Tag found")
-    version = utils.clean_version(version, flat=flat, drop_v=False)
-    return version
-
-
+@cache_to_disk(n_days_to_cache=1)
 def micropython_versions(minver: str = "v1.20", reverse: bool = False):
     """Get the list of micropython versions from github tags"""
+    cache_it = True
     try:
-        gh_client = Github()
+        gh_client = GH_CLIENT
         repo = gh_client.get_repo("micropython/micropython")
         versions = [tag.name for tag in repo.get_tags() if parse(tag.name) >= parse(minver)]
         # Only keep the last preview
@@ -109,10 +102,15 @@ def micropython_versions(minver: str = "v1.20", reverse: bool = False):
             "v1.11",
             "v1.10",
         ]
+        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]
-    return sorted(versions, reverse=reverse)
+    versions = sorted(versions, reverse=reverse)
+    if cache_it:
+        return versions
+    # returns - but does not cache
+    raise NoCacheCondition(function_value=versions)
 
 
 def get_stable_mp_version() -> str:
@@ -126,3 +124,12 @@ def get_preview_mp_version() -> str:
     all_versions = micropython_versions(minver=OLDEST_VERSION)
     return [v for v in all_versions if v.endswith(V_PREVIEW)][-1]
 
+
+# Do not cache , same path will have different versions checked out
+def checkedout_version(path: Path, flat: bool = False) -> str:
+    """Get the checked-out version of the repo"""
+    version = git.get_local_tag(path.as_posix())
+    if not version:
+        raise ValueError("No valid Tag found")
+    version = clean_version(version, flat=flat, drop_v=False)
+    return version

mpflash/poetry.lock

@@ -1,4 +1,4 @@
-# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand.
+# This file is automatically @generated by Poetry 1.8.2 and should not be changed by hand.
 
 [[package]]
 name = "ansicon"
@@ -249,6 +249,17 @@ files = [
     {file = "blkinfo-0.2.0.tar.gz", hash = "sha256:322a906595f78832d6725ac74a0b9fd2794df3388584d9f05c1a2f8e19324851"},
 ]
 
+[[package]]
+name = "cache-to-disk"
+version = "2.0.0"
+description = "Local disk caching decorator for python function."
+optional = false
+python-versions = "*"
+files = [
+    {file = "cache_to_disk-2.0.0-py3-none-any.whl", hash = "sha256:ea5afe13d4284cb4a06169b0807fbc60547cbe19c54563bf90e1d44f24029481"},
+    {file = "cache_to_disk-2.0.0.tar.gz", hash = "sha256:79e19ea9b72eedc5cec83bb8aa55374afc671493e7d13d541f3b63eb3a13fb32"},
+]
+
 [[package]]
 name = "cachetools"
 version = "5.3.3"
@@ -1452,13 +1463,13 @@ test = ["codecov", "coverage", "mypy", "nptyping (>=1.3.0)", "numpy", "pycodesty
 
 [[package]]
 name = "urllib3"
-version = "2.2.1"
+version = "2.2.2"
 description = "HTTP library with thread-safe connection pooling, file post, and more."
 optional = false
 python-versions = ">=3.8"
 files = [
-    {file = "urllib3-2.2.1-py3-none-any.whl", hash = "sha256:450b20ec296a467077128bff42b73080516e71b56ff59a60a02bef2232c4fa9d"},
-    {file = "urllib3-2.2.1.tar.gz", hash = "sha256:d0570876c61ab9e520d776c38acbbb5b05a776d3f9ff98a5c8fd5162a444cf19"},
+    {file = "urllib3-2.2.2-py3-none-any.whl", hash = "sha256:a448b2f64d686155468037e1ace9f2d2199776e17f0a46610480d311f73e3472"},
+    {file = "urllib3-2.2.2.tar.gz", hash = "sha256:dd505485549a7a552833da5e6063639d0d177c04f23bc3864e41e5dc5f612168"},
 ]
 
 [package.extras]
@@ -1585,4 +1596,4 @@ files = [
 [metadata]
 lock-version = "2.0"
 python-versions = ">=3.8.1,<4.0"
-content-hash = "ec512f96331465adf386ce2606d8f8fdca4523a862ed61ce4487d103e84e0d43"
+content-hash = "e0f5697e08c8c691e538c586c7a478cdc93de23d56435373b56abdd2147bda87"

mpflash/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mpflash"
-version = "0.8.7"
+version = "0.9.1.Post2"
 description = "Flash and download tool for MicroPython firmwares"
 authors = ["Jos Verlinde <jos_verlinde@hotmail.com>"]
 license = "MIT"
@@ -26,20 +26,25 @@ esptool = "^4.7.0"
 inquirer = "^3.2.4"
 jsonlines = "^4.0.0"
 jsons = "^1.6.3"
-libusb = {version = "^1.0.27", platform = "win32"}
+libusb = { version = "^1.0.27", platform = "win32" }
 loguru = "^0.7.2"
 mpremote = "^1.22.0"
 packaging = "23.2"
 platformdirs = "^4.2.0"
 psutil = "^5.9.8"
 pygithub = "^2.1.1"
-python =  ">=3.8.1,<4.0"
+python = ">=3.8.1,<4.0"
 pyusb = "^1.2.1"
 requests = "^2.31.0"
 rich-click = "^1.8.1"
 tenacity = "8.2.3"
+cache-to-disk = "^2.0.0"
 
 
+[tool.poetry.group.dev]
+optional = true
+[tool.poetry.group.dev.dependencies]
+
 [tool.poetry.group.test]
 optional = true
 [tool.poetry.group.test.dependencies]

stubber/__init__.py

@@ -1,3 +1,3 @@
 """get the version"""
 
-__version__ = "1.20.6"
+__version__ = "1.23.1"

stubber/board/createstubs.py

@@ -24,7 +24,7 @@ try:
 except ImportError:
     from ucollections import OrderedDict  # type: ignore
 
-__version__ = "v1.20.6"
+__version__ = "v1.23.1"
 ENOENT = 2
 _MAX_CLASS_LEVEL = 2  # Max class nesting
 LIBS = ["lib", "/lib", "/sd/lib", "/flash/lib", "."]
@@ -488,7 +488,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 ""
@@ -595,10 +595,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.20.6 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.20.6 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.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.20.6
+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.20.6"
+__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.20.6 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.20.6 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.20.6'
+__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.20.6
+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.20.6"
+__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.20.6 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.20.6 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.20.6'
+__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.20.6'
+__version__='v1.23.1'
 A0=2
 A1=2
 A5=['lib','/lib','/sd/lib','/flash/lib',J]

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

@@ -2,7 +2,7 @@
 
 from typing import List, Union
 
-import click
+import rich_click as click
 from loguru import logger as log
 from tabulate import tabulate
 

stubber/commands/cli.py

@@ -1,9 +1,10 @@
 """
 command line interface - main group
 """
+
 import sys
 
-import click
+import rich_click as click
 from loguru import logger as log
 from stubber import __version__
 
@@ -11,11 +12,12 @@ from stubber import __version__
 @click.group(chain=True)
 @click.version_option(package_name="micropython-stubber", prog_name="micropython-stubber✏️ ")
 @click.option(
-    "-v",
+    "-V",
+    "-V",
     "--verbose",
     count=True,
     default=0,
-    help="-v for DEBUG, -v -v for TRACE",
+    help="-V for DEBUG, -VV for TRACE",
     is_eager=True,
 )
 @click.pass_context
@@ -46,6 +48,8 @@ def set_loglevel(verbose: int) -> str:
     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)
+    log.add(
+        sys.stderr, level=level, backtrace=True, diagnose=True, colorize=True, format=format_str
+    )
     log.info(f"micropython-stubber {__version__}")
     return level

stubber/commands/clone_cmd.py

@@ -7,8 +7,8 @@ import os
 from pathlib import Path
 from typing import List, Tuple, Union
 
-import click
-import stubber.basicgit as git
+import rich_click as click
+import mpflash.basicgit as git
 from loguru import logger as log
 from stubber.utils.config import CONFIG
 
@@ -20,8 +20,20 @@ from .cli import stubber_cli
 
 
 @stubber_cli.command(name="clone")
-@click.option("--path", "-p", default=CONFIG.repo_path.as_posix(), type=click.Path(file_okay=False, dir_okay=True))
-@click.option("--add-stubs/--no-stubs", "stubs", default=False, is_flag=True, help="Also clone the micropython-stubs repo")
+@click.option(
+    "--path",
+    "-p",
+    default=CONFIG.repo_path.as_posix(),
+    type=click.Path(file_okay=False, dir_okay=True),
+)
+@click.option(
+    "--stubs/--no-stubs",
+    "--add-stubs/--no-stubs",
+    "stubs",
+    default=False,
+    is_flag=True,
+    help="Also clone the micropython-stubs repo",
+)
 def cli_clone(path: Union[str, Path], stubs: bool = False):
     """
     Clone/fetch the micropython repos locally.

stubber/commands/enrich_folder_cmd.py

@@ -1,10 +1,11 @@
 """
 enrich machinestubs with docstubs
 """
+
 from pathlib import Path
 from typing import Union
 
-import click
+import rich_click as click
 from loguru import logger as log
 
 from stubber.codemod.enrich import enrich_folder

stubber/commands/get_core_cmd.py

@@ -7,7 +7,7 @@
 from pathlib import Path
 from typing import List
 
-import click
+import rich_click as click
 from loguru import logger as log
 
 import stubber.get_cpython as get_cpython
@@ -54,14 +54,16 @@ def cli_get_core(
     """
     # default parameter values
     stub_folder = stub_folder or CONFIG.stub_path.as_posix()
-    
+
     stub_paths: List[Path] = []
     for core_type in ["pycopy", "micropython"]:
         log.info(f"::group:: Get Cpython core :{core_type}")
         req_filename = f"requirements-core-{core_type}.txt"
         stub_path = Path(stub_folder) / f"cpython_core-{core_type}"
 
-        get_cpython.get_core(stub_path=stub_path.as_posix(), requirements=req_filename, family=core_type)
+        get_cpython.get_core(
+            stub_path=stub_path.as_posix(), requirements=req_filename, family=core_type
+        )
         stub_paths.append(stub_path)
 
     log.info("::group:: start post processing of retrieved stubs")

stubber/commands/get_docstubs_cmd.py

@@ -6,10 +6,10 @@ get-docstubs
 from pathlib import Path
 from typing import Optional
 
-import click
+import rich_click as click
 from loguru import logger as 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
@@ -40,13 +40,15 @@ from .cli import stubber_cli
     show_default=True,
 )
 #  @click.option("--family", "-f", "basename", default="micropython", help="Micropython family.", show_default=True)
-@click.option("--version", "--tag", default="", type=str, help="Version number to use. [default: Git tag]")
+@click.option(
+    "--version", "--tag", default="", type=str, help="Version number to use. [default: Git tag]"
+)
 @click.option("--black/--no-black", "-b/-nb", default=True, help="Run black", show_default=True)
 @click.pass_context
 def cli_docstubs(
     ctx: click.Context,
     path: Optional[str] = None,
-    target:Optional[str] = None,
+    target: Optional[str] = None,
     black: bool = True,
     basename: Optional[str] = None,
     version: str = "",

stubber/commands/get_frozen_cmd.py

@@ -6,7 +6,7 @@
 from pathlib import Path
 from typing import List, Optional
 
-import click
+import rich_click as click
 from loguru import logger as log
 
 import stubber.utils as utils
@@ -31,7 +31,7 @@ from .cli import stubber_cli
 @click.option(
     "--version",
     "--Version",
-    "-V",
+    "-v",
     "version",
     default="",
     # default=[CONFIG.stable_version],
@@ -85,7 +85,9 @@ def cli_get_frozen(
     version = utils.checkedout_version(CONFIG.mpy_path)
     log.info("MicroPython version : {}".format(version))
 
-    stub_path = freeze_any(version=version, mpy_path=CONFIG.mpy_path, mpy_lib_path=CONFIG.mpy_lib_path)
+    stub_path = freeze_any(
+        version=version, mpy_path=CONFIG.mpy_path, mpy_lib_path=CONFIG.mpy_lib_path
+    )
     stub_paths.append(stub_path)
     # Also enrich the frozen modules from the doc stubs if available