micropython-stubber 1.20.5__py3-none-any.whl → 1.23.0__py3-none-any.whl

stubber/data/micropython_tags.csv

@@ -1,15 +1,15 @@
-version,            mpy_date,      lib_date,      lib_commit_hash,                            lib_commit_info
-"refs/tags/v1.9.3", "Nov  1 2017", "Nov 1, 2017", "2829d4adc968a7208d96fa762a9ab4c1b744f73d", "threading: Release 0.1"
-"refs/tags/v1.9.4", "May 11 2018", "May 11 2018", "f20d89c6aad9443a696561ca2a01f7ef0c8fb302", "logging: Release 0.3"
-"refs/tags/v1.10",  "Jan 26 2019", "May 11 2018", "f20d89c6aad9443a696561ca2a01f7ef0c8fb302", "logging: Release 0.3"
-"refs/tags/v1.11",  "May 29 2019", "Feb 25 2019", "b89114c8345e15d360c3707493450805c114bc8c", "Revert README: Add note that repository is unmaintained."
-"refs/tags/v1.12",  "Dec 20 2019", "Feb 25 2019", "b89114c8345e15d360c3707493450805c114bc8c", "Revert README: Add note that repository is unmaintained."
-"refs/tags/v1.13",  "Sep  2 2020", "Jul  8 2020", "7b1161dd1b07e870f09b75a4befc84a95d93e3b3", "logging: Add support for custom handlers"
-"refs/tags/v1.14",  "Feb  3 2021", "Sep  3 2020", "eae01bd4e4cd1b22d9ccfedbd6bf9d879f64d9bd", "logging: Add levelno entry to log record object/dict. …"
-"refs/tags/v1.15",  "Apr 19 2021", "Sep  3 2020", "eae01bd4e4cd1b22d9ccfedbd6bf9d879f64d9bd", "logging: Add levelno entry to log record object/dict. …"
-"refs/tags/v1.16",  "Jun 18 2021", "Jul 12 2020", "3c383f6d2864a4b39bbe4ceb2ae8f29b519c9afe", "aioble: Fix docs for subscribe (needs await)."
-"refs/tags/v1.17",  "Sep  2 2021", "Jul 12 2020", "3c383f6d2864a4b39bbe4ceb2ae8f29b519c9afe", "aioble: Fix docs for subscribe (needs await)."
-"refs/tags/v1.18",  "Jan 16 2022", "Nov 11 2021", "cdd260f0792d04a1ded99171b4c7a2582b7856b4",  "aioble/multitests: Add multitest for shutdown handlers."
-"refs/tags/v1.19",  "Jun 16 2022", "Jun 16 2022", "db4c739863e49fc874bdaae8aa8c316c7ed4276a",  "unittest: Version 0.9.0"
-"refs/tags/v1.19.1","Jun 16 2022", "Jun 16 2022", "db4c739863e49fc874bdaae8aa8c316c7ed4276a",  "unittest: Version 0.9.0"
-
+version,            mpy_date,      lib_date,      lib_commit_hash,                            lib_commit_info
+"refs/tags/v1.9.3", "Nov  1 2017", "Nov 1, 2017", "2829d4adc968a7208d96fa762a9ab4c1b744f73d", "threading: Release 0.1"
+"refs/tags/v1.9.4", "May 11 2018", "May 11 2018", "f20d89c6aad9443a696561ca2a01f7ef0c8fb302", "logging: Release 0.3"
+"refs/tags/v1.10",  "Jan 26 2019", "May 11 2018", "f20d89c6aad9443a696561ca2a01f7ef0c8fb302", "logging: Release 0.3"
+"refs/tags/v1.11",  "May 29 2019", "Feb 25 2019", "b89114c8345e15d360c3707493450805c114bc8c", "Revert README: Add note that repository is unmaintained."
+"refs/tags/v1.12",  "Dec 20 2019", "Feb 25 2019", "b89114c8345e15d360c3707493450805c114bc8c", "Revert README: Add note that repository is unmaintained."
+"refs/tags/v1.13",  "Sep  2 2020", "Jul  8 2020", "7b1161dd1b07e870f09b75a4befc84a95d93e3b3", "logging: Add support for custom handlers"
+"refs/tags/v1.14",  "Feb  3 2021", "Sep  3 2020", "eae01bd4e4cd1b22d9ccfedbd6bf9d879f64d9bd", "logging: Add levelno entry to log record object/dict. …"
+"refs/tags/v1.15",  "Apr 19 2021", "Sep  3 2020", "eae01bd4e4cd1b22d9ccfedbd6bf9d879f64d9bd", "logging: Add levelno entry to log record object/dict. …"
+"refs/tags/v1.16",  "Jun 18 2021", "Jul 12 2020", "3c383f6d2864a4b39bbe4ceb2ae8f29b519c9afe", "aioble: Fix docs for subscribe (needs await)."
+"refs/tags/v1.17",  "Sep  2 2021", "Jul 12 2020", "3c383f6d2864a4b39bbe4ceb2ae8f29b519c9afe", "aioble: Fix docs for subscribe (needs await)."
+"refs/tags/v1.18",  "Jan 16 2022", "Nov 11 2021", "cdd260f0792d04a1ded99171b4c7a2582b7856b4",  "aioble/multitests: Add multitest for shutdown handlers."
+"refs/tags/v1.19",  "Jun 16 2022", "Jun 16 2022", "db4c739863e49fc874bdaae8aa8c316c7ed4276a",  "unittest: Version 0.9.0"
+"refs/tags/v1.19.1","Jun 16 2022", "Jun 16 2022", "db4c739863e49fc874bdaae8aa8c316c7ed4276a",  "unittest: Version 0.9.0"
+

