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

stubber/utils/config.py

@@ -1,127 +1,127 @@
-"""stubber configuration"""
-
-from pathlib import Path
-from typing import List
-
-from loguru import logger as log
-from typedconfig.config import Config, key, section
-from typedconfig.source import EnvironmentConfigSource
-
-import stubber.basicgit as git
-from stubber.utils.versions import V_PREVIEW
-
-from .typed_config_toml import TomlConfigSource
-
-
-@section("micropython-stubber")
-class StubberConfig(Config):
-    "stubber configuration class"
-    # relative to stubs folder
-    fallback_path: Path = key(key_name="fallback-path", cast=Path, required=False, default=Path("typings/fallback"))
-    "a Path to the fallback stubs directory"
-
-    # ------------------------------------------------------------------------------------------
-    # micropython and micropython-lib are relative to ./repo folder
-    repo_path: Path = key(key_name="repo-path", cast=Path, required=False, default=Path("./repos"))
-    "a Path to the repo directory"
-
-    mpy_path: 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: 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_path: Path = key(key_name="mpy-stubs-path", cast=Path, required=False, default=Path("micropython-stubs"))
-    "a Path to the micropython-stubs folder in the repos directory (or current directory)"
-
-    stable_version: str = key(key_name="stable-version", cast=str, required=False, default="1.20.0")
-
-    "last published stable"
-
-    all_versions = key(
-        key_name="all-versions",
-        cast=list,
-        required=False,
-        default=["1.17", "1.18", "1.19", "1.19.1", "1.20.0"],
-    )
-    "list of recent versions"
-
-    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"
-        return self.mpy_stubs_path / "stubs"
-
-    @property
-    def publish_path(self) -> Path:
-        "return the stubs path in the microypthon-stubs repo"
-        return self.mpy_stubs_path / "publish"
-
-    @property
-    def template_path(self) -> Path:
-        "return the stubs path in the microypthon-stubs repo"
-        return self.mpy_stubs_path / "publish" / "template"
-
-    def post_read_hook(self) -> dict:
-        config_updates = {}
-        # relative to stubs
-        # config_updates.update(fallback_path=self.stub_path / self.fallback_path)
-
-        # relative to repo path
-        config_updates.update(mpy_path=self.repo_path / self.mpy_path)
-        config_updates.update(mpy_lib_path=self.repo_path / self.mpy_lib_path)
-        if self.mpy_stubs_path.is_absolute() or self.mpy_stubs_path == Path("."):
-            config_updates.update(mpy_stubs_path=self.mpy_stubs_path)
-        else:
-            config_updates.update(mpy_stubs_path=self.repo_path / self.mpy_stubs_path)
-        # read the versions from the git tags
-        all_versions = []
-        try:
-            all_versions = git.get_tags("micropython/micropython", minver="v1.17")
-        except Exception as e:
-            log.warning(f"Could not read micropython versions from git: {e}")
-            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(V_PREVIEW)][-1]
-        )  # second last version - last version is the preview version
-        return config_updates
-
-
-def readconfig(filename: str = "pyproject.toml", prefix: str = "tool.", must_exist: bool = True):
-    "read the configuration from the pyproject.toml file"
-    # locate the pyproject.toml file
-    path = Path.cwd()
-    use_toml = True
-    while not (path / filename).exists():
-        path = path.parent
-        if path == path.parent:
-            log.trace(f"Could not find config file: {filename}")
-            use_toml = False
-            break
-
-    filename = str(path / filename)
-
-    config = StubberConfig()
-    # add provider sources to the config
-    config.add_source(EnvironmentConfigSource())
-    if use_toml:
-        config.add_source(
-            TomlConfigSource(filename, prefix=prefix, must_exist=must_exist)
-        )  # ,"tools.micropython-stubber"))
-    config.read()
-    return config
-
-
-#######################
-# config singleton
-CONFIG = readconfig()
-"stubber configuration singleton"
-#######################
+"""stubber configuration"""
+
+from pathlib import Path
+from typing import List
+
+from loguru import logger as log
+from typedconfig.config import Config, key, section
+from typedconfig.source import EnvironmentConfigSource
+
+import stubber.basicgit as git
+from stubber.utils.versions import V_PREVIEW
+
+from .typed_config_toml import TomlConfigSource
+
+
+@section("micropython-stubber")
+class StubberConfig(Config):
+    "stubber configuration class"
+    # relative to stubs folder
+    fallback_path: Path = key(key_name="fallback-path", cast=Path, required=False, default=Path("typings/fallback"))
+    "a Path to the fallback stubs directory"
+
+    # ------------------------------------------------------------------------------------------
+    # micropython and micropython-lib are relative to ./repo folder
+    repo_path: Path = key(key_name="repo-path", cast=Path, required=False, default=Path("./repos"))
+    "a Path to the repo directory"
+
+    mpy_path: 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: 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_path: Path = key(key_name="mpy-stubs-path", cast=Path, required=False, default=Path("micropython-stubs"))
+    "a Path to the micropython-stubs folder in the repos directory (or current directory)"
+
+    stable_version: str = key(key_name="stable-version", cast=str, required=False, default="1.20.0")
+
+    "last published stable"
+
+    all_versions = key(
+        key_name="all-versions",
+        cast=list,
+        required=False,
+        default=["1.17", "1.18", "1.19", "1.19.1", "1.20.0"],
+    )
+    "list of recent versions"
+
+    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"
+        return self.mpy_stubs_path / "stubs"
+
+    @property
+    def publish_path(self) -> Path:
+        "return the stubs path in the microypthon-stubs repo"
+        return self.mpy_stubs_path / "publish"
+
+    @property
+    def template_path(self) -> Path:
+        "return the stubs path in the microypthon-stubs repo"
+        return self.mpy_stubs_path / "publish" / "template"
+
+    def post_read_hook(self) -> dict:
+        config_updates = {}
+        # relative to stubs
+        # config_updates.update(fallback_path=self.stub_path / self.fallback_path)
+
+        # relative to repo path
+        config_updates.update(mpy_path=self.repo_path / self.mpy_path)
+        config_updates.update(mpy_lib_path=self.repo_path / self.mpy_lib_path)
+        if self.mpy_stubs_path.is_absolute() or self.mpy_stubs_path == Path("."):
+            config_updates.update(mpy_stubs_path=self.mpy_stubs_path)
+        else:
+            config_updates.update(mpy_stubs_path=self.repo_path / self.mpy_stubs_path)
+        # read the versions from the git tags
+        all_versions = []
+        try:
+            all_versions = git.get_tags("micropython/micropython", minver="v1.17")
+        except Exception as e:
+            log.warning(f"Could not read micropython versions from git: {e}")
+            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(V_PREVIEW)][-1]
+        )  # second last version - last version is the preview version
+        return config_updates
+
+
+def readconfig(filename: str = "pyproject.toml", prefix: str = "tool.", must_exist: bool = True):
+    "read the configuration from the pyproject.toml file"
+    # locate the pyproject.toml file
+    path = Path.cwd()
+    use_toml = True
+    while not (path / filename).exists():
+        path = path.parent
+        if path == path.parent:
+            log.trace(f"Could not find config file: {filename}")
+            use_toml = False
+            break
+
+    filename = str(path / filename)
+
+    config = StubberConfig()
+    # add provider sources to the config
+    config.add_source(EnvironmentConfigSource())
+    if use_toml:
+        config.add_source(
+            TomlConfigSource(filename, prefix=prefix, must_exist=must_exist)
+        )  # ,"tools.micropython-stubber"))
+    config.read()
+    return config
+
+
+#######################
+# config singleton
+CONFIG = readconfig()
+"stubber configuration singleton"
+#######################

