micropython-stubber 1.19.0__py3-none-any.whl → 1.20.1__py3-none-any.whl

stubber/board/modulelist.txt

@@ -226,6 +226,7 @@ utimeq
 uwebsocket
 uzlib
 version
+vfs
 websocket
 websocket_helper
 wipy

stubber/commands/{mcu_cmd.py → get_mcu_cmd.py}

@@ -1,12 +1,16 @@
 """Deploy and run createstubs on one or more microcontrollers."""
+
 ##########################################################################################
 # stub
 ##########################################################################################
 
 
 import click
+from loguru import logger as log
 
 from stubber.bulk.mcu_stubber import stub_connected_mcus
+from stubber.utils.config import CONFIG
+
 from .cli import stubber_cli
 
 ##########################################################################################
@@ -32,8 +36,21 @@ from .cli import stubber_cli
     help="Python source or pre-compiled.",
 )
 @click.option("--debug/--no-debug", default=False, show_default=True, help="Debug mode.")
-@click.option("--reset/--no-reset", default=False, show_default=True, help="Reset the board before running createstubs.")
-@click.option("--github/--local", default=True, show_default=True, help="where to install the board files from. local is intended for development.")
-def cli_create_mcu_stubs(variant: str, format: str, debug: bool, reset:bool, github:bool) -> int:
+@click.option(
+    "--reset/--no-reset", default=False, show_default=True, help="Reset the board before running createstubs."
+)
+@click.option(
+    "--github/--local",
+    default=True,
+    show_default=True,
+    help="where to install the board files from. local is intended for development.",
+)
+def cli_create_mcu_stubs(variant: str, format: str, debug: bool, reset: bool, github: bool) -> int:
     """Run createstubs on one or more MCUs, and add the stubs to the micropython-stub repo."""
+    # check if all repos have been cloned
+    for repo in CONFIG.repos:
+        if not repo.exists():
+            log.error(f"Repo {repo} not found, use 'stubber clone --add-stubs' to clone the repos.")
+            exit(1)
+
     exit(stub_connected_mcus(variant=variant, format=format, debug=debug))

stubber/stubber.py

@@ -12,16 +12,12 @@ from stubber.commands.enrich_folder_cmd import cli_enrich_folder
 from stubber.commands.get_core_cmd import cli_get_core
 from stubber.commands.get_docstubs_cmd import cli_docstubs
 from stubber.commands.get_frozen_cmd import cli_get_frozen
-# from stubber.commands.get_lobo_cmd import cli_get_lobo
 from stubber.commands.merge_cmd import cli_merge_docstubs
-# from stubber.commands.minify_cmd import cli_minify
 from stubber.commands.publish_cmd import cli_publish
 from stubber.commands.stub_cmd import cli_stub
 from stubber.commands.switch_cmd import cli_switch
-# from stubber.commands.upd_fallback_cmd import cli_update_fallback
-# from stubber.commands.upd_module_list_cmd import cli_update_module_list
 from stubber.commands.variants_cmd import cli_variants
-from stubber.commands.mcu_cmd import cli_create_mcu_stubs
+from stubber.commands.get_mcu_cmd import cli_create_mcu_stubs
 
 ##########################################################################################
 if __name__ == "__main__":
@@ -33,14 +29,10 @@ if __name__ == "__main__":
     stubber_cli.add_command(cli_docstubs)
     stubber_cli.add_command(cli_get_core)
     stubber_cli.add_command(cli_get_frozen)
-    # stubber_cli.add_command(cli_get_lobo)
     stubber_cli.add_command(cli_stub)
     stubber_cli.add_command(cli_enrich_folder)
-    # stubber_cli.add_command(cli_minify)
     stubber_cli.add_command(cli_publish)
     stubber_cli.add_command(cli_merge_docstubs)
-    # stubber_cli.add_command(cli_update_module_list)
-    # stubber_cli.add_command(cli_update_fallback)
     stubber_cli.add_command(cli_variants)
     stubber_cli.add_command(cli_create_mcu_stubs)
     stubber_cli()

stubber/update_fallback.py

@@ -1,117 +1,117 @@
-"""build/update the fallback 'catch-all' stubfolder"""
+# """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
+# 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 loguru import logger as log
+# from loguru import logger as log
 
-from stubber.utils.versions import V_PREVIEW
+# from stubber.utils.versions import V_PREVIEW
 
-# log = logging.getLogger()
+# # log = logging.getLogger()
 
-RELEASED = "v1_18"
+# 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
+# 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
+#     """
+#     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
+# 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
+# if __name__ == "__main__":
+#     from stubber.utils.config import CONFIG
 
-    update_fallback(
-        CONFIG.stub_path,
-        CONFIG.fallback_path,
-        version=RELEASED,
-    )
+#     update_fallback(
+#         CONFIG.stub_path,
+#         CONFIG.fallback_path,
+#         version=RELEASED,
+#     )

stubber/utils/config.py

@@ -1,6 +1,7 @@
 """stubber configuration"""
 
 from pathlib import Path
+from typing import List
 
 from loguru import logger as log
 from typedconfig.config import Config, key, section
@@ -48,6 +49,11 @@ class StubberConfig(Config):
     BLOCKED_PORTS = ["minimal", "bare-arm"]
     "ports that should be ignored as a source of stubs"
 
+    @property
+    def repos(self) -> List[Path]:
+        "return the repo paths"
+        return [self.mpy_path, self.mpy_lib_path, self.mpy_stubs_path]
+
     @property
     def stub_path(self) -> Path:
         "return the stubs path in the microypthon-stubs repo"

stubber/commands/get_lobo_cmd.py

