micropython-stubber 1.16.2__py3-none-any.whl → 1.17.0__py3-none-any.whl

stubber/rst/reader.py

@@ -83,6 +83,7 @@ from stubber.rst import (
 )
 from stubber.rst.lookup import Fix
 from stubber.utils.config import CONFIG
+from stubber.utils.versions import V_PREVIEW
 
 SEPERATOR = "::"
 
@@ -506,7 +507,7 @@ class RSTParser(RSTReader):
             # Add link to online documentation
             # https://docs.micropython.org/en/v1.17/library/array.html
             if "nightly" in self.source_tag:
-                version = "latest"
+                version = V_PREVIEW
             else:
                 version = self.source_tag.replace(
                     "_", "."

stubber/stubber.py

@@ -4,8 +4,8 @@
 """Create, Process, and Maintain stubs ✏️  for MicroPython"""
 
 
-from stubber.commands.cli import stubber_cli
 from stubber.commands.build_cmd import cli_build
+from stubber.commands.cli import stubber_cli
 from stubber.commands.clone_cmd import cli_clone
 from stubber.commands.config_cmd import cli_config
 from stubber.commands.enrich_folder_cmd import cli_enrich_folder
@@ -22,7 +22,6 @@ 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
 
-
 ##########################################################################################
 if __name__ == "__main__":
     # add all commands to the CLI
@@ -33,13 +32,13 @@ 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_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_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_update_module_list)
+    # stubber_cli.add_command(cli_update_fallback)
     stubber_cli.add_command(cli_variants)
     stubber_cli()

stubber/update_fallback.py

@@ -9,6 +9,8 @@ from typing import List, Optional, Tuple
 
 from loguru import logger as log
 
+from stubber.utils.versions import V_PREVIEW
+
 # log = logging.getLogger()
 
 RELEASED = "v1_18"