stubber/data/requirements-core-micropython.txt

@@ -1,38 +1,38 @@
-# list of modules to mimic micropython on CPython
-# micropython generally has more and more complete stubs
-
-micropython-cpython-ffi
-micropython-cpython-micropython
-micropython-cpython-array   # difference pcopy - micropython
-# micropython-cpython-uasyncio  # the uasyncIO stub has errors and does not fit Asyncio v3 
-micropython-cpython-ucollections
-micropython-cpython-uctypes
-micropython-cpython-uerrno
-micropython-cpython-uhashlib
-# micropython-cpython-uio # does not have the IOBase abstract class 
-micropython-cpython-ujson
-# micropython-cpython-ulogging
-micropython-cpython-uos
-# micropython-cpython-upip  # not really part of the core 
-micropython-cpython-ure
-micropython-cpython-uselect
-micropython-cpython-usocket
-micropython-cpython-ussl
-micropython-cpython-utime
-micropython-cpython-utimeq
-# micropython-cpython-utokenize # not on micropython 
-micropython-cpython-uzlib
-
-# below are on pypi ,but seem to be empty
-# micropython-cpython-array
-# micropython-cpython-btree
-# micropython-cpython-builtins
-# micropython-cpython-framebuf
-# micropython-cpython-gc
-# micropython-cpython-machine
-# micropython-cpython-network
-# micropython-cpython-micropython
-# micropython-cpython-sys
-# micropython-cpython-ucryptolib
-# micropython-cpython-uheapq
-# micropython-cpython-ustruct
+# list of modules to mimic micropython on CPython
+# micropython generally has more and more complete stubs
+
+micropython-cpython-ffi
+micropython-cpython-micropython
+micropython-cpython-array   # difference pcopy - micropython
+# micropython-cpython-uasyncio  # the uasyncIO stub has errors and does not fit Asyncio v3 
+micropython-cpython-ucollections
+micropython-cpython-uctypes
+micropython-cpython-uerrno
+micropython-cpython-uhashlib
+# micropython-cpython-uio # does not have the IOBase abstract class 
+micropython-cpython-ujson
+# micropython-cpython-ulogging
+micropython-cpython-uos
+# micropython-cpython-upip  # not really part of the core 
+micropython-cpython-ure
+micropython-cpython-uselect
+micropython-cpython-usocket
+micropython-cpython-ussl
+micropython-cpython-utime
+micropython-cpython-utimeq
+# micropython-cpython-utokenize # not on micropython 
+micropython-cpython-uzlib
+
+# below are on pypi ,but seem to be empty
+# micropython-cpython-array
+# micropython-cpython-btree
+# micropython-cpython-builtins
+# micropython-cpython-framebuf
+# micropython-cpython-gc
+# micropython-cpython-machine
+# micropython-cpython-network
+# micropython-cpython-micropython
+# micropython-cpython-sys
+# micropython-cpython-ucryptolib
+# micropython-cpython-uheapq
+# micropython-cpython-ustruct