@@ -1,58 +0,0 @@
-"""
-get-lobo (frozen)
-"""
-
-from pathlib import Path
-from typing import List
-
-import click
-import stubber.get_lobo as get_lobo
-import stubber.utils as utils
-from loguru import logger as log
-from stubber.commands.cli import stubber_cli
-from stubber.utils.config import CONFIG
-
-
-@stubber_cli.command(name="get-lobo")
-@click.option(
-    "--stub-folder",
-    "-stubs",
-    default=CONFIG.stub_path.as_posix(),
-    type=click.Path(exists=True, file_okay=False, dir_okay=True),
-    show_default=True,
-)
-@click.option(
-    "--pyi/--no-pyi",
-    default=True,
-    help="Create .pyi files for the (new) frozen modules",
-    show_default=True,
-)
-@click.option(
-    "--black/--no-black",
-    default=True,
-    help="Run black on the (new) frozen modules",
-    show_default=True,
-)
-def cli_get_lobo(
-    stub_folder: str = CONFIG.stub_path.as_posix(),
-    pyi: bool = True,
-    black: bool = True,
-):
-    """
-    Get the frozen stubs for Lobo-esp32.
-
-    """
-    log.info("Get the frozen modules Loboris v3.2.24")
-
-    stub_paths: List[Path] = []
-
-    family = "loboris"
-    version = "v3.2.24"
-    stub_path = Path(stub_folder) / f"{family}-{utils.clean_version(version, flat=True)}-frozen"
-    stub_paths.append(stub_path)
-    get_lobo.get_frozen(stub_path)
-    stub_paths = [stub_path]
-
-    log.info("::group:: start post processing of retrieved stubs")
-    utils.do_post_processing(stub_paths, stubgen=pyi, black=black, autoflake=True)
-    log.info("::group:: Done")

stubber/commands/minify_cmd.py

@@ -1,60 +0,0 @@
-"""Minify createstubs*.py."""
-##########################################################################################
-# minify
-##########################################################################################
-from pathlib import Path
-from typing import Union
-
-import click
-from loguru import logger as log
-from stubber.minify import minify, cross_compile
-import stubber
-
-from .cli import stubber_cli
-
-
-@stubber_cli.command(name="minify")
-@click.option("--source", "-s", default="createstubs.py", type=click.Path(file_okay=True, dir_okay=False), show_default=True)
-@click.option("--diff", "-d", help="Show the functional changes made to the source script.", default=False, is_flag=True)
-@click.option("--compile", "-c", "-xc", "compile", help="Cross compile after minification.", default=False, is_flag=True)
-@click.option("--all", "-a", help="Minify all variants (normal, _mem and _db).", default=False, is_flag=True)
-@click.option(
-    "--report/--no-report",
-    "keep_report",
-    help="Keep or disable minimal progress reporting in the minified version.",
-    default=True,
-    show_default=True,
-)
-@click.pass_context
-def cli_minify(
-    ctx: click.Context,
-    source: Union[str, Path],
-    keep_report: bool,
-    diff: bool,
-    compile: bool,
-    all: bool,
-) -> int:
-    """
-    Minify createstubs*.py.
-
-    Creates a minified version of the SOURCE micropython file in TARGET (file or folder).
-    The goal is to use less memory / not to run out of memory, while generating MCU stubs.
-    """
-    if all:
-        sources = ["createstubs.py", "createstubs_mem.py", "createstubs_db.py"]
-    else:
-        sources = [source]
-    log.trace(f"sources: {sources}")
-    for source in sources:
-        # TODO: Check if module resources should not be retrieved via API (e.g. via importlib.resources)
-        src = Path(stubber.__file__).parent / "board" / source
-        dst = src.with_name(src.stem + "_min.py")
-        min_dest = src.with_name(src.stem + "_mpy.mpy")
-        log.info(f"\nMinifying {src}...")
-        minify(src, dst, keep_report, diff)
-        if compile:
-            log.info("Cross compiling...")
-            cross_compile(dst, min_dest)
-
-    log.info("Done!")
-    return 0

stubber/commands/upd_fallback_cmd.py

@@ -1,36 +0,0 @@
-"""
-update-fallback folder with common set of stubs that cater for most of the devices
-"""
-
-import click
-from pathlib import Path
-from stubber.update_fallback import update_fallback, RELEASED
-from stubber.utils.config import CONFIG
-
-from .cli import stubber_cli
-
-
-@stubber_cli.command(name="update-fallback")
-@click.option("--version", default=RELEASED, type=str, help="Version number to use", show_default=True)
-@click.option(
-    "--stub-folder",
-    default=CONFIG.stub_path.as_posix(),
-    type=click.Path(exists=True, file_okay=False, dir_okay=True),
-    help="Destination of the files to be generated.",
-    show_default=True,
-)
-def cli_update_fallback(
-    version: str,
-    stub_folder: str = CONFIG.stub_path.as_posix(),
-):
-    """
-    Update the fallback stubs.
-
-    The fallback stubs are updated/collated from files of the firmware-stubs, doc-stubs and core-stubs.
-    """
-    stub_path = Path(stub_folder)
-    update_fallback(
-        stub_path,
-        CONFIG.fallback_path,
-        version=version,
-    )

stubber/commands/upd_module_list_cmd.py

@@ -1,18 +0,0 @@
-"""
-update-fallback folder with common set of stubs that cater for most of the devices
-"""
-
-from stubber.update_module_list import update_module_list as update_module_list
-
-from .cli import stubber_cli
-
-
-@stubber_cli.command(
-    name="update-module-list",
-    help="Update the module list based on the information in the data folder",
-)
-def cli_update_module_list():
-    """
-    Update the module list based on the information in the data folder.
-    """
-    update_module_list()