micropython-stubber 1.25.0.post2__tar.gz → 1.25.1rc6__tar.gz

{micropython_stubber-1.25.0.post2 → micropython_stubber-1.25.1rc6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: micropython-stubber
-Version: 1.25.0.post2
+Version: 1.25.1rc6
 Summary: Tooling to create and maintain stubs for MicroPython
 License: MIT
 Keywords: MicroPython,stubs,vscode,pyright,linting,static type check
@@ -25,12 +25,12 @@ Requires-Dist: executing (>=2.0.1,<3.0.0)
 Requires-Dist: importlib-metadata (>=1,<9) ; python_version < "3.8"
 Requires-Dist: libcst (>=1.1.0,<2.0.0)
 Requires-Dist: loguru (>=0.6,<0.8)
-Requires-Dist: mpflash (>=1.25.0)
+Requires-Dist: mpflash (==1.25.0.rc3)
 Requires-Dist: mpremote (>=1.25.0)
+Requires-Dist: mpy-cross (>=1.25.0.post2,<2.0.0)
 Requires-Dist: mypy (>=1.10)
 Requires-Dist: mypy-gitlab-code-quality (>=1.1.0,<2.0.0)
 Requires-Dist: packaging (>=24.2,<25.0)
-Requires-Dist: pipx (>=1.1.0,<2.0.0)
 Requires-Dist: poetry (>=2.0.1,<3.0.0)
 Requires-Dist: pydeps (==3.0.1)
 Requires-Dist: pygithub (>=2.1.1,<3.0.0)

{micropython_stubber-1.25.0.post2 → micropython_stubber-1.25.1rc6}/pyproject.toml

@@ -8,7 +8,7 @@ repo-path = "./repos"
 
 [tool.poetry]
 name = "micropython-stubber"
-version = "1.25.0.post2"
+version = "1.25.1.rc6"
 description = "Tooling to create and maintain stubs for MicroPython"
 authors = ["Jos Verlinde <jos_verlinde@hotmail.com>"]
 license = "MIT"
@@ -50,7 +50,7 @@ mpremote = "mpremote.main:main"
 python = ">=3.9.2,<4.0"
 python-minifier = { version = "^2.7.0", python = "<3.14" }
 requests = "^2.32.3"
-mpflash = ">=1.25.0"
+mpflash = "==1.25.0.rc3"
 mpremote = ">=1.25.0"
 # others
 autoflake = ">=1.7,<3.0"
@@ -63,7 +63,6 @@ importlib-metadata = { version = ">=1,<9", python = "<3.8" }
 loguru = ">=0.6,<0.8"
 mypy-gitlab-code-quality = "^1.1.0"
 packaging = "^24.2"
-pipx = "^1.1.0"
 pygithub = "^2.1.1"
 pyserial = ">=3.5"
 pypi-simple = "^1.0.0"
@@ -77,6 +76,7 @@ poetry = "^2.0.1"
 pydeps = "3.0.1"
 pyright = ">=1.1.341"
 mypy = ">=1.10"
+mpy-cross = "^1.25.0.post2"
 
 
 [tool.poetry.group.docs]

{micropython_stubber-1.25.0.post2 → micropython_stubber-1.25.1rc6}/src/stubber/codemod/visitors/type_helpers.py

@@ -47,13 +47,22 @@ def is_CONSTANT(statement):
     AnnAssign-  FOO:bool = ...
     """
 
-    if m.matches(statement, m.SimpleStatementLine()):
-        statement = statement.body[0]
-    if m.matches(statement, m.Assign()):
-        if len(statement.targets) != 1:
-            return False
-        if statement.targets[0].target.value.isupper():
-            return True
+    try:
+        if m.matches(statement, m.SimpleStatementLine()):
+            statement = statement.body[0]
+        if m.matches(statement, m.Assign()):
+            if len(statement.targets) != 1:
+                return False
+            if m.matches(statement.targets[0], m.Name()):
+                if statement.targets[0].target.value.isupper(): 
+                    return True
+            elif m.matches(statement.targets[0], m.AssignTarget()):
+                if m.matches(statement.targets[0].target, m.Name()):
+                    if statement.targets[0].children[0].value.isupper():
+                        return True
+    except Exception as e:
+        log.debug(f"Error in is_CONSTANT: {e}")
+        return False
     return False
 
 

{micropython_stubber-1.25.0.post2 → micropython_stubber-1.25.1rc6}/src/stubber/minify.py

@@ -5,6 +5,7 @@ Minimizes and cross-compiles a MicroPyton file.
 
 import itertools
 import subprocess
+import sys
 import tempfile
 from contextlib import ExitStack
 from io import BytesIO, IOBase, StringIO, TextIOWrapper
@@ -18,6 +19,8 @@ except ImportError:
 
 from mpflash.logger import log
 from mpflash.versions import SET_PREVIEW, V_PREVIEW
+import shutil
+import os
 
 # Type Aliases for minify
 StubSource = Union[Path, str, StringIO, TextIOWrapper]
@@ -369,10 +372,10 @@ def cross_compile(
     else:
         # target must be a Path object
         _target = get_temp_file(suffix=".mpy")
-    result = pipx_mpy_cross(version, source_file, _target)
+    result = run_mpy_cross(version, source_file, _target)
     if result.stderr and "No matching distribution found for mpy-cross~=" in result.stderr:
         log.warning(f"mpy-cross~={version} not found, using most current version.")
-        result = pipx_mpy_cross(V_PREVIEW, source_file, _target)
+        result = run_mpy_cross(V_PREVIEW, source_file, _target)
 
     if result.returncode == 0:
         log.debug(f"mpy-cross compiled to    : {_target.name}")
@@ -388,18 +391,36 @@ def cross_compile(
     return result.returncode
 
 
-def pipx_mpy_cross(version: str, source_file, _target):
-    """Run mpy-cross using pipx"""
-
+def locate_mpy_cross():
+    """Locate the path of the mpy-cross commandline tool in the active environment"""
+    try:
+        # Check if it's available as a command in PATH
+        mpy_cross_path = shutil.which("mpy-cross")
+        if mpy_cross_path:
+            log.info(f"Found mpy-cross executable in PATH: {mpy_cross_path}")
+            return mpy_cross_path
+        
+        # Check in the Scripts/bin directory of the current Python environment
+        bin_dir = "Scripts" if sys.platform == "win32" else "bin"
+        env_path = os.path.join(os.path.dirname(sys.executable), bin_dir, "mpy-cross")
+        if os.path.exists(env_path):
+            log.info(f"Found mpy-cross executable in Python environment: {env_path}")
+            return env_path
+        raise FileNotFoundError("mpy-cross executable not found in PATH or Python environment")
+    except Exception as e:
+        log.debug(f"Error locating mpy-cross: {e}")
+        raise FileNotFoundError("mpy-cross executable not found in PATH or Python environment") from e
+
+def run_mpy_cross(version: str, source_file, _target):
+    """Run mpy-cross using --compat if needed"""
     log.info(f"Compiling with mpy-cross version: {version}")
     if version in SET_PREVIEW:
         version = ""
     if version:
-        version = "~=" + version.lstrip("v")
+        version = version.lstrip("v")
+    compat =  ["--compat", version] if version else []
 
-    cmd = ["pipx", "run", f"mpy-cross{version}"] if version else ["pipx", "run", "mpy-cross"]
-    # Add params
-    cmd += ["-O2", str(source_file), "-o", str(_target), "-s", "createstubs.py"]
+    cmd = [locate_mpy_cross() ] + compat + ["-O2", str(source_file), "-o", str(_target), "-s", "createstubs.py"]
     log.trace(" ".join(cmd))
     result = subprocess.run(
         cmd, capture_output=True, text=True, encoding="utf-8"

{micropython_stubber-1.25.0.post2 → micropython_stubber-1.25.1rc6}/src/stubber/publish/package.py

@@ -56,6 +56,15 @@ def get_package(
             version=version,
             json_data=package_info,
         )
+        # TODO @Josverl: Check or update stub_sources in len < 3
+        EXPECTED_STUBS = 3
+        if len(p_db.stub_sources) < EXPECTED_STUBS:
+            log.warning(f"Package {pkg_name} has less than 3 stub sources, updating...")
+            stub_sources = combo_sources(family, port, board, clean_version(p_db.mpy_version, flat=True))
+            if len(stub_sources) >= EXPECTED_STUBS:
+                p_db.stub_sources = stub_sources
+                p_db.update_sources()
+                log.info(f"Updated stub sources for {pkg_name} to {p_db.stub_sources}")
         return p_db
 
     log.debug(f"No package found for {pkg_name} in database, creating new package")
@@ -115,13 +124,13 @@ def create_package(
     create and initialize a package with the correct sources
     """
     ver_flat = clean_version(mpy_version, flat=True)
-    stubs: StubSources = []
+    stub_sources: StubSources = []
     # if pkg_type != COMBO_STUBS:
     #     raise ValueError("Not Supported")
 
     assert port != "", "port must be specified for combo stubs"
-    stubs = combo_sources(family, port, board, ver_flat)
-    return StubPackage(pkg_name, port=port, board=board, version=mpy_version, stubs=stubs)
+    stub_sources = combo_sources(family, port, board, ver_flat)
+    return StubPackage(pkg_name, port=port, board=board, version=mpy_version, stub_sources=stub_sources)
 
 
 def combo_sources(family: str, port: str, board: str, ver_flat: str) -> StubSources:

{micropython_stubber-1.25.0.post2 → micropython_stubber-1.25.1rc6}/src/stubber/publish/stubpackage.py

@@ -210,7 +210,7 @@ class Builder(VersionedPackage):
         board: str = GENERIC_U,
         variant: Optional[str] = None,
         description: str = "MicroPython stubs",
-        stubs: Optional[StubSources] = None,
+        stub_sources: Optional[StubSources] = None,
         # json_data: Optional[Dict[str, Any]] = None,
     ):  #  port: str, board: str
         super().__init__(package_name=package_name, mpy_version=mpy_version)