stubber/data/requirements-core-pycopy.txt

@@ -1,39 +1,39 @@
-# list of modules to mimic micropython on CPython
-# pycopy generally has more and more complete stubs
-
-pycopy-cpython-ffi
-pycopy-cpython-micropython
-pycopy-cpython-uarray
-# pycopy-cpython-uasyncio # too many changes
-pycopy-cpython-ucollections
-pycopy-cpython-uctypes
-pycopy-cpython-uerrno
-pycopy-cpython-uhashlib
-# pycopy-cpython-uio # does not have the IOBase abstract class 
-pycopy-cpython-ujson
-# pycopy-cpython-ulogging 
-pycopy-cpython-uos
-pycopy-cpython-ure
-pycopy-cpython-uselect
-pycopy-cpython-usocket
-pycopy-cpython-ussl
-pycopy-cpython-utime
-pycopy-cpython-utimeq
-pycopy-cpython-utokenize
-pycopy-cpython-uzlib
-
-# pycopy-cpython-upip # this is a tool , not a core library
-
-# below are on pypi ,but seem to be empty
-# pycopy-cpython-array
-# pycopy-cpython-btree
-# pycopy-cpython-builtins
-# pycopy-cpython-framebuf
-# pycopy-cpython-gc
-# pycopy-cpython-machine
-# pycopy-cpython-network
-# pycopy-cpython-pycopy
-# pycopy-cpython-sys
-# pycopy-cpython-ucryptolib
-# pycopy-cpython-uheapq
-# pycopy-cpython-ustruct
+# list of modules to mimic micropython on CPython
+# pycopy generally has more and more complete stubs
+
+pycopy-cpython-ffi
+pycopy-cpython-micropython
+pycopy-cpython-uarray
+# pycopy-cpython-uasyncio # too many changes
+pycopy-cpython-ucollections
+pycopy-cpython-uctypes
+pycopy-cpython-uerrno
+pycopy-cpython-uhashlib
+# pycopy-cpython-uio # does not have the IOBase abstract class 
+pycopy-cpython-ujson
+# pycopy-cpython-ulogging 
+pycopy-cpython-uos
+pycopy-cpython-ure
+pycopy-cpython-uselect
+pycopy-cpython-usocket
+pycopy-cpython-ussl
+pycopy-cpython-utime
+pycopy-cpython-utimeq
+pycopy-cpython-utokenize
+pycopy-cpython-uzlib
+
+# pycopy-cpython-upip # this is a tool , not a core library
+
+# below are on pypi ,but seem to be empty
+# pycopy-cpython-array
+# pycopy-cpython-btree
+# pycopy-cpython-builtins
+# pycopy-cpython-framebuf
+# pycopy-cpython-gc
+# pycopy-cpython-machine
+# pycopy-cpython-network
+# pycopy-cpython-pycopy
+# pycopy-cpython-sys
+# pycopy-cpython-ucryptolib
+# pycopy-cpython-uheapq
+# pycopy-cpython-ustruct

stubber/downloader.py