stubber/utils/makeversionhdr.py

@@ -1,54 +1,54 @@
-"""
-Code from micropyton project and adapted to use the same versioning scheme
-"""
-
-from __future__ import print_function
-
-import subprocess
-from pathlib import Path
-from typing import Optional, Tuple, Union
-
-
-def get_version_info_from_git(path: Optional[Path] = None) -> Tuple[Union[str, None], Union[str, None]]:
-    """return the version info from the git repository specified.
-    returns: a 2-tuple containing git_tag, short_hash
-
-    """
-    path = path or Path.cwd()
-    # Note: git describe doesn't work if no tag is available
-    try:
-        git_tag = subprocess.check_output(
-            ["git", "describe", "--tags", "--dirty", "--always", "--match", "v[1-9].*"],
-            stderr=subprocess.STDOUT,
-            universal_newlines=True,
-            cwd=path,
-        ).strip()
-    except subprocess.CalledProcessError as er:  # pragma: no cover
-        if er.returncode == 128:
-            # git exit code of 128 means no repository found
-            return (None, None)
-        git_tag = ""
-    except OSError:
-        return (None, None)
-    try:
-        git_hash = subprocess.check_output(
-            ["git", "rev-parse", "--short", "HEAD"],
-            stderr=subprocess.STDOUT,
-            universal_newlines=True,
-        ).strip()
-    except subprocess.CalledProcessError:  # pragma: no cover
-        git_hash = "unknown"
-    except OSError:
-        return (None, None)
-
-    try:
-        # Check if there are any modified files.
-        subprocess.check_call(["git", "diff", "--no-ext-diff", "--quiet", "--exit-code"], stderr=subprocess.STDOUT)
-        # Check if there are any staged files.
-        subprocess.check_call(["git", "diff-index", "--cached", "--quiet", "HEAD", "--"], stderr=subprocess.STDOUT)  # pragma: no cover
-    except subprocess.CalledProcessError:
-        git_hash += "-dirty"
-    except OSError:
-        return (None, None)
-
-    return git_tag, git_hash
+"""
+Code from micropyton project and adapted to use the same versioning scheme
+"""
+
+from __future__ import print_function
+
+import subprocess
+from pathlib import Path
+from typing import Optional, Tuple, Union
+
+
+def get_version_info_from_git(path: Optional[Path] = None) -> Tuple[Union[str, None], Union[str, None]]:
+    """return the version info from the git repository specified.
+    returns: a 2-tuple containing git_tag, short_hash
+
+    """
+    path = path or Path.cwd()
+    # Note: git describe doesn't work if no tag is available
+    try:
+        git_tag = subprocess.check_output(
+            ["git", "describe", "--tags", "--dirty", "--always", "--match", "v[1-9].*"],
+            stderr=subprocess.STDOUT,
+            universal_newlines=True,
+            cwd=path,
+        ).strip()
+    except subprocess.CalledProcessError as er:  # pragma: no cover
+        if er.returncode == 128:
+            # git exit code of 128 means no repository found
+            return (None, None)
+        git_tag = ""
+    except OSError:
+        return (None, None)
+    try:
+        git_hash = subprocess.check_output(
+            ["git", "rev-parse", "--short", "HEAD"],
+            stderr=subprocess.STDOUT,
+            universal_newlines=True,
+        ).strip()
+    except subprocess.CalledProcessError:  # pragma: no cover
+        git_hash = "unknown"
+    except OSError:
+        return (None, None)
+
+    try:
+        # Check if there are any modified files.
+        subprocess.check_call(["git", "diff", "--no-ext-diff", "--quiet", "--exit-code"], stderr=subprocess.STDOUT)
+        # Check if there are any staged files.
+        subprocess.check_call(["git", "diff-index", "--cached", "--quiet", "HEAD", "--"], stderr=subprocess.STDOUT)  # pragma: no cover
+    except subprocess.CalledProcessError:
+        git_hash += "-dirty"
+    except OSError:
+        return (None, None)
+
+    return git_tag, git_hash

