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

stubber/tools/readme.md

@@ -1,7 +1,7 @@
-tools vendored from micropython 
-
-- manifestfile.py 
-  - Micropython manifest file parser 
-  - https://github.com/micropython/micropython/blob/master/tools/manifestfile.py
-  - v1.23.0 
+tools vendored from micropython 
+
+- manifestfile.py 
+  - Micropython manifest file parser 
+  - https://github.com/micropython/micropython/blob/master/tools/manifestfile.py
+  - v1.23.0 
     - https://raw.githubusercontent.com/micropython/micropython/v1.23.0/tools/manifestfile.py

stubber/update_fallback.py

@@ -1,117 +1,117 @@
-# """build/update the fallback 'catch-all' stubfolder"""
-
-# import os
-# import shutil
-# from distutils.dir_util import copy_tree
-# from distutils.errors import DistutilsFileError
-# from pathlib import Path
-# from typing import List, Optional, Tuple
-
-# from mpflash.logger import log
-
-# from mpflash.versions import V_PREVIEW
-
-# # log = logging.getLogger()
-
-# RELEASED = "v1_18"
-
-
-# def fallback_sources(version: str, fw_version: Optional[str] = None) -> List[Tuple[str, str]]:
-#     # sourcery skip: inline-immediately-returned-variable
-#     """
-#     list of sources to build/update the fallback 'catch-all' stubfolder
-#     version : the version to use
-#     fw_version : version to source the MCU stubs from. Defaults to the version used , but can be lower
-
-#     """
-#     if not fw_version:
-#         fw_version = version
-#     if fw_version == V_PREVIEW:
-#         fw_version = RELEASED
-#     SOURCES = [
-#         ("uasyncio", f"micropython-{fw_version}-esp32"),
-#         ("umqtt", f"micropython-{fw_version}-esp32"),
-#         ("_onewire.py*", f"micropython-{fw_version}-esp32"),
-#         ("_uasyncio.py*", f"micropython-{fw_version}-esp32"),
-#         ("array.py*", f"micropython-{fw_version}-esp32"),
-#         ("binascii.py*", f"micropython-{fw_version}-esp32"),
-#         ("hashlib.py*", f"micropython-{fw_version}-esp32"),
-#         ("machine.py*", f"micropython-{fw_version}-esp32"),
-#         ("micropython.py*", f"micropython-{version}-docstubs"),  # esp32"),
-#         ("network.pyi", f"micropython-{version}-docstubs"),  # esp32"),
-#         ("struct.py*", f"micropython-{fw_version}-esp32"),
-#         ("uarray.py*", f"micropython-{fw_version}-esp32"),
-#         ("ubinascii.py*", f"micropython-{fw_version}-esp32"),
-#         ("uctypes.py*", f"micropython-{fw_version}-esp32"),
-#         ("uerrno.py*", f"micropython-{fw_version}-esp32"),
-#         ("uhashlib.py*", f"micropython-{fw_version}-esp32"),
-#         ("uio.py*", f"micropython-{fw_version}-esp32"),
-#         ("ujson.py*", f"micropython-{fw_version}-esp32"),
-#         ("uselect.py*", f"micropython-{fw_version}-esp32"),
-#         ("usocket.py*", f"micropython-{fw_version}-esp32"),
-#         ("ussl.py*", f"micropython-{fw_version}-esp32"),
-#         ("ustruct.py*", f"micropython-{fw_version}-esp32"),
-#         ("sys.py*", f"micropython-{fw_version}-esp32"),
-#         ("usys.py*", f"micropython-{fw_version}-esp32"),
-#         ("uzlib.py*", f"micropython-{fw_version}-esp32"),
-#         ("bluetooth.py*", f"micropython-{version}-docstubs"),
-#         # esp
-#         ("esp.py*", f"micropython-{version}-docstubs"),  # 8266 fw stub has most functions
-#         ("esp32.py*", f"micropython-{version}-docstubs"),  # esp32"),
-#         # pyboard == stm32
-#         ("pyb.py*", f"micropython-{fw_version}-stm32"),
-#         ("framebuf.py*", f"micropython-{fw_version}-stm32"),
-#         # rp2
-#         ("_rp2.py*", f"micropython-{fw_version}-rp2"),
-#         # stdlib
-#         ("os.py*", f"micropython-{fw_version}-esp32"),  # -> stdlib
-#         ("uos.py*", f"micropython-{fw_version}-esp32"),
-#         ("time.py*", f"micropython-{fw_version}-esp32"),  # -> stdlib
-#         ("utime.py*", f"micropython-{fw_version}-esp32"),
-#     ]
-#     return SOURCES
-
-
-# def update_fallback(stubpath: Path, fallback_path: Path, version: str = RELEASED):
-#     "update the fallback stubs from the defined sources"
-#     # remove all *.py/.pyi files
-#     if not fallback_path.exists():
-#         os.makedirs(fallback_path)
-#     else:
-#         oldstubs = list(fallback_path.rglob("*.py")) + list(fallback_path.rglob("*.pyi"))
-#         log.debug(f"deleting {len(oldstubs)} stubs from {fallback_path.as_posix()}")
-#         for f in oldstubs:
-#             try:
-#                 os.remove(f)
-#             except OSError as e:
-#                 log.warning(e)
-#     added = 0
-#     for name, source in fallback_sources(version):
-#         if "." not in name:
-#             # copy folder
-#             log.debug(f"add {source} folder")
-#             try:
-#                 copy_tree(
-#                     (stubpath / source / name).as_posix(),
-#                     (fallback_path / name).as_posix(),
-#                 )
-#                 added += 1
-#             except DistutilsFileError:
-#                 log.warning(f"{(stubpath / source / name).as_posix()} not found")
-#         else:
-#             # copy file(s)
-#             log.debug(f"add {source}")
-#             for f in (stubpath / source).glob(name):
-#                 shutil.copyfile(f, fallback_path / f.name)
-#                 added += 1
-#     return added
-
-
-# if __name__ == "__main__":
-#     from stubber.utils.config import CONFIG
-
-#     update_fallback(
-#         CONFIG.stub_path,
-#         CONFIG.fallback_path,
-#         version=RELEASED,
-#     )
+# """build/update the fallback 'catch-all' stubfolder"""
+
+# import os
+# import shutil
+# from distutils.dir_util import copy_tree
+# from distutils.errors import DistutilsFileError
+# from pathlib import Path
+# from typing import List, Optional, Tuple
+
+# from mpflash.logger import log
+
+# from mpflash.versions import V_PREVIEW
+
+# # log = logging.getLogger()
+
+# RELEASED = "v1_18"
+
+
+# def fallback_sources(version: str, fw_version: Optional[str] = None) -> List[Tuple[str, str]]:
+#     # sourcery skip: inline-immediately-returned-variable
+#     """
+#     list of sources to build/update the fallback 'catch-all' stubfolder
+#     version : the version to use
+#     fw_version : version to source the MCU stubs from. Defaults to the version used , but can be lower
+
+#     """
+#     if not fw_version:
+#         fw_version = version
+#     if fw_version == V_PREVIEW:
+#         fw_version = RELEASED
+#     SOURCES = [
+#         ("uasyncio", f"micropython-{fw_version}-esp32"),
+#         ("umqtt", f"micropython-{fw_version}-esp32"),
+#         ("_onewire.py*", f"micropython-{fw_version}-esp32"),
+#         ("_uasyncio.py*", f"micropython-{fw_version}-esp32"),
+#         ("array.py*", f"micropython-{fw_version}-esp32"),
+#         ("binascii.py*", f"micropython-{fw_version}-esp32"),
+#         ("hashlib.py*", f"micropython-{fw_version}-esp32"),
+#         ("machine.py*", f"micropython-{fw_version}-esp32"),
+#         ("micropython.py*", f"micropython-{version}-docstubs"),  # esp32"),
+#         ("network.pyi", f"micropython-{version}-docstubs"),  # esp32"),
+#         ("struct.py*", f"micropython-{fw_version}-esp32"),
+#         ("uarray.py*", f"micropython-{fw_version}-esp32"),
+#         ("ubinascii.py*", f"micropython-{fw_version}-esp32"),
+#         ("uctypes.py*", f"micropython-{fw_version}-esp32"),
+#         ("uerrno.py*", f"micropython-{fw_version}-esp32"),
+#         ("uhashlib.py*", f"micropython-{fw_version}-esp32"),
+#         ("uio.py*", f"micropython-{fw_version}-esp32"),
+#         ("ujson.py*", f"micropython-{fw_version}-esp32"),
+#         ("uselect.py*", f"micropython-{fw_version}-esp32"),
+#         ("usocket.py*", f"micropython-{fw_version}-esp32"),
+#         ("ussl.py*", f"micropython-{fw_version}-esp32"),
+#         ("ustruct.py*", f"micropython-{fw_version}-esp32"),
+#         ("sys.py*", f"micropython-{fw_version}-esp32"),
+#         ("usys.py*", f"micropython-{fw_version}-esp32"),
+#         ("uzlib.py*", f"micropython-{fw_version}-esp32"),
+#         ("bluetooth.py*", f"micropython-{version}-docstubs"),
+#         # esp
+#         ("esp.py*", f"micropython-{version}-docstubs"),  # 8266 fw stub has most functions
+#         ("esp32.py*", f"micropython-{version}-docstubs"),  # esp32"),
+#         # pyboard == stm32
+#         ("pyb.py*", f"micropython-{fw_version}-stm32"),
+#         ("framebuf.py*", f"micropython-{fw_version}-stm32"),
+#         # rp2
+#         ("_rp2.py*", f"micropython-{fw_version}-rp2"),
+#         # stdlib
+#         ("os.py*", f"micropython-{fw_version}-esp32"),  # -> stdlib
+#         ("uos.py*", f"micropython-{fw_version}-esp32"),
+#         ("time.py*", f"micropython-{fw_version}-esp32"),  # -> stdlib
+#         ("utime.py*", f"micropython-{fw_version}-esp32"),
+#     ]
+#     return SOURCES
+
+
+# def update_fallback(stubpath: Path, fallback_path: Path, version: str = RELEASED):
+#     "update the fallback stubs from the defined sources"
+#     # remove all *.py/.pyi files
+#     if not fallback_path.exists():
+#         os.makedirs(fallback_path)
+#     else:
+#         oldstubs = list(fallback_path.rglob("*.py")) + list(fallback_path.rglob("*.pyi"))
+#         log.debug(f"deleting {len(oldstubs)} stubs from {fallback_path.as_posix()}")
+#         for f in oldstubs:
+#             try:
+#                 os.remove(f)
+#             except OSError as e:
+#                 log.warning(e)
+#     added = 0
+#     for name, source in fallback_sources(version):
+#         if "." not in name:
+#             # copy folder
+#             log.debug(f"add {source} folder")
+#             try:
+#                 copy_tree(
+#                     (stubpath / source / name).as_posix(),
+#                     (fallback_path / name).as_posix(),
+#                 )
+#                 added += 1
+#             except DistutilsFileError:
+#                 log.warning(f"{(stubpath / source / name).as_posix()} not found")
+#         else:
+#             # copy file(s)
+#             log.debug(f"add {source}")
+#             for f in (stubpath / source).glob(name):
+#                 shutil.copyfile(f, fallback_path / f.name)
+#                 added += 1
+#     return added
+
+
+# if __name__ == "__main__":
+#     from stubber.utils.config import CONFIG
+
+#     update_fallback(
+#         CONFIG.stub_path,
+#         CONFIG.fallback_path,
+#         version=RELEASED,
+#     )