@@ -1,36 +1,36 @@
-"""Download files from a public github repo"""
-# Copyright (c) 2020 Jos Verlinde
-# MIT license
-# pylint: disable= invalid-name
-import os
-
-import requests
-from loguru import logger as log
-
-# # log = logging.getLogger(__name__)
-# log.setLevel(level=logging.INFO)
-
-
-def download_file(url: str, module: str, folder: str = "./"):
-    "dowload a file from a public github repo"
-    local_filename = os.path.abspath(os.path.join(folder, module))
-    log.debug("Downloading {:<20} to {}".format(module, local_filename))
-    # NOTE the stream=True parameter below
-    with requests.get(url, stream=True) as r:
-        r.raise_for_status()
-        with open(local_filename, "wb") as f:
-            for chunk in r.iter_content(chunk_size=8192):
-                if chunk:  # filter out keep-alive new chunks
-                    f.write(chunk)
-                    # f.flush()
-    return local_filename
-
-
-def download_files(repo, frozen_modules, savepath):
-    "dowload multiple files from a public github repo"
-    if not os.path.exists(savepath):
-        os.makedirs(savepath)
-
-    for mod in frozen_modules:
-        url = repo.format(mod)
-        download_file(url, mod, savepath)
+"""Download files from a public github repo"""
+# Copyright (c) 2020 Jos Verlinde
+# MIT license
+# pylint: disable= invalid-name
+import os
+
+import requests
+from loguru import logger as log
+
+# # log = logging.getLogger(__name__)
+# log.setLevel(level=logging.INFO)
+
+
+def download_file(url: str, module: str, folder: str = "./"):
+    "dowload a file from a public github repo"
+    local_filename = os.path.abspath(os.path.join(folder, module))
+    log.debug("Downloading {:<20} to {}".format(module, local_filename))
+    # NOTE the stream=True parameter below
+    with requests.get(url, stream=True) as r:
+        r.raise_for_status()
+        with open(local_filename, "wb") as f:
+            for chunk in r.iter_content(chunk_size=8192):
+                if chunk:  # filter out keep-alive new chunks
+                    f.write(chunk)
+                    # f.flush()
+    return local_filename
+
+
+def download_files(repo, frozen_modules, savepath):
+    "dowload multiple files from a public github repo"
+    if not os.path.exists(savepath):
+        os.makedirs(savepath)
+
+    for mod in frozen_modules:
+        url = repo.format(mod)
+        download_file(url, mod, savepath)

stubber/freeze/common.py

