micropython-stubber 1.13.8__tar.gz → 1.14.1__tar.gz

{micropython_stubber-1.13.8 → micropython_stubber-1.14.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: micropython-stubber
-Version: 1.13.8
+Version: 1.14.1
 Summary: Tooling to create and maintain stubs for MicroPython
 Home-page: https://github.com/Josverl/micropython-stubber#readme
 License: MIT
@@ -26,13 +26,14 @@ Requires-Dist: click (>=8.1.3,<9.0.0)
 Requires-Dist: esptool (>=4.4,<5.0) ; extra == "tools"
 Requires-Dist: importlib-metadata (>=1.0,<2.0) ; python_version < "3.8"
 Requires-Dist: libcst (>=0.4.9,<0.5.0)
-Requires-Dist: loguru (>=0.6.0,<0.7.0)
+Requires-Dist: loguru (>=0.6,<0.8)
 Requires-Dist: mypy (==1.2.0)
 Requires-Dist: packaging (>=21.3,<24.0)
 Requires-Dist: pipx (>=1.1.0,<2.0.0)
 Requires-Dist: pygithub (>=1.57,<2.0)
 Requires-Dist: pypi-simple (>=1.0.0,<2.0.0)
 Requires-Dist: pyright (>=1.1.265,<2.0.0)
+Requires-Dist: pyserial (>=3.5,<4.0)
 Requires-Dist: pysondb-v2 (>=2.1.0,<3.0.0)
 Requires-Dist: python-minifier (>=2.7.0,<3.0.0)
 Requires-Dist: requests (>=2.28.0,<3.0.0)

{micropython_stubber-1.13.8 → micropython_stubber-1.14.1}/pyproject.toml

@@ -8,7 +8,7 @@ repo-path = "./repos"
 
 [tool.poetry]
 name = "micropython-stubber"
-version = "1.13.8"
+version = "1.14.1"
 description = "Tooling to create and maintain stubs for MicroPython"
 authors = ["Jos Verlinde <jos_verlinde@hotmail.com>"]
 license = "MIT"
@@ -56,7 +56,7 @@ cachetools = "^5.3.0"
 click = "^8.1.3"
 esptool = { version = "^4.4", optional = true }
 importlib-metadata = { version = "^1.0", python = "<3.8" }
-loguru = "^0.6.0"
+loguru = ">=0.6,<0.8"
 packaging = ">=21.3,<24.0"
 pipx = "^1.1.0"
 pygithub = "^1.57"
@@ -68,6 +68,7 @@ tenacity = "^8.2.2"
 tomli = { version = "^2.0.1", python = "<3.11" }
 tomli-w = "^1.0.0"
 typed-config = "^1.3.0"
+pyserial = "^3.5"
 
 [tool.poetry.extras]
 tools = ["esptool"]
@@ -75,7 +76,7 @@ tools = ["esptool"]
 [tool.poetry.group.docs]
 optional = true
 [tool.poetry.group.docs.dependencies]
-Sphinx = "^4.4.0"
+Sphinx = ">=4.4,<6.0"
 myst-parser = ">=0.17,<0.19"
 sphinx_rtd_theme = "^1.0.0"
 sphinx-autoapi = "^1.9.0"
@@ -97,6 +98,10 @@ pytest-mock = "^3.10.0"
 sourcery-cli = "^1.0.3"
 mpremote = { git = "https://github.com/Josverl/mpremote", subdirectory = "tools/mpremote", optional = true }
 ipykernel = "^6.23.1"
+fasteners = "^0.19"
+python-dotenv = "^1.0.0"
+
+
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
@@ -205,16 +210,33 @@ exclude = '''
 minversion = "7.0"
 python_functions = ["test_", "*_test"]
 python_files = ["test_*.py", "*_test.py"]
-testpaths = ["tests", "src"]
+testpaths = ["tests", "src", "snippets"]
+norecursedirs = [
+    "repos",
+    "typings*",
+    ".svn",
+    "_build",
+    "tmp*",
+    ".*",
+    "build",
+    "dist",
+    "{arch}",
+    "*.egg",
+]
 junit_family = "xunit1"
 
-addopts = "-v -sv  -m 'not basicgit'"
+addopts = "--verbose --capture=no -m 'not basicgit'"
+#  -m 'not snippets'
+# --numprocesses=auto 
+# -m MARKEXPR           Only run tests matching given mark expression. For example: -m 'mark1 and not mark2'.
+# -n --numprocesses=numprocesses - 
 
 markers = [
     "slow: marks tests as slow (deselect with '-m \"not slow\"')",
     "integration: Integration tests (slower)",
     "basicgit: marks tests in the basicgit module that manipulate the checkout",
     "mocked: to replace/compensate for most of the slow and git tests",
+    "snippets: test snippets to check the stubs",
     #
     "minified: marks test of the minified version of createstubs",
     "minify: marks test of the minification of createstubs",
@@ -227,6 +249,9 @@ markers = [
     "win32: run test only on Windows",
     "linux: run test only on linux",
     "darwin: run test only on Mac",
+    "version: run test only on specific version",
+    "1.19.0: run test only on 1.19.0",
+    "1.20.0: run test only on 1.20.0",
 ]
 
 # coverage reports

micropython_stubber-1.14.1/src/stubber/__init__.py

@@ -0,0 +1,4 @@
+"""get the version"""
+
+
+__version__ = "1.14.1"

{micropython_stubber-1.13.8 → micropython_stubber-1.14.1}/src/stubber/board/createstubs.py

@@ -5,9 +5,9 @@ Create stubs for (all) modules on a MicroPython board
 # pylint: disable= invalid-name, missing-function-docstring, import-outside-toplevel, logging-not-lazy
 import gc
 import logging
+import os
 import sys
 
-import uos as os
 from ujson import dumps
 
 try:
@@ -20,7 +20,7 @@ try:
 except ImportError:
     from ucollections import OrderedDict  # type: ignore
 
-__version__ = "v1.13.8"
+__version__ = "v1.14.1"
 ENOENT = 2
 _MAX_CLASS_LEVEL = 2  # Max class nesting
 LIBS = [".", "/lib", "/sd/lib", "/flash/lib", "lib"]
@@ -81,7 +81,7 @@ class Stubber:
             "example_pub_button.py",
         ]
         # there is no option to discover modules from micropython, list is read from an external file.
-        self.modules = []
+        self.modules = []  # type: list[str]
 
     def get_obj_attributes(self, item_instance: object):
         "extract information of the objects members and attributes"
@@ -110,7 +110,11 @@ class Stubber:
                     order = 4
                 _result.append((name, repr(val), repr(type(val)), val, order))
             except AttributeError as e:
-                _errors.append("Couldn't get attribute '{}' from object '{}', Err: {}".format(name, item_instance, e))
+                _errors.append(
+                    "Couldn't get attribute '{}' from object '{}', Err: {}".format(
+                        name, item_instance, e
+                    )
+                )
             except MemoryError as e:
                 print("MemoryError: {}".format(e))
                 sleep(1)
@@ -174,24 +178,31 @@ class Stubber:
         try:
             new_module = __import__(module_name, None, None, ("*"))
             m1 = gc.mem_free()  # type: ignore
-            self._log.info("Stub module: {:<25} to file: {:<70} mem:{:>5}".format(module_name, fname, m1))
+            self._log.info(
+                "Stub module: {:<25} to file: {:<70} mem:{:>5}".format(module_name, fname, m1)
+            )
 
         except ImportError:
-            self._log.warning("Skip module: {:<25} {:<79}".format(module_name, "Module not found."))
+            self._log.warning(
+                "Skip module: {:<25} {:<79}".format(module_name, "Module not found.")
+            )
             return False
 
         # Start a new file
         ensure_folder(file_name)
         with open(file_name, "w") as fp:
             # todo: improve header
+            info_ = str(self.info).replace("OrderedDict(", "").replace("})", "}")
             s = '"""\nModule: \'{0}\' on {1}\n"""\n# MCU: {2}\n# Stubber: {3}\n'.format(
-                module_name, self._fwid, self.info, __version__
+                module_name, self._fwid, info_, __version__
             )
             fp.write(s)
-            fp.write("from typing import Any\n\n")
+            fp.write("from typing import Any\nfrom _typeshed import Incomplete\n\n")
             self.write_object_stub(fp, new_module, module_name, "")
 
-        self._report.append('{{"module": "{}", "file": "{}"}}'.format(module_name, file_name.replace("\\", "/")))
+        self._report.append(
+            '{{"module": "{}", "file": "{}"}}'.format(module_name, file_name.replace("\\", "/"))
+        )
 
         if module_name not in {"os", "sys", "logging", "gc"}:
             # try to unload the module unless we use it
@@ -206,7 +217,9 @@ class Stubber:
         gc.collect()
         return True
 
-    def write_object_stub(self, fp, object_expr: object, obj_name: str, indent: str, in_class: int = 0):
+    def write_object_stub(
+        self, fp, object_expr: object, obj_name: str, indent: str, in_class: int = 0
+    ):
         "Write a module/object stub to an open file. Can be called recursive."
         gc.collect()
         if object_expr in self.problematic:
@@ -221,8 +234,8 @@ class Stubber:
 
         for item_name, item_repr, item_type_txt, item_instance, _ in items:
             # name_, repr_(value), type as text, item_instance, order
-            # do not create stubs for these primitives
             if item_name in ["classmethod", "staticmethod", "BaseException", "Exception"]:
+                # do not create stubs for these primitives
                 continue
             if item_name[0].isdigit():
                 self._log.warning("NameError: invalid name {}".format(item_name))
@@ -265,23 +278,29 @@ class Stubber:
                 s = indent + "    def __init__(self, *argv, **kwargs) -> None:\n"
                 s += indent + "        ...\n\n"
                 fp.write(s)
-            elif "method" in item_type_txt or "function" in item_type_txt:
-                self._log.debug("# def {1} function or method, type = '{0}'".format(item_type_txt, item_name))
+            elif any(word in item_type_txt for word in ["method", "function", "closure"]):
+                self._log.debug(
+                    "# def {1} function/method/closure, type = '{0}'".format(
+                        item_type_txt, item_name
+                    )
+                )
                 # module Function or class method
                 # will accept any number of params
-                # return type Any
-                ret = "Any"
+                # return type Any/Incomplete
+                ret = "Incomplete"
                 first = ""
                 # Self parameter only on class methods/functions
                 if in_class > 0:
                     first = "self, "
                 # class method - add function decoration
                 if "bound_method" in item_type_txt or "bound_method" in item_repr:
-                    s = "{}@classmethod\n".format(indent) + "{}def {}(cls, *args, **kwargs) -> {}:\n".format(
-                        indent, item_name, ret
-                    )
+                    s = "{}@classmethod\n".format(
+                        indent
+                    ) + "{}def {}(cls, *args, **kwargs) -> {}:\n".format(indent, item_name, ret)
                 else:
-                    s = "{}def {}({}*args, **kwargs) -> {}:\n".format(indent, item_name, first, ret)
+                    s = "{}def {}({}*args, **kwargs) -> {}:\n".format(
+                        indent, item_name, first, ret
+                    )
                 s += indent + "    ...\n\n"
                 fp.write(s)
                 self._log.debug("\n" + s)
@@ -306,9 +325,11 @@ class Stubber:
                     if t not in ["object", "set", "frozenset"]:
                         # Possibly default others to item_instance object ?
                         # https://docs.python.org/3/tutorial/classes.html#item_instance-objects
-                        t = "Any"
+                        t = "Incomplete"
                     # Requires Python 3.6 syntax, which is OK for the stubs/pyi
-                    s = "{0}{1} : {2} ## {3} = {4}\n".format(indent, item_name, t, item_type_txt, item_repr)
+                    s = "{0}{1} : {2} ## {3} = {4}\n".format(
+                        indent, item_name, t, item_type_txt, item_repr
+                    )
                 fp.write(s)
                 self._log.debug("\n" + s)
             else:
@@ -316,7 +337,7 @@ class Stubber:
                 self._log.debug("# all other, type = '{0}'".format(item_type_txt))
                 fp.write("# all other, type = '{0}'\n".format(item_type_txt))
 
-                fp.write(indent + item_name + " # type: Any\n")
+                fp.write(indent + item_name + " # type: Incomplete\n")
 
         del items
         del errors
@@ -359,7 +380,11 @@ class Stubber:
 
     def report(self, filename: str = "modules.json"):
         "create json with list of exported modules"
-        self._log.info("Created stubs for {} modules on board {}\nPath: {}".format(len(self._report), self._fwid, self.path))
+        self._log.info(
+            "Created stubs for {} modules on board {}\nPath: {}".format(
+                len(self._report), self._fwid, self.path
+            )
+        )
         f_name = "{}/{}".format(self.path, filename)
         self._log.info("Report file: {}".format(f_name))
         gc.collect()
@@ -432,7 +457,9 @@ def _info():  # type:() -> dict[str, str]
             "version": "",
             "build": "",
             "ver": "",
-            "port": "stm32" if sys.platform.startswith("pyb") else sys.platform,  # port: esp32 / win32 / linux / stm32
+            "port": "stm32"
+            if sys.platform.startswith("pyb")
+            else sys.platform,  # port: esp32 / win32 / linux / stm32
             "board": "GENERIC",
             "cpu": "",
             "mpy": "",
@@ -444,7 +471,11 @@ def _info():  # type:() -> dict[str, str]
     except AttributeError:
         pass
     try:
-        machine = sys.implementation._machine if "_machine" in dir(sys.implementation) else os.uname().machine
+        machine = (
+            sys.implementation._machine
+            if "_machine" in dir(sys.implementation)
+            else os.uname().machine
+        )
         info["board"] = machine.strip()
         info["cpu"] = machine.split("with")[1].strip()
         info["mpy"] = (
@@ -514,7 +545,8 @@ 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.0 do not have a micro .0
+            and info["version"]
+            >= "1.10.0"  # versions from 1.10.0 to 1.20.0 do not have a micro .0
             and info["version"] <= "1.19.9"
         ):
             # drop the .0 for newer releases
@@ -642,8 +674,10 @@ def main():
     stubber.modules = [
         "WM8960",
         "_OTA",
+        "_asyncio",
         "_boot_fat",
         "_coap",
+        "_espnow",
         "_flash_control_OTA",
         "_main_pybytes",
         "_mqtt",
@@ -679,10 +713,17 @@ def main():
         "aioble/peripheral",
         "aioble/security",
         "aioble/server",
+        "aioespnow",
         "ak8963",
         "apa102",
         "apa106",
         "array",
+        "asyncio/__init__",
+        "asyncio/core",
+        "asyncio/event",
+        "asyncio/funcs",
+        "asyncio/lock",
+        "asyncio/stream",
         "binascii",
         "bluetooth",
         "breakout_as7262",
@@ -713,6 +754,7 @@ def main():
         "crypto",
         "cryptolib",
         "curl",
+        "deflate",
         "dht",
         "display",
         "display_driver_utils",
@@ -722,6 +764,7 @@ def main():
         "esp",
         "esp32",
         "espidf",
+        "espnow",
         "flashbdev",
         "framebuf",
         "freesans20",
@@ -757,6 +800,7 @@ def main():
         "microWebTemplate",
         "micropython",
         "mip",
+        "mip/__init__",
         "motor",
         "mpu6500",
         "mpu9250",
@@ -875,7 +919,7 @@ if __name__ == "__main__" or is_micropython():
         pass
     if not file_exists("no_auto_stubber.txt"):
         try:
-            gc.threshold(4 * 1024)
+            gc.threshold(4 * 1024)  # type: ignore
             gc.enable()
         except BaseException:
             pass

{micropython_stubber-1.13.8 → micropython_stubber-1.14.1}/src/stubber/board/createstubs_db.py

@@ -18,15 +18,15 @@ 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.13.8
+This variant was generated from createstubs.py by micropython-stubber v1.14.1
 """
 # Copyright (c) 2019-2023 Jos Verlinde
 # pylint: disable= invalid-name, missing-function-docstring, import-outside-toplevel, logging-not-lazy
 import gc
 import logging
+import os
 import sys
 
-import uos as os
 from ujson import dumps
 
 try:
@@ -39,7 +39,7 @@ try:
 except ImportError:
     from ucollections import OrderedDict  # type: ignore
 
-__version__ = "v1.13.8"
+__version__ = "v1.14.1"
 ENOENT = 2
 _MAX_CLASS_LEVEL = 2  # Max class nesting
 LIBS = [".", "/lib", "/sd/lib", "/flash/lib", "lib"]
@@ -100,7 +100,7 @@ class Stubber:
             "example_pub_button.py",
         ]
         # there is no option to discover modules from micropython, list is read from an external file.
-        self.modules = []
+        self.modules = []  # type: list[str]
 
     def get_obj_attributes(self, item_instance: object):
         "extract information of the objects members and attributes"
@@ -203,9 +203,10 @@ class Stubber:
         ensure_folder(file_name)
         with open(file_name, "w") as fp:
             # todo: improve header
-            s = '"""\nModule: \'{0}\' on {1}\n"""\n# MCU: {2}\n# Stubber: {3}\n'.format(module_name, self._fwid, self.info, __version__)
+            info_ = str(self.info).replace("OrderedDict(", "").replace("})", "}")
+            s = '"""\nModule: \'{0}\' on {1}\n"""\n# MCU: {2}\n# Stubber: {3}\n'.format(module_name, self._fwid, info_, __version__)
             fp.write(s)
-            fp.write("from typing import Any\n\n")
+            fp.write("from typing import Any\nfrom _typeshed import Incomplete\n\n")
             self.write_object_stub(fp, new_module, module_name, "")
 
         self._report.append('{{"module": "{}", "file": "{}"}}'.format(module_name, file_name.replace("\\", "/")))
@@ -238,8 +239,8 @@ class Stubber:
 
         for item_name, item_repr, item_type_txt, item_instance, _ in items:
             # name_, repr_(value), type as text, item_instance, order
-            # do not create stubs for these primitives
             if item_name in ["classmethod", "staticmethod", "BaseException", "Exception"]:
+                # do not create stubs for these primitives
                 continue
             if item_name[0].isdigit():
                 self._log.warning("NameError: invalid name {}".format(item_name))
@@ -282,12 +283,12 @@ class Stubber:
                 s = indent + "    def __init__(self, *argv, **kwargs) -> None:\n"
                 s += indent + "        ...\n\n"
                 fp.write(s)
-            elif "method" in item_type_txt or "function" in item_type_txt:
-                self._log.debug("# def {1} function or method, type = '{0}'".format(item_type_txt, item_name))
+            elif any(word in item_type_txt for word in ["method", "function", "closure"]):
+                self._log.debug("# def {1} function/method/closure, type = '{0}'".format(item_type_txt, item_name))
                 # module Function or class method
                 # will accept any number of params
-                # return type Any
-                ret = "Any"
+                # return type Any/Incomplete
+                ret = "Incomplete"
                 first = ""
                 # Self parameter only on class methods/functions
                 if in_class > 0:
@@ -321,7 +322,7 @@ class Stubber:
                     if t not in ["object", "set", "frozenset"]:
                         # Possibly default others to item_instance object ?
                         # https://docs.python.org/3/tutorial/classes.html#item_instance-objects
-                        t = "Any"
+                        t = "Incomplete"
                     # Requires Python 3.6 syntax, which is OK for the stubs/pyi
                     s = "{0}{1} : {2} ## {3} = {4}\n".format(indent, item_name, t, item_type_txt, item_repr)
                 fp.write(s)
@@ -331,7 +332,7 @@ class Stubber:
                 self._log.debug("# all other, type = '{0}'".format(item_type_txt))
                 fp.write("# all other, type = '{0}'\n".format(item_type_txt))
 
-                fp.write(indent + item_name + " # type: Any\n")
+                fp.write(indent + item_name + " # type: Incomplete\n")
 
         del items
         del errors
@@ -732,7 +733,7 @@ if __name__ == "__main__" or is_micropython():
         pass
     if not file_exists("no_auto_stubber.txt"):
         try:
-            gc.threshold(4 * 1024)
+            gc.threshold(4 * 1024)  # type: ignore
             gc.enable()
         except BaseException:
             pass