@@ -221,7 +221,7 @@ class Builder(VersionedPackage):
         self.board = board
         self.variant = variant or ""
         self.description = description
-        self.stub_sources = stubs or []
+        self.stub_sources = stub_sources or []
         self.hash = None  # intial hash
         """Hash of all the files in the package"""
         self.stub_hash = None  # intial hash
@@ -323,7 +323,7 @@ class Builder(VersionedPackage):
             for n in range(len(self.stub_sources)):
                 stub_type, src_path = self.stub_sources[n]
                 try:
-                    log.debug(f"Copying {stub_type} from {src_path}")
+                    log.debug(f"Copy {stub_type:<20} from {src_path}")
                     self.copy_folder(stub_type, src_path)
                 except OSError as e:
                     if stub_type != StubSource.FROZEN:
@@ -587,7 +587,7 @@ class PoetryBuilder(Builder):
         mpy_version: str = "0.0.1",
         board: str = GENERIC_U,
         description: str = "MicroPython stubs",
-        stubs: Optional[StubSources] = None,
+        stub_sources: Optional[StubSources] = None,
         json_data: Optional[Dict[str, Any]] = None,
     ):
         super().__init__(
@@ -596,7 +596,7 @@ class PoetryBuilder(Builder):
             port=port,
             board=board,
             description=description,
-            stubs=stubs,
+            stub_sources=stub_sources,
         )
 
     # -----------------------------------------------