@@ -1,68 +1,68 @@
-"""common functions for frozen stub generation"""
-
-import re
-import shutil
-from pathlib import Path
-from typing import Tuple
-
-from loguru import logger as log
-
-from stubber.publish.defaults import GENERIC_U
-
-
-def get_portboard(manifest_path: Path):
-    """
-    returns a 2-tuple of the port and board in the provided manifest path
-
-    raises an ValueError if neither a port or board can be found
-    """
-    # https://regex101.com/r/tv7JX4/1
-    re_pb = r".*micropython[\/\\]ports[\/\\](?P<port>[\w_-]*)([\/\\]boards[\/\\](?P<board>\w*))?[\/\\]"
-    mpy_port = mpy_board = ""
-    if matches := re.search(re_pb, manifest_path.absolute().as_posix()):
-        # port and board
-        mpy_port = str(matches["port"] or "")
-        mpy_board = str(matches["board"] or "")
-        return mpy_port, mpy_board
-    log.error(f"no port or board found in {manifest_path}")
-    raise (ValueError("Neither port or board found in path"))
-
-
-def get_freeze_path(stub_path: Path, port: str, board: str) -> Tuple[Path, str]:
-    """
-    get path to a folder to store the frozen stubs for the given port/board
-    """
-    if not port:
-        raise ValueError("port must be provided")
-
-    if not board:
-        board = GENERIC_U
-
-    if board == "manifest_release":
-        board = "RELEASE"
-    # set global for later use - must be an absolute path.
-    freeze_path = (stub_path / port / board.upper()).absolute()
-    return freeze_path, board.upper()
-
-
-def apply_frozen_module_fixes(freeze_path: Path, mpy_path: Path):
-    """
-    apply common fixes to the fozen modules to improve stub generation
-    """
-    # NOTE: FIX 1 add __init__.py to umqtt
-    if (freeze_path / "umqtt/robust.py").exists():  # and not (freeze_path / "umqtt" / "__init__.py").exists():
-        log.debug("add missing : umqtt/__init__.py")
-        with open(freeze_path / "umqtt" / "__init__.py", "a") as f:
-            f.write("")
-
-    # NOTE: FIX 2 compensate for expicitly omited task.py from freeze manifest
-    # this is normally implemented as a C module, let's use the .py version to generate a stub for this
-    if (freeze_path / "uasyncio").exists() and not (freeze_path / "uasyncio" / "task.py").exists():
-        # copy task.py from micropython\extmod\uasyncio\task.py to stub_folder
-        log.debug("add missing : uasyncio/task.py")
-        task_py = mpy_path / "extmod" / "uasyncio" / "task.py"
-        try:
-            shutil.copy(str(task_py), str(freeze_path / "uasyncio"))
-        except OSError as er:
-            log.warning(f"error copying {task_py} : {er}")
-            # try to continue
+"""common functions for frozen stub generation"""
+
+import re
+import shutil
+from pathlib import Path
+from typing import Tuple
+
+from loguru import logger as log
+
+from stubber.publish.defaults import GENERIC_U
+
+
+def get_portboard(manifest_path: Path):
+    """
+    returns a 2-tuple of the port and board in the provided manifest path
+
+    raises an ValueError if neither a port or board can be found
+    """
+    # https://regex101.com/r/tv7JX4/1
+    re_pb = r".*micropython[\/\\]ports[\/\\](?P<port>[\w_-]*)([\/\\]boards[\/\\](?P<board>\w*))?[\/\\]"
+    mpy_port = mpy_board = ""
+    if matches := re.search(re_pb, manifest_path.absolute().as_posix()):
+        # port and board
+        mpy_port = str(matches["port"] or "")
+        mpy_board = str(matches["board"] or "")
+        return mpy_port, mpy_board
+    log.error(f"no port or board found in {manifest_path}")
+    raise (ValueError("Neither port or board found in path"))
+
+
+def get_freeze_path(stub_path: Path, port: str, board: str) -> Tuple[Path, str]:
+    """
+    get path to a folder to store the frozen stubs for the given port/board
+    """
+    if not port:
+        raise ValueError("port must be provided")
+
+    if not board:
+        board = GENERIC_U
+
+    if board == "manifest_release":
+        board = "RELEASE"
+    # set global for later use - must be an absolute path.
+    freeze_path = (stub_path / port / board.upper()).absolute()
+    return freeze_path, board.upper()
+
+
+def apply_frozen_module_fixes(freeze_path: Path, mpy_path: Path):
+    """
+    apply common fixes to the fozen modules to improve stub generation
+    """
+    # NOTE: FIX 1 add __init__.py to umqtt
+    if (freeze_path / "umqtt/robust.py").exists():  # and not (freeze_path / "umqtt" / "__init__.py").exists():
+        log.debug("add missing : umqtt/__init__.py")
+        with open(freeze_path / "umqtt" / "__init__.py", "a") as f:
+            f.write("")
+
+    # NOTE: FIX 2 compensate for expicitly omited task.py from freeze manifest
+    # this is normally implemented as a C module, let's use the .py version to generate a stub for this
+    if (freeze_path / "uasyncio").exists() and not (freeze_path / "uasyncio" / "task.py").exists():
+        # copy task.py from micropython\extmod\uasyncio\task.py to stub_folder
+        log.debug("add missing : uasyncio/task.py")
+        task_py = mpy_path / "extmod" / "uasyncio" / "task.py"
+        try:
+            shutil.copy(str(task_py), str(freeze_path / "uasyncio"))
+        except OSError as er:
+            log.warning(f"error copying {task_py} : {er}")
+            # try to continue

stubber/freeze/freeze_folder.py