stubber/update_module_list.py

@@ -1,123 +1,123 @@
-# pragma: no cover
-"""
-generate the list of modules that should be attempted to stub
-for this : 
-- combine the modules from the different texts files
-- split the lines into individual module names
-- combine them in one set
-- remove the ones than cannot be stubbed
-- remove test modules, ending in `_test`
-- write updates to:
-    - board/modulelist.txt
-    - board/createstubs.py 
-"""
-
-from pathlib import Path
-from typing import List, Optional, Set
-
-from mpflash.logger import log
-
-
-def read_modules(path: Optional[Path] = None) -> Set[str]:
-    """
-    read text files with modules per firmware.
-    each contains the output of help("modules")
-    - lines starting with # are comments.
-    - split the other lines at whitespace seperator,
-    - and add each module to a set
-    """
-    path = Path(path or "./data")
-    assert path
-    all_modules: Set[str] = set()
-    for file in path.glob("*.txt"):
-        log.debug(f"processing: {file.name}")
-        with file.open("r") as f:
-            while line := f.readline():
-                if len(line) > 1 and line[0] != "#":
-                    file_mods = line.split()
-                    log.trace(line[:-1])
-                    log.trace(set(file_mods))
-                    # remove modules ending in _test
-                    file_mods = [m for m in file_mods if not m.endswith("_test")]
-                    all_modules = set(all_modules | set(file_mods))
-    log.trace(">" * 40)
-    return {m.replace(".", "/") for m in all_modules}
-
-
-def update_module_list():
-    """
-    helper script
-    generate a few lines of code with all modules to be stubbed by createstubs
-    """
-    #######################################################################
-    # the exceptions
-    #######################################################################
-    mods_problematic = {
-        "upysh",
-        "webrepl_setup",
-        "http_client",
-        "http_client_ssl",
-        "http_server",
-        "http_server_ssl",
-    }
-    mods_excluded = {
-        "__main__",
-        "_main",
-        "_boot",
-        "webrepl",
-        "_webrepl",
-        "port_diag",
-        "example_sub_led",
-        "example_pub_button",
-        "upip",
-        "upip_utarfile",
-        "upysh",
-        "uasyncio",
-        "builtins",
-        "re",
-    }
-    log.info("Update the module list in createstubs.py")
-    all_modules = read_modules()
-    modules_to_stub = sorted(all_modules - set(mods_excluded | mods_problematic))
-
-    # remove pycom MQTT* from defaults
-    modules_to_stub = sorted({m for m in modules_to_stub if not m.startswith("MQTT")})
-
-    log.info(f"modules to stub : {len(modules_to_stub)}")
-    # log.debug(wrapped(modules_to_stub))
-    lines: List[str] = []
-    # update modules.txt
-    modules_txt = Path("src/stubber/board/modulelist.txt")
-    if modules_txt.exists():
-        with open(modules_txt) as f:
-            lines = f.readlines()
-            # only keep comment lines
-            lines = [l for l in lines if l[0] == "#"]
-    else:
-        lines = ["# list of modules to stub."]
-    lines += [m + "\n" for m in modules_to_stub]
-    log.info(f"writing module list to {modules_txt}")
-    with open(modules_txt, "w") as f:
-        f.writelines(lines)
-
-    # update createstubs.py
-    createstubs = Path("src/stubber/board/createstubs.py")
-    if createstubs.exists():
-        with open(createstubs) as f:
-            lines = f.readlines()
-
-    l_start = lines.index("    stubber.modules = [\n")
-    assert l_start
-    l_end = lines.index("    ]  # spell-checker: enable\n", l_start)
-    assert l_end
-
-    # Plug in the new list of modules
-    lines = lines[: l_start + 1] + [f'        "{m}",\n' for m in modules_to_stub] + lines[l_end:]
-
-    log.info(f"writing updated module list to {createstubs}")
-    with open(createstubs, "w") as f:
-        f.writelines(lines)
-
-
-if __name__ == "__main__":
-    update_module_list()
+# pragma: no cover
+"""
+generate the list of modules that should be attempted to stub
+for this : 
+- combine the modules from the different texts files
+- split the lines into individual module names
+- combine them in one set
+- remove the ones than cannot be stubbed
+- remove test modules, ending in `_test`
+- write updates to:
+    - board/modulelist.txt
+    - board/createstubs.py 
+"""
+
+from pathlib import Path
+from typing import List, Optional, Set
+
+from mpflash.logger import log
+
+
+def read_modules(path: Optional[Path] = None) -> Set[str]:
+    """
+    read text files with modules per firmware.
+    each contains the output of help("modules")
+    - lines starting with # are comments.
+    - split the other lines at whitespace seperator,
+    - and add each module to a set
+    """
+    path = Path(path or "./data")
+    assert path
+    all_modules: Set[str] = set()
+    for file in path.glob("*.txt"):
+        log.debug(f"processing: {file.name}")
+        with file.open("r") as f:
+            while line := f.readline():
+                if len(line) > 1 and line[0] != "#":
+                    file_mods = line.split()
+                    log.trace(line[:-1])
+                    log.trace(set(file_mods))
+                    # remove modules ending in _test
+                    file_mods = [m for m in file_mods if not m.endswith("_test")]
+                    all_modules = set(all_modules | set(file_mods))
+    log.trace(">" * 40)
+    return {m.replace(".", "/") for m in all_modules}
+
+
+def update_module_list():
+    """
+    helper script
+    generate a few lines of code with all modules to be stubbed by createstubs
+    """
+    #######################################################################
+    # the exceptions
+    #######################################################################
+    mods_problematic = {
+        "upysh",
+        "webrepl_setup",
+        "http_client",
+        "http_client_ssl",
+        "http_server",
+        "http_server_ssl",
+    }
+    mods_excluded = {
+        "__main__",
+        "_main",
+        "_boot",
+        "webrepl",
+        "_webrepl",
+        "port_diag",
+        "example_sub_led",
+        "example_pub_button",
+        "upip",
+        "upip_utarfile",
+        "upysh",
+        "uasyncio",
+        "builtins",
+        "re",
+    }
+    log.info("Update the module list in createstubs.py")
+    all_modules = read_modules()
+    modules_to_stub = sorted(all_modules - set(mods_excluded | mods_problematic))
+
+    # remove pycom MQTT* from defaults
+    modules_to_stub = sorted({m for m in modules_to_stub if not m.startswith("MQTT")})
+
+    log.info(f"modules to stub : {len(modules_to_stub)}")
+    # log.debug(wrapped(modules_to_stub))
+    lines: List[str] = []
+    # update modules.txt
+    modules_txt = Path("src/stubber/board/modulelist.txt")
+    if modules_txt.exists():
+        with open(modules_txt) as f:
+            lines = f.readlines()
+            # only keep comment lines
+            lines = [l for l in lines if l[0] == "#"]
+    else:
+        lines = ["# list of modules to stub."]
+    lines += [m + "\n" for m in modules_to_stub]
+    log.info(f"writing module list to {modules_txt}")
+    with open(modules_txt, "w") as f:
+        f.writelines(lines)
+
+    # update createstubs.py
+    createstubs = Path("src/stubber/board/createstubs.py")
+    if createstubs.exists():
+        with open(createstubs) as f:
+            lines = f.readlines()
+
+    l_start = lines.index("    stubber.modules = [\n")
+    assert l_start
+    l_end = lines.index("    ]  # spell-checker: enable\n", l_start)
+    assert l_end
+
+    # Plug in the new list of modules
+    lines = lines[: l_start + 1] + [f'        "{m}",\n' for m in modules_to_stub] + lines[l_end:]
+
+    log.info(f"writing updated module list to {createstubs}")
+    with open(createstubs, "w") as f:
+        f.writelines(lines)
+
+
+if __name__ == "__main__":
+    update_module_list()

stubber/utils/__init__.py

@@ -1,6 +1,6 @@
-# type: ignore
-from mpflash.versions import checkedout_version, clean_version
-
-from .manifest import make_manifest, manifest
-from .post import do_post_processing
-from .stubmaker import generate_pyi_files, generate_pyi_from_file
+# type: ignore
+from mpflash.versions import checkedout_version, clean_version
+
+from .manifest import make_manifest, manifest
+from .post import do_post_processing
+from .stubmaker import generate_pyi_files, generate_pyi_from_file