@@ -799,7 +799,7 @@ class StubPackage(PoetryBuilder):
         board: str = GENERIC_U,
         version: str = "0.0.1",
         description: str = "MicroPython stubs",
-        stubs: Optional[StubSources] = None,
+        stub_sources: Optional[StubSources] = None,
         json_data: Optional[Dict[str, Any]] = None,
     ):
         """
@@ -826,7 +826,7 @@ class StubPackage(PoetryBuilder):
             port=port,
             board=board,
             description=description,
-            stubs=stubs or [],
+            stub_sources=stub_sources or [],
         )
         self.port = port
         self.board = board
@@ -840,11 +840,6 @@ class StubPackage(PoetryBuilder):
 
             self.create_update_pyproject_toml()
 
-            # self.stub_sources: StubSources = []
-            # # save the stub sources
-            # if stubs:
-            #     self.stub_sources = stubs
-
         self.status: Status = Status(
             {
                 "result": "-",

{micropython_stubber-1.25.0.post2 → micropython_stubber-1.25.1rc6}/src/stubber/rst/lookup.py

@@ -445,6 +445,12 @@ PARAM_FIXES = [
         "(ip, subnet, gateway, dns):Optional[Any]=None",
         "configtuple: Optional[Tuple]",
     ),
+    # network.ipconfig
+    Fix(
+        "param=value",
+        "param:Optional[str]=None",
+        name="ipconfig",
+    ),
     # framebuffer
     # unresolvable parameter defaults # FrameBuffer: def __init__
     Fix(

{micropython_stubber-1.25.0.post2 → micropython_stubber-1.25.1rc6}/src/stubber/rst/reader.py

@@ -69,10 +69,19 @@ from typing import List, Optional, Tuple
 
 from mpflash.logger import log
 from mpflash.versions import V_PREVIEW
-from stubber.rst import (CHILD_PARENT_CLASS, MODULE_GLUE, PARAM_FIXES,
-                         PARAM_RE_FIXES, RST_DOC_FIXES, TYPING_IMPORT,
-                         ClassSourceDict, FunctionSourceDict, ModuleSourceDict,
-                         return_type_from_context)
+
+from stubber.rst import (
+    CHILD_PARENT_CLASS,
+    MODULE_GLUE,
+    PARAM_FIXES,
+    PARAM_RE_FIXES,
+    RST_DOC_FIXES,
+    TYPING_IMPORT,
+    ClassSourceDict,
+    FunctionSourceDict,
+    ModuleSourceDict,
+    return_type_from_context,
+)
 from stubber.rst.lookup import Fix
 from stubber.utils.config import CONFIG
 
@@ -496,8 +505,8 @@ class RSTParser(RSTReader):
                 self.read_file(file_path)
                 self.parse()
         # reset this file to done
-        self.rst_text = []
-        self.line_no = 1
+        # self.rst_text = []
+        # self.line_no = 1
 
     def parse_module(self):
         "parse a module tag and set the module's docstring"

{micropython_stubber-1.25.0.post2 → micropython_stubber-1.25.1rc6}/src/stubber/stubs_from_docs.py

@@ -78,23 +78,11 @@ def get_rst_sources(rst_path: Path, pattern: str) -> List[Path]:
 def make_docstubs(
     dst_path: Path, v_tag: str, release: str, suffix: str, files: List[Path], clean_rst: bool
 ):
-    """Create the docstubs"""
+    """Create docstubs from the list of rst files"""
 
     for file in files:
-        reader = RSTWriter(v_tag)
-        reader.clean_rst = clean_rst
-        reader.source_release = release
-        log.debug(f"Reading: {file}")
-        reader.read_file(file)
-        reader.parse()
-        # Destination = "module.__init__.pyi"
-        if "." in file.stem:
-            target = dst_path / f"{(file.stem).replace('.', '/')}{suffix}"
-        else:
-            target = dst_path / file.stem / f"__init__{suffix}"
-        # fname = (dst_path / file.name).with_suffix(suffix)
-        reader.write_file(target)
-        del reader
+        make_docstub(file, dst_path, v_tag, release, suffix, clean_rst)
+
     for name in U_MODULES:
         # create a file "umodule.pyi" for each module
         # and add a line : from module import *
@@ -107,3 +95,28 @@ def make_docstubs(
             f.write("# Allow the use of micro-module notation \n\n")
             f.write(f"from {name} import *  # type: ignore\n")
             f.flush()
+
+
+def make_docstub(
+    file: Path,
+    dst_path: Path,
+    v_tag: str,
+    release: str,
+    suffix: str,
+    clean_rst: bool,
+):
+    """Create a docstub from a single rst file"""
+    reader = RSTWriter(v_tag)
+    reader.clean_rst = clean_rst
+    reader.source_release = release
+    log.debug(f"Reading: {file}")
+    reader.read_file(file)
+    reader.parse()
+
+    if "." in file.stem:
+        target = dst_path / f"{(file.stem).replace('.', '/')}{suffix}"
+    else:
+        target = dst_path / file.stem / f"__init__{suffix}"
+
+    reader.write_file(target)
+    del reader