@@ -1,69 +1,69 @@
-"""get and parse the to-be-frozen .py modules for micropython to extract the static type information."""
-
-import glob
-import os
-import shutil
-import warnings
-from pathlib import Path  # start moving from os & glob to pathlib
-
-from loguru import logger as log
-from stubber.utils.repos import match_lib_with_mpy
-
-from .. import utils
-
-# Classes and functions from makemanifest to ensure that the manifest.py files can be processed
-from .common import get_freeze_path, get_portboard
-
-# globals
-FAMILY = "micropython"
-
-
-def freeze_folders(stub_folder: str, mpy_folder: str, lib_folder: str, version: str):
-    """
-    get and parse the to-be-frozen .py modules for micropython to extract the static type information
-    locates the to-be-frozen files in modules folders
-    - 'ports/<port>/modules/*.py'
-    - 'ports/<port>/boards/<board>/modules/*.py'
-    """
-    match_lib_with_mpy(version_tag=version, mpy_path=Path(mpy_folder),lib_path=Path(lib_folder))
-
-    targets = []
-    scripts = glob.glob(mpy_folder + "/ports/**/modules/*.py", recursive=True)
-    if len(scripts) > 0:
-        # clean target folder
-        shutil.rmtree(stub_folder, ignore_errors=True)
-    for script in scripts:
-        port, board = get_portboard(Path(script))
-
-        freeze_path, board = get_freeze_path(Path(stub_folder), port, board)
-        dest_path = freeze_path.as_posix()
-        # if board == "":
-        #     board = GENERIC
-
-        # dest_path = os.path.join(stub_folder, port, board)
-
-        log.debug("freeze_internal : {:<30} to {}".format(script, dest_path))
-        # ensure folder, including possible path prefix for script
-        os.makedirs(dest_path, exist_ok=True)
-        # copy file
-        try:
-            shutil.copy2(script, dest_path)
-            if dest_path not in targets:
-                targets.append(dest_path)
-        except OSError as e:
-            ## Ignore errors that are caused by reorganisation of Micropython-lib
-            # log.exception(e)
-            warnings.warn("unable to freeze {} due to error {}".format(e.filename, str(e)))
-
-    for dest_path in targets:
-        # make a module manifest
-        port = dest_path.split("/")[-2]
-        # todo: add board / variant into manifest files ?
-        utils.make_manifest(
-            Path(dest_path),
-            family=FAMILY,
-            port=port,
-            version=version,
-            stubtype="frozen",
-        )
-    return targets
+"""get and parse the to-be-frozen .py modules for micropython to extract the static type information."""
+
+import glob
+import os
+import shutil
+import warnings
+from pathlib import Path  # start moving from os & glob to pathlib
+
+from loguru import logger as log
+from stubber.utils.repos import match_lib_with_mpy
+
+from .. import utils
+
+# Classes and functions from makemanifest to ensure that the manifest.py files can be processed
+from .common import get_freeze_path, get_portboard
+
+# globals
+FAMILY = "micropython"
+
+
+def freeze_folders(stub_folder: str, mpy_folder: str, lib_folder: str, version: str):
+    """
+    get and parse the to-be-frozen .py modules for micropython to extract the static type information
+    locates the to-be-frozen files in modules folders
+    - 'ports/<port>/modules/*.py'
+    - 'ports/<port>/boards/<board>/modules/*.py'
+    """
+    match_lib_with_mpy(version_tag=version, mpy_path=Path(mpy_folder),lib_path=Path(lib_folder))
+
+    targets = []
+    scripts = glob.glob(mpy_folder + "/ports/**/modules/*.py", recursive=True)
+    if len(scripts) > 0:
+        # clean target folder
+        shutil.rmtree(stub_folder, ignore_errors=True)
+    for script in scripts:
+        port, board = get_portboard(Path(script))
+
+        freeze_path, board = get_freeze_path(Path(stub_folder), port, board)
+        dest_path = freeze_path.as_posix()
+        # if board == "":
+        #     board = GENERIC
+
+        # dest_path = os.path.join(stub_folder, port, board)
+
+        log.debug("freeze_internal : {:<30} to {}".format(script, dest_path))
+        # ensure folder, including possible path prefix for script
+        os.makedirs(dest_path, exist_ok=True)
+        # copy file
+        try:
+            shutil.copy2(script, dest_path)
+            if dest_path not in targets:
+                targets.append(dest_path)
+        except OSError as e:
+            ## Ignore errors that are caused by reorganisation of Micropython-lib
+            # log.exception(e)
+            warnings.warn("unable to freeze {} due to error {}".format(e.filename, str(e)))
+
+    for dest_path in targets:
+        # make a module manifest
+        port = dest_path.split("/")[-2]
+        # todo: add board / variant into manifest files ?
+        utils.make_manifest(
+            Path(dest_path),
+            family=FAMILY,
+            port=port,
+            version=version,
+            stubtype="frozen",
+        )
+    return targets