@@ -24,7 +26,7 @@ def fallback_sources(version: str, fw_version: Optional[str] = None) -> List[Tup
     """
     if not fw_version:
         fw_version = version
-    if fw_version == "latest":
+    if fw_version == V_PREVIEW:
         fw_version = RELEASED
     SOURCES = [
         ("uasyncio", f"micropython-{fw_version}-esp32"),

stubber/update_module_list.py

@@ -100,7 +100,7 @@ def update_module_list():
         "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))
 

stubber/utils/__init__.py

@@ -2,4 +2,4 @@
 from .manifest import make_manifest, manifest
 from .post import do_post_processing
 from .stubmaker import generate_pyi_files, generate_pyi_from_file
-from .versions import clean_version
+from .versions import checkedout_version, clean_version

stubber/utils/config.py

@@ -2,12 +2,14 @@
 
 from pathlib import Path
 
+from loguru import logger as log
 from typedconfig.config import Config, key, section
 from typedconfig.source import EnvironmentConfigSource
-from .typed_config_toml import TomlConfigSource
 
-from loguru import logger as log
 import stubber.basicgit as git
+from stubber.utils.versions import V_PREVIEW
+
+from .typed_config_toml import TomlConfigSource
 
 
 @section("micropython-stubber")
@@ -16,9 +18,7 @@ class StubberConfig(Config):
     stub_path = key(key_name="stub-path", cast=Path, required=False, default=Path("./stubs"))
     "a Path to the stubs directory"
     # relative to stubs folder
-    fallback_path = key(
-        key_name="fallback-path", cast=Path, required=False, default=Path("typings/fallback")
-    )
+    fallback_path = key(key_name="fallback-path", cast=Path, required=False, default=Path("typings/fallback"))
     "a Path to the fallback stubs directory"
 
     # ------------------------------------------------------------------------------------------
@@ -29,9 +29,7 @@ class StubberConfig(Config):
     mpy_path = key(key_name="mpy-path", cast=Path, required=False, default=Path("micropython"))
     "a Path to the micropython folder in the repos directory"
 
-    mpy_lib_path = key(
-        key_name="mpy-lib-path", cast=Path, required=False, default=Path("micropython-lib")
-    )
+    mpy_lib_path = key(key_name="mpy-lib-path", cast=Path, required=False, default=Path("micropython-lib"))
     "a Path to the micropython-lib folder in the repos directory"
 
     # mpy_stubs_repo_path = key(key_name="mpy-stubs-repo-path", cast=Path, required=False, default=Path("./micropython-stubs"))
@@ -96,7 +94,7 @@ class StubberConfig(Config):
             all_versions = ["1.19", "1.19.1", "1.20.0", "1.21.0"]
         config_updates.update(all_versions=all_versions)
         config_updates.update(
-            stable_version=[v for v in all_versions if not v.endswith("preview")][-1]
+            stable_version=[v for v in all_versions if not v.endswith(V_PREVIEW)][-1]
         )  # second last version - last version is the preview version
         return config_updates
 

stubber/utils/post.py

@@ -35,7 +35,7 @@ def run_black(path: Path, capture_output: bool = False):
         "--line-length",
         "140",
     ]
-    result = subprocess.run(cmd, capture_output=True, text=True)
+    result = subprocess.run(cmd, capture_output=True, text=True, encoding="utf-8")
 
     return result.returncode
 

stubber/utils/repos.py

@@ -13,6 +13,7 @@ from packaging.version import Version
 
 import stubber.basicgit as git
 from stubber.utils.config import CONFIG
+from stubber.utils.versions import SET_PREVIEW, V_PREVIEW
 
 # # log = logging.getLogger(__name__)
 
@@ -34,8 +35,8 @@ def switch(tag: str, *, mpy_path: Path, mpy_lib_path: Path):
     git.fetch(mpy_lib_path)
 
     if not tag or tag in {"master", ""}:
-        tag = "latest"
-    if tag == "latest":
+        tag = V_PREVIEW
+    if tag in SET_PREVIEW:
         git.switch_branch(repo=mpy_path, branch="master")
     else:
         git.checkout_tag(repo=mpy_path, tag=tag)
@@ -76,7 +77,7 @@ def match_lib_with_mpy(version_tag: str, mpy_path: Path, lib_path: Path) -> bool
     micropython_lib_commits = read_micropython_lib_commits()
     # Make sure that the correct micropython-lib release is checked out
     #  check if micropython-lib has matching tags
-    if version_tag == "latest":
+    if version_tag in SET_PREVIEW:
         # micropython-lib is now a submodule
         result = git.checkout_commit("master", lib_path)
         if not result:
@@ -88,8 +89,10 @@ def match_lib_with_mpy(version_tag: str, mpy_path: Path, lib_path: Path) -> bool
         # micropython-lib is now a submodule
         result = git.checkout_tag(version_tag, lib_path)
         if not result:
-            log.error("Could not checkout micropython-lib @master")
-            return False
+            log.warning(f"Could not checkout micropython-lib @{version_tag}")
+            if not git.checkout_tag("master", lib_path):
+                log.error("Could not checkout micropython-lib @master")
+                return False
         return git.sync_submodules(mpy_path)
     else:
         log.info(
@@ -109,10 +112,10 @@ def fetch_repos(tag: str, mpy_path: Path, mpy_lib_path: Path):
         log.trace("no stubs repo found : {CONFIG.stub_path.parent}")
 
     if not tag:
-        tag = "latest"
+        tag = V_PREVIEW
 
     log.info(f"Switching to {tag}")
-    if tag == "latest":
+    if tag == V_PREVIEW:
         git.switch_branch(repo=mpy_path, branch="master")
     else:
         git.checkout_tag(repo=mpy_path, tag=tag)

stubber/utils/versions.py

@@ -1,8 +1,21 @@
 """Handle versions of micropython based on the git tags in the repo """
 
+from pathlib import Path
+
 from github import Github
 from packaging.version import parse
 
+import stubber.basicgit as git
+import stubber.utils as utils
+
+OLDEST_VERSION = "1.16"
+"This is the oldest MicroPython version to build the stubs on"
+
+V_PREVIEW = "preview"
+"Latest preview version"
+
+SET_PREVIEW = {"preview", "latest", "master"}
+
 
 def clean_version(
     version: str,
@@ -15,9 +28,9 @@ def clean_version(
 ):
     "Clean up and transform the many flavours of versions"
     # 'v1.13.0-103-gb137d064e' --> 'v1.13-103'
-
     if version in {"", "-"}:
         return version
+    is_preview = "-preview" in version
     nibbles = version.split("-")
     ver_ = nibbles[0].lower().lstrip("v")
     if not patch and ver_ >= "1.10.0" and ver_ < "1.20.0" and ver_.endswith(".0"):
@@ -25,21 +38,35 @@ def clean_version(
         nibbles[0] = nibbles[0][:-2]
     if len(nibbles) == 1:
         version = nibbles[0]
-    elif build:
+    elif build and not is_preview:
         version = "-".join(nibbles) if commit else "-".join(nibbles[:-1])
     else:
         # version = "-".join((nibbles[0], LATEST))
         # HACK: this is not always right, but good enough most of the time
-        version = "latest"
+        if is_preview:
+            version = "-".join((nibbles[0], V_PREVIEW))
+        else:
+            version = V_PREVIEW
     if flat:
-        version = version.strip().replace(".", "_")
+        version = version.strip().replace(".", "_").replace("-", "_")
     else:
-        version = version.strip().replace("_", ".")
+        version = version.strip().replace("_preview", "-preview").replace("_", ".")
 
     if drop_v:
         version = version.lstrip("v")
-    elif not version.startswith("v") and version.lower() != "latest":
+    elif not version.startswith("v") and version.lower() not in SET_PREVIEW:
         version = "v" + version
+    if version == "latest":
+        version = V_PREVIEW
+    return version
+
+
+def checkedout_version(path: Path, flat: bool = False) -> str:
+    """Get the checked-out version of the repo"""
+    version = git.get_local_tag(path.as_posix())
+    if not version:
+        raise ValueError("No valid Tag found")
+    version = utils.clean_version(version, flat=flat, drop_v=False)
     return version
 
 
@@ -50,4 +77,18 @@ def micropython_versions(start: str = "v1.9.2"):
         repo = g.get_repo("micropython/micropython")
         return [tag.name for tag in repo.get_tags() if parse(tag.name) >= parse(start)]
     except Exception:
-        return ["v1.19.1", "v1.19", "v1.18", "v1.17", "v1.16", "v1.15", "v1.14", "v1.13", "v1.12", "v1.11", "v1.10", "v1.9.4", "v1.9.3"]
+        return [
+            "v1.19.1",
+            "v1.19",
+            "v1.18",
+            "v1.17",
+            "v1.16",
+            "v1.15",
+            "v1.14",
+            "v1.13",
+            "v1.12",
+            "v1.11",
+            "v1.10",
+            "v1.9.4",
+            "v1.9.3",
+        ]

stubber/variants.py

@@ -26,7 +26,7 @@ def create_variants(
     *,
     target_path: Optional[Path] = None,
     version: str = "",
-    make_variants: List[CreateStubsVariant] = ALL_VARIANTS,
+    make_variants: List[CreateStubsVariant] = ALL_VARIANTS[:3],
     update_modules: bool = True,
 ):
     """
@@ -50,7 +50,7 @@ def create_variants(
     ctx = codemod.CodemodContext()
     base_file = base_path / "createstubs.py"
     log.info(f"Reading : {base_file}")
-    base_txt = (base_path / "createstubs.py").read_text()
+    base_txt = (base_path / "createstubs.py").read_text(encoding="utf-8")
     base_module = cst.parse_module(base_txt)
 
     for var in make_variants:
@@ -89,7 +89,7 @@ def create_variants(
 
         # str -> path
         # read minified file
-        minified_txt = minified_path.read_text()
+        minified_txt = minified_path.read_text(encoding="utf-8")
         cross_compile(minified_txt, mpy_path, version=version)
 
 

stubber/board/logging.py

@@ -1,99 +0,0 @@
-import sys
-
-CRITICAL = 50
-ERROR = 40
-WARNING = 30
-INFO = 20
-DEBUG = 10
-NOTSET = 0
-
-_level_dict = {
-    CRITICAL: "CRIT",
-    ERROR: "ERROR",
-    WARNING: "WARN",
-    INFO: "INFO",
-    DEBUG: "DEBUG",
-}
-
-_stream = sys.stderr
-
-
-class Logger:
-
-    level = NOTSET
-
-    def __init__(self, name):
-        self.name = name
-
-    def _level_str(self, level):
-        l = _level_dict.get(level)
-        if l is not None:
-            return l
-        return "LVL%s" % level
-
-    def setLevel(self, level):
-        self.level = level
-
-    def isEnabledFor(self, level):
-        return level >= (self.level or _level)
-
-    def log(self, level, msg, *args):
-        if level >= (self.level or _level):
-            _stream.write("%-6s:%-8s:" % (self._level_str(level), self.name))
-            if not args:
-                print(msg, file=_stream)
-            else:
-                print(msg % args, file=_stream)
-
-    def debug(self, msg, *args):
-        self.log(DEBUG, msg, *args)
-
-    def info(self, msg, *args):
-        self.log(INFO, msg, *args)
-
-    def warning(self, msg, *args):
-        self.log(WARNING, msg, *args)
-
-    def error(self, msg, *args):
-        self.log(ERROR, msg, *args)
-
-    def critical(self, msg, *args):
-        self.log(CRITICAL, msg, *args)
-
-    # def exc(self, e, msg, *args):
-    #     self.log(ERROR, msg, *args)
-    #     sys.print_exception(e, _stream)  # type : disable
-
-    def exception(self, msg, *args):
-        self.critical(sys.exc_info()[1], msg, *args)
-
-
-_level = INFO
-_loggers = {}
-
-
-def getLogger(name):
-    if name in _loggers:
-        return _loggers[name]
-    l = Logger(name)
-    _loggers[name] = l
-    return l
-
-
-def info(msg, *args):
-    getLogger(None).info(msg, *args)
-
-
-def debug(msg, *args):
-    getLogger(None).debug(msg, *args)
-
-
-def basicConfig(level=INFO, filename=None, stream=None, format=None):
-    global _level, _stream
-    _level = level
-    if stream:
-        _stream = stream
-    if filename is not None:
-        print("logging.basicConfig: filename arg is not supported")
-    if format is not None:
-        print("logging.basicConfig: format arg is not supported")