micropython-stubber 1.24.0__py3-none-any.whl → 1.24.1__py3-none-any.whl

{micropython_stubber-1.24.0.dist-info → micropython_stubber-1.24.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: micropython-stubber
-Version: 1.24.0
+Version: 1.24.1
 Summary: Tooling to create and maintain stubs for MicroPython
 License: MIT
 Keywords: MicroPython,stubs,vscode,pyright,linting,static type check

{micropython_stubber-1.24.0.dist-info → micropython_stubber-1.24.1.dist-info}/RECORD

@@ -21,7 +21,7 @@ mpflash/mpflash/download.py,sha256=wE4uBSFFMAKOBH4jwHweL0wVYh4vi74t1673ku_IeoA,1
 mpflash/mpflash/downloaded.py,sha256=nxTWU4lvhcthqvVmzpYHnXCnjD8wJv0KFq2KtaoTO1A,5160
 mpflash/mpflash/errors.py,sha256=IAidY3qkZsXy6Pm1rdmVFmGyg81ywHhse3itaPctA2w,247
 mpflash/mpflash/flash/__init__.py,sha256=g4Fp8MiquaDZXIvRJwYRkkll1MMyRud7x6qmwCk9Lgo,2096
-mpflash/mpflash/flash/esp.py,sha256=_VfbyYIEaUgAjsD66tjbdgYL6ElkSAfpIMKz6q4QKig,2287
+mpflash/mpflash/flash/esp.py,sha256=CRF8sfIyuDZoYC1luBy92zLm6Qz3dnBBWjuJ3A4_crE,2284
 mpflash/mpflash/flash/stm32.py,sha256=dqp9BZ4Vr-6GlQcF12TSmRf-5TXkov9qvCpMgeUJc7Y,574
 mpflash/mpflash/flash/stm32_dfu.py,sha256=W-3JsRQyf3DduoIRXDmGZ35RogqtjQgcJnk-GOtQoLE,3090
 mpflash/mpflash/flash/uf2/__init__.py,sha256=ucTg1pg7TruwPjecCPWYRpCwWPz-rngv7UYaQ_bMzww,2854
@@ -82,11 +82,11 @@ stubber/codemod/add_comment.py,sha256=CZMjtKO9aarZo1E60QXo80CLJAH05z_ylK6Vvjvb0l
 stubber/codemod/add_method.py,sha256=fZH-RGi_pzFpi3tF_0AMDbA9A94dlgXMrc3ItpY3Ylw,2609
 stubber/codemod/board.py,sha256=HDNS8saQIdoPH74MNG9mte0MRBqCOcy3d6f_I0H9J2I,11881
 stubber/codemod/enrich.py,sha256=mrnhPLgjYQZvxaeMPAcZ_459-XC5rw_SAKsFxLtlMYo,12788
-stubber/codemod/merge_docstub.py,sha256=HapJGu4UMYe8SiO5qHxgfOsXYw7caATRgvsJwgX9Fag,22057
+stubber/codemod/merge_docstub.py,sha256=fgi0PVRhN9gGzcOfCUW0ni-C54oGYUKwc5Yk2FsCS3U,22081
 stubber/codemod/modify_list.py,sha256=xrpFBKug273D9E02owUheZD418BvsIHIZCFj4YDjTxU,2118
 stubber/codemod/test_enrich.py,sha256=ckJtwo4PsXckcnZGk_2gxRRLQkfKI650pVmdByw_pVo,2820
 stubber/codemod/utils.py,sha256=3hk7pwyS4KZxewrWLwbOrdA5ympbum-kfL0ZN-M7rlo,2459
-stubber/codemod/visitors/typevars.py,sha256=ZLLp6Fyw8jx56Uhhx1sunpUPasN8tJoaCFCugvU7z6c,7448
+stubber/codemod/visitors/type_helpers.py,sha256=FBV6wwPtBiWwZTqEpdhVw-Jghi-gxyMVZE4SyGn7uRU,6812
 stubber/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 stubber/commands/build_cmd.py,sha256=Zseci4EHxJuiiy7YS-ucmMokDrVLe4j6fPs-PSbwq1k,2813
 stubber/commands/cli.py,sha256=HY4CqB0PPTmzew2sABNsHeNKDPblcGzzbmvtF46oVsU,1556
@@ -154,8 +154,8 @@ stubber/utils/repos.py,sha256=piUZwtHBXXJ-XPhvw_qXYqO-fy1ktZsb9-7CAwNo2YQ,5896
 stubber/utils/stubmaker.py,sha256=pO8Bo9JuHo6eeJGJz4hO2PzVJojNYFdJPdVtlgjKkBI,5236
 stubber/utils/typed_config_toml.py,sha256=ZR7eo-whyL4nhFXj6xs7E121sLuE-ivlUDevII4K2xg,2653
 stubber/variants.py,sha256=NnwUP-aiGUPAn15BeRRFcBWQUOzAFFnN2oL4u9zio-s,3792
-micropython_stubber-1.24.0.dist-info/entry_points.txt,sha256=JoR8NWh8t6pbDyn0WOMCIfRfDQAOGxqbOgJWuxv3Cxw,116
-micropython_stubber-1.24.0.dist-info/LICENSE,sha256=Fx9qrL45ayRXgH6QzttboqZEjKXms0w1t_b_nkOqYCU,1572
-micropython_stubber-1.24.0.dist-info/METADATA,sha256=VFYvKOoekntu4U0wBy_DcDgbYWsqHKHzUrYJD_zAVDc,25020
-micropython_stubber-1.24.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-micropython_stubber-1.24.0.dist-info/RECORD,,
+micropython_stubber-1.24.1.dist-info/entry_points.txt,sha256=JoR8NWh8t6pbDyn0WOMCIfRfDQAOGxqbOgJWuxv3Cxw,116
+micropython_stubber-1.24.1.dist-info/LICENSE,sha256=Fx9qrL45ayRXgH6QzttboqZEjKXms0w1t_b_nkOqYCU,1572
+micropython_stubber-1.24.1.dist-info/METADATA,sha256=6Gnlh9EeIuyneLSALgsqwbQFFeQxhvM1cjrOyza-vHs,25020
+micropython_stubber-1.24.1.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+micropython_stubber-1.24.1.dist-info/RECORD,,

mpflash/mpflash/flash/esp.py

@@ -15,7 +15,7 @@ from mpflash.mpremoteboard import MPRemoteBoard
 
 
 def flash_esp(mcu: MPRemoteBoard, fw_file: Path, *, erase: bool = True) -> Optional[MPRemoteBoard]:
-    if mcu.port not in ["esp32", "esp8266"] or mcu.board in ["ARDUINO_NANO_ESP32"]:
+    if mcu.port not in ["esp32", "esp8266"] or mcu.board.startswith("ARDUINO_"):
         log.error(f"esptool not supported for {mcu.port} {mcu.board} on {mcu.serialport}")
         return None
 

stubber/codemod/merge_docstub.py

@@ -13,8 +13,8 @@ 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 mpflash.logger import log
 
+from mpflash.logger import log
 from stubber.cst_transformer import (
     MODULE_KEY,
     AnnoValue,
@@ -23,7 +23,7 @@ from stubber.cst_transformer import (
     update_module_docstr,
 )
 
-from .visitors.typevars import AddTypeVarsVisitor, GatherTypeVarsVisitor
+from .visitors.type_helpers import AddTypeHelpers, GatherTypeHelpers
 
 Mod_Class_T = TypeVar("Mod_Class_T", cst.Module, cst.ClassDef)
 """TypeVar for Module or ClassDef that both support overloads"""
@@ -95,7 +95,7 @@ class MergeCommand(VisitorBasedCodemodCommand):
 
         self.stub_imports: Dict[str, ImportItem] = {}
         self.all_imports: List[Union[cst.Import, cst.ImportFrom]] = []
-        self.typevars = []
+        self.type_helpers = []
         # parse the doc-stub file
         if self.docstub_source:
             try:
@@ -107,7 +107,7 @@ class MergeCommand(VisitorBasedCodemodCommand):
             # create the collectors
             typing_collector = StubTypingCollector()
             import_collector = GatherImportsVisitor(context)
-            typevar_collector = GatherTypeVarsVisitor(context)
+            typevar_collector = GatherTypeHelpers(context)
             # visit the source / doc-stub file with all collectors
             stub_tree.visit(typing_collector)
             self.annotations = typing_collector.annotations
@@ -116,9 +116,9 @@ class MergeCommand(VisitorBasedCodemodCommand):
             stub_tree.visit(import_collector)
             self.stub_imports = import_collector.symbol_mapping
             self.all_imports = import_collector.all_imports
-            # Get typevars
+            # Get typevars, type aliasses and ParamSpecs
             stub_tree.visit(typevar_collector)
-            self.typevars = typevar_collector.all_typealias_or_vars
+            self.type_helpers = typevar_collector.all_typehelpers
 
     # ------------------------------------------------------------------------
 
@@ -177,11 +177,11 @@ class MergeCommand(VisitorBasedCodemodCommand):
                         )
         # --------------------------------------------------------------------
         # Add any typevars to the module
-        if self.typevars:
-            for tv in self.typevars:
-                AddTypeVarsVisitor.add_typevar(self.context, tv)  # type: ignore
+        if self.type_helpers:
+            for tv in self.type_helpers:
+                AddTypeHelpers.add_typevar(self.context, tv)  # type: ignore
 
-            atv = AddTypeVarsVisitor(self.context)
+            atv = AddTypeHelpers(self.context)
             updated_node = atv.transform_module(updated_node)
 
         # --------------------------------------------------------------------

stubber/codemod/visitors/type_helpers.py

@@ -0,0 +1,182 @@
+"""
+Gather all TypeVar and TypeAlias assignments in a module.
+"""
+
+from typing import List, Sequence, Tuple, Union
+
+import libcst
+import libcst.matchers as m
+from libcst import SimpleStatementLine
+from libcst.codemod._context import CodemodContext
+from libcst.codemod._visitor import ContextAwareTransformer, ContextAwareVisitor
+from libcst.codemod.visitors._add_imports import _skip_first
+from typing_extensions import TypeAlias
+
+from mpflash.logger import log
+
+TypeHelper: TypeAlias = Union[libcst.Assign, libcst.AnnAssign]
+TypeHelpers: TypeAlias = List[TypeHelper]
+Statement: TypeAlias = Union[libcst.SimpleStatementLine, libcst.BaseCompoundStatement]
+
+_mod = libcst.parse_module("")  # Debugging aid : _mod.code_for_node(node)
+_code = _mod.code_for_node  #     Debugging aid : _code(node)
+
+
+def is_TypeAlias(statement) -> bool:
+    "Annotated Assign -  Foo:TypeAlias = ..."
+    if m.matches(statement, m.SimpleStatementLine()):
+        statement = statement.body[0]
+    return m.matches(
+        statement,
+        m.AnnAssign(annotation=m.Annotation(annotation=m.Name(value="TypeAlias"))),
+    )
+
+
+def is_TypeVar(statement):
+    "Assing - Foo = Typevar(...)"
+    if m.matches(statement, m.SimpleStatementLine()):
+        statement = statement.body[0]
+    return m.matches(
+        statement,
+        m.Assign(value=m.Call(func=m.Name(value="TypeVar"))),
+    )
+
+
+def is_ParamSpec(statement):
+    "Assign - Foo = ParamSpec(...)"
+    if m.matches(statement, m.SimpleStatementLine()):
+        statement = statement.body[0]
+    return m.matches(
+        statement,
+        m.Assign(value=m.Call(func=m.Name(value="ParamSpec"))),
+    )
+
+
+def is_import(statement):
+    "import - import foo"
+    return m.matches(statement, m.SimpleStatementLine(body=[m.ImportFrom() | m.Import()]))
+
+
+class GatherTypeHelpers(ContextAwareVisitor):
+    """
+    A class for tracking visited TypeVars and TypeAliases.
+    """
+
+    def __init__(self, context: CodemodContext) -> None:
+        super().__init__(context)
+        # Track all of the TypeVar, TypeAlias and Paramspec assignments found
+        self.all_typehelpers: TypeHelpers = []
+
+    def visit_Assign(self, node: libcst.Assign) -> None:
+        """
+        Find all TypeVar assignments in the module.
+        format: T = TypeVar("T", int, float, str, bytes, Tuple)
+        """
+        # is this a TypeVar assignment?
+        # needs to be more robust
+        if is_TypeVar(node) or is_ParamSpec(node):
+            self.all_typehelpers.append(node)
+
+    def visit_AnnAssign(self, node: libcst.AnnAssign) -> None:
+        """ "
+        Find all TypeAlias assignments in the module.
+        format: T: TypeAlias = str
+        """
+        if is_TypeAlias(node):
+            self.all_typehelpers.append(node)
+
+
+class AddTypeHelpers(ContextAwareTransformer):
+    """
+    Visitor loosly based on AddImportsVisitor
+    """
+
+    CONTEXT_KEY = "AddTypeHelpers"
+
+    def __init__(self, context: CodemodContext) -> None:
+        super().__init__(context)
+        self.new_typehelpers: TypeHelpers = context.scratch.get(self.CONTEXT_KEY, [])
+        self.all_typehelpers: TypeHelpers = []
+
+    @classmethod
+    def add_typevar(cls, context: CodemodContext, node: libcst.Assign):
+        new_typehelpers = context.scratch.get(cls.CONTEXT_KEY, [])
+        new_typehelpers.append(node)
+        context.scratch[cls.CONTEXT_KEY] = new_typehelpers
+        # add the typevar to the module
+
+    def leave_Module(
+        self,
+        original_node: libcst.Module,
+        updated_node: libcst.Module,
+    ) -> libcst.Module:
+        if not self.new_typehelpers:
+            return updated_node
+
+        # split the module into 3 parts
+        # before and after the insertions point , and a list of the TV and TA statements
+        (
+            statements_before,
+            helper_statements,
+            statements_after,
+        ) = self._split_module(original_node, updated_node)
+
+        # simpler to compare as text than to compare the nodes -
+        existing_targets = [
+            helper.body[0].targets[0].target.value  # type: ignore
+            for helper in helper_statements
+            if is_TypeVar(helper) or is_ParamSpec(helper)
+        ] + [
+            helper.body[0].target.value  # type: ignore
+            for helper in helper_statements
+            if is_TypeAlias(helper)
+        ]
+        statements_to_add = []
+        for new_typehelper in self.new_typehelpers:
+            if isinstance(new_typehelper, libcst.AnnAssign):
+                if new_typehelper.target.value not in existing_targets:  # type: ignore
+                    statements_to_add.append(SimpleStatementLine(body=[new_typehelper]))
+            elif isinstance(new_typehelper, libcst.Assign):
+                if new_typehelper.targets[0].target.value not in existing_targets:  # type: ignore
+                    statements_to_add.append(SimpleStatementLine(body=[new_typehelper]))
+
+        body = (
+            *statements_before,
+            *statements_to_add,
+            *statements_after,
+        )
+
+        return updated_node.with_changes(body=body)
+
+    def _split_module(
+        self,
+        orig_module: libcst.Module,
+        updated_module: libcst.Module,
+    ) -> Tuple[Sequence[Statement], Sequence[libcst.SimpleStatementLine], Sequence[Statement]]:
+        """
+        Split the module into 3 parts:
+        - before any TypeAlias, TypeVar or ParamSpec statements
+        - the TypeAlias and TypeVar statements
+        - the rest of the module after the TypeAlias and TypeVar statements
+        """
+        last_import = first_typehelper = last_typehelper = -1
+        start = 0
+        if _skip_first(orig_module):
+            start = 1
+
+        for i, statement in enumerate(orig_module.body[start:]):
+            if is_import(statement):
+                last_import = i + start
+                continue
+            if is_TypeVar(statement) or is_TypeAlias(statement) or is_ParamSpec(statement):
+                if first_typehelper == -1:
+                    first_typehelper = i + start
+                last_typehelper = i + start
+        # insert as high as possible, but after the last import and last TypeVar/TypeAlias statement
+        insert_after = max(start, last_import + 1, last_typehelper + 1)
+        assert insert_after != -1, "insert_after must be != -1"
+        #
+        before = list(updated_module.body[:insert_after])
+        after = list(updated_module.body[insert_after:])
+        helper_statements: Sequence[libcst.SimpleStatementLine] = list(updated_module.body[first_typehelper : last_typehelper + 1])  # type: ignore
+        return (before, helper_statements, after)

stubber/codemod/visitors/typevars.py

@@ -1,200 +0,0 @@
-"""
-Gather all TypeVar and TypeAlias assignments in a module.
-"""
-
-from typing import List, Tuple, Union
-
-import libcst
-import libcst.matchers as m
-from libcst import SimpleStatementLine
-from libcst.codemod._context import CodemodContext
-from libcst.codemod._visitor import ContextAwareTransformer, ContextAwareVisitor
-from libcst.codemod.visitors._add_imports import _skip_first
-from mpflash.logger import log
-
-_mod = libcst.parse_module("")  # Debugging aid : _mod.code_for_node(node)
-_code = _mod.code_for_node  # Debugging aid : _code(node)
-
-
-class GatherTypeVarsVisitor(ContextAwareVisitor):
-    """
-    A class for tracking visited TypeVars and TypeAliases.
-    """
-
-    def __init__(self, context: CodemodContext) -> None:
-        super().__init__(context)
-        # Track all of the TypeVar assignments found in this transform
-        self.all_typealias_or_vars: List[Union[libcst.Assign, libcst.AnnAssign]] = []
-
-    def visit_Assign(self, node: libcst.Assign) -> None:
-        """
-        Find all TypeVar assignments in the module.
-        format: T = TypeVar("T", int, float, str, bytes, Tuple)
-        """
-        # is this a TypeVar assignment?
-        # needs to be more robust
-        if isinstance(node.value, libcst.Call) and node.value.func.value == "TypeVar":  # type: ignore
-            self.all_typealias_or_vars.append(node)
-
-    def visit_AnnAssign(self, node: libcst.AnnAssign) -> None:
-        """ "
-        Find all TypeAlias assignments in the module.
-        format: T: TypeAlias = str
-        """
-        if (
-            isinstance(node.annotation.annotation, libcst.Name)
-            and node.annotation.annotation.value == "TypeAlias"
-        ):
-            self.all_typealias_or_vars.append(node)
-
-
-def is_TypeAlias(statement) -> bool:
-    "Just the body of a simple statement" ""
-    return m.matches(
-        statement,
-        m.AnnAssign(annotation=m.Annotation(annotation=m.Name(value="TypeAlias"))),
-    )
-
-
-def is_TypeVar(statement):
-    "Just the body of a simple statement" ""
-    r = m.matches(
-        statement,
-        m.Assign(value=m.Call(func=m.Name(value="TypeVar"))),
-    )
-    # m.SimpleStatementLine(body=[m.Assign(value=m.Call(func=m.Name(value="TypeVar")))]),
-    return r
-
-
-class AddTypeVarsVisitor(ContextAwareTransformer):
-    """
-    Visitor loosly based on AddImportsVisitor
-    """
-
-    CONTEXT_KEY = "AddTypeVarsVisitor"
-
-    def __init__(self, context: CodemodContext) -> None:
-        super().__init__(context)
-        self.new_typealias_or_vars: List[Union[libcst.Assign, libcst.AnnAssign]] = (
-            context.scratch.get(self.CONTEXT_KEY, [])
-        )
-
-        self.all_typealias_or_vars: List[Union[libcst.Assign, libcst.AnnAssign]] = []
-
-    @classmethod
-    def add_typevar(cls, context: CodemodContext, node: libcst.Assign):
-        new_typealias_or_vars = context.scratch.get(cls.CONTEXT_KEY, [])
-        new_typealias_or_vars.append(node)
-        context.scratch[cls.CONTEXT_KEY] = new_typealias_or_vars
-        # add the typevar to the module
-
-    def leave_Module(
-        self,
-        original_node: libcst.Module,
-        updated_node: libcst.Module,
-    ) -> libcst.Module:
-
-        if not self.new_typealias_or_vars:
-            return updated_node
-
-        # split the module into 3 parts
-        # before and after the insertions point , and a list of the TV and TA statements
-        (
-            statements_before,
-            statements_after,
-            tv_ta_statements,
-        ) = self._split_module(original_node, updated_node)
-
-        # TODO: avoid duplication of TypeVars and TypeAliases
-        statements_to_add = []
-        for new_tvta in self.new_typealias_or_vars:
-            existing = False
-            for existing_line in tv_ta_statements:
-                try:
-                    existing_tv = existing_line.body[0]  # type: ignore
-                except (TypeError, IndexError):
-                    # catch 'SimpleStatementLine' object is not subscriptable when the statement is not a simple statement
-                    log.error("TypeVar or TypeAlias statement is not a simple statement")
-                    continue
-
-                # same type and same target?
-                if (
-                    is_TypeAlias(new_tvta)
-                    and is_TypeAlias(existing_tv)
-                    and new_tvta.target.value == existing_tv.target.value  # type: ignore
-                ):
-                    existing = True
-                    break
-
-                # same type and same targets?
-                if (
-                    is_TypeVar(new_tvta)
-                    and is_TypeVar(existing_tv)
-                    and new_tvta.targets[0].children[0].value == existing_tv.targets[0].children[0].value  # type: ignore
-                ):
-                    existing = True
-                    break
-
-            if not existing:
-                statements_to_add.append(SimpleStatementLine(body=[new_tvta]))
-
-        body = (
-            *statements_before,
-            *statements_to_add,
-            *statements_after,
-        )
-
-        return updated_node.with_changes(body=body)
-
-    def _split_module(
-        self,
-        orig_module: libcst.Module,
-        updated_module: libcst.Module,
-    ) -> Tuple[
-        List[Union[libcst.SimpleStatementLine, libcst.BaseCompoundStatement]],
-        List[Union[libcst.SimpleStatementLine, libcst.BaseCompoundStatement]],
-        List[Union[libcst.SimpleStatementLine, libcst.BaseCompoundStatement]],
-    ]:
-        """
-        Split the module into 3 parts:
-        - before any TypeAlias or TypeVar statements
-        - the TypeAlias and TypeVar statements
-        - the rest of the module after the TypeAlias and TypeVar statements
-        """
-        last_import = first_tv_ta = last_tv_ta = -1
-        start = 0
-        if _skip_first(orig_module):
-            start = 1
-
-        for i, statement in enumerate(orig_module.body[start:]):
-            # todo: optimize to avoid multiple parses
-            is_imp = m.matches(
-                statement, m.SimpleStatementLine(body=[m.ImportFrom() | m.Import()])
-            )
-            if is_imp:
-                last_import = i + start
-            is_ta = m.matches(
-                statement,
-                m.SimpleStatementLine(
-                    body=[
-                        m.AnnAssign(annotation=m.Annotation(annotation=m.Name(value="TypeAlias")))
-                    ]
-                ),
-            )
-            is_tv = m.matches(
-                statement,
-                m.SimpleStatementLine(body=[m.Assign(value=m.Call(func=m.Name(value="TypeVar")))]),
-            )
-            if is_tv or is_ta:
-                if first_tv_ta == -1:
-                    first_tv_ta = i + start
-                last_tv_ta = i + start
-        # insert as high as possible, but after the last import and last TypeVar/TypeAlias statement
-        insert_after = max(start, last_import + 1, last_tv_ta + 1)
-        assert insert_after != -1, "insert_after must be != -1"
-        #
-        first = list(updated_module.body[:insert_after])
-        last = list(updated_module.body[insert_after:])
-        ta_statements = list(updated_module.body[first_tv_ta : last_tv_ta + 1])
-
-        return (first, last, ta_statements)