stubber/utils/manifest.py

@@ -1,92 +1,92 @@
-"""Create a `module.json` manifest listing all files/stubs in this folder and subfolders."""
-
-import json
-import os
-from pathlib import Path
-from typing import Optional
-
-from .. import __version__
-from .versions import clean_version
-
-# # log = logging.getLogger(__name__)
-# # logging.basicConfig(level=logging.INFO)
-
-
-def manifest(
-    family: str = "micropython",
-    stubtype: str = "frozen",
-    machine: Optional[str] = None,  # also frozen.variant
-    port: Optional[str] = None,
-    platform: Optional[str] = None,
-    sysname: Optional[str] = None,
-    nodename: Optional[str] = None,
-    version: Optional[str] = None,
-    release: Optional[str] = None,
-    firmware: Optional[str] = None,
-) -> dict:
-    "create a new empty manifest dict"
-
-    machine = machine or family  # family
-    port = port or "common"  # family
-    platform = platform or port  # family
-    version = version or "0.0.0"
-    sysname = sysname or ""
-    nodename = nodename or sysname or ""
-    release = release or version or ""
-    if firmware is None:
-        firmware = "{}-{}-{}".format(family, port, clean_version(version, flat=True))
-        # remove double dashes x2
-        firmware = firmware.replace("--", "-")
-        firmware = firmware.replace("--", "-")
-
-    return {
-        "$schema": "https://raw.githubusercontent.com/Josverl/micropython-stubber/main/data/schema/stubber-v1_4_0.json",
-        "firmware": {
-            "family": family,
-            "port": port,
-            "platform": platform,
-            "machine": machine,
-            "firmware": firmware,
-            "nodename": nodename,
-            "version": version,
-            "release": release,
-            "sysname": sysname,
-        },
-        "stubber": {
-            "version": __version__,
-            "stubtype": stubtype,
-        },
-        "modules": [],
-    }
-
-
-def make_manifest(folder: Path, family: str, port: str, version: str, release: str = "", stubtype: str = "", board: str = "") -> bool:
-    """Create a `module.json` manifest listing all files/stubs in this folder and subfolders."""
-    mod_manifest = manifest(family=family, port=port, machine=board, sysname=family, version=version, release=release, stubtype=stubtype)
-    try:
-        # list all *.py files, not strictly modules but decent enough for documentation
-        files = list(folder.glob("**/*.py"))
-        if not files:
-            files = list(folder.glob("**/*.pyi"))
-
-        # sort the list
-        for file in sorted(files):
-            # if file is in folder, then use relative path only
-            # use old style relative path determination to support # python 3.8
-            file = Path(os.path.relpath(file, start=folder))
-            # if file.is_relative_to(folder):
-            #     file = file.relative_to(folder)
-
-            mod_manifest["modules"].append(
-                {
-                    "file": file.as_posix(),
-                    "module": file.stem,
-                }
-            )
-
-        # write the the module manifest
-        with open(folder / "modules.json", "w") as outfile:
-            json.dump(mod_manifest, outfile, indent=4)
-        return True
-    except OSError:
-        return False
+"""Create a `module.json` manifest listing all files/stubs in this folder and subfolders."""
+
+import json
+import os
+from pathlib import Path
+from typing import Optional
+
+from .. import __version__
+from .versions import clean_version
+
+# # log = logging.getLogger(__name__)
+# # logging.basicConfig(level=logging.INFO)
+
+
+def manifest(
+    family: str = "micropython",
+    stubtype: str = "frozen",
+    machine: Optional[str] = None,  # also frozen.variant
+    port: Optional[str] = None,
+    platform: Optional[str] = None,
+    sysname: Optional[str] = None,
+    nodename: Optional[str] = None,
+    version: Optional[str] = None,
+    release: Optional[str] = None,
+    firmware: Optional[str] = None,
+) -> dict:
+    "create a new empty manifest dict"
+
+    machine = machine or family  # family
+    port = port or "common"  # family
+    platform = platform or port  # family
+    version = version or "0.0.0"
+    sysname = sysname or ""
+    nodename = nodename or sysname or ""
+    release = release or version or ""
+    if firmware is None:
+        firmware = "{}-{}-{}".format(family, port, clean_version(version, flat=True))
+        # remove double dashes x2
+        firmware = firmware.replace("--", "-")
+        firmware = firmware.replace("--", "-")
+
+    return {
+        "$schema": "https://raw.githubusercontent.com/Josverl/micropython-stubber/main/data/schema/stubber-v1_4_0.json",
+        "firmware": {
+            "family": family,
+            "port": port,
+            "platform": platform,
+            "machine": machine,
+            "firmware": firmware,
+            "nodename": nodename,
+            "version": version,
+            "release": release,
+            "sysname": sysname,
+        },
+        "stubber": {
+            "version": __version__,
+            "stubtype": stubtype,
+        },
+        "modules": [],
+    }
+
+
+def make_manifest(folder: Path, family: str, port: str, version: str, release: str = "", stubtype: str = "", board: str = "") -> bool:
+    """Create a `module.json` manifest listing all files/stubs in this folder and subfolders."""
+    mod_manifest = manifest(family=family, port=port, machine=board, sysname=family, version=version, release=release, stubtype=stubtype)
+    try:
+        # list all *.py files, not strictly modules but decent enough for documentation
+        files = list(folder.glob("**/*.py"))
+        if not files:
+            files = list(folder.glob("**/*.pyi"))
+
+        # sort the list
+        for file in sorted(files):
+            # if file is in folder, then use relative path only
+            # use old style relative path determination to support # python 3.8
+            file = Path(os.path.relpath(file, start=folder))
+            # if file.is_relative_to(folder):
+            #     file = file.relative_to(folder)
+
+            mod_manifest["modules"].append(
+                {
+                    "file": file.as_posix(),
+                    "module": file.stem,
+                }
+            )
+
+        # write the the module manifest
+        with open(folder / "modules.json", "w") as outfile:
+            json.dump(mod_manifest, outfile, indent=4)
+        return True
+    except OSError:
+        return False