chore: code improvements

Author: Josverl

src/stubber/basicgit.py

@@ -38,26 +38,26 @@ def _run_git(
         elif capture_output and echo_output:  # pragma: no cover
             log.error(stderr)
         if not expect_stderr:
-            raise Exception(stderr)
+            raise ChildProcessError(stderr)
 
     if result.returncode < 0:
-        raise Exception(result.stderr.decode("utf-8"))
+        raise ChildProcessError(result.stderr.decode("utf-8"))
     return result
 
 
 def clone(remote_repo: str, path: Path, shallow=False, tag: Optional[str] = None) -> bool:
-    "git clone [--depth 1] [--branch <tag_name>] <remote> <directory>"
+    """git clone [--depth 1] [--branch <tag_name>] <remote> <directory>"""
     cmd = ["git", "clone"]
     if shallow:
         cmd += ["--depth", "1"]
     if tag in ("latest", "master"):
         tag = None
-    if not tag:
-        cmd += [remote_repo, str(path)]
-    else:
-        cmd += [remote_repo, "--branch", tag, str(path)]
-    result = _run_git(cmd, expect_stderr=True, capture_output=False)
-    if result:
+    cmd += (
+        [remote_repo, "--branch", tag, str(path)]
+        if tag
+        else [remote_repo, str(path)]
+    )
+    if result := _run_git(cmd, expect_stderr=True, capture_output=False):
         return result.returncode == 0
     else:
         return False
@@ -81,10 +81,11 @@ def get_tag(repo: Optional[Union[str, Path]] = None, abbreviate: bool = True) ->
     tag: str = result.stdout.decode("utf-8")
     tag = tag.replace("\r", "").replace("\n", "")
     if abbreviate and "-" in tag:
-        # this may or not be the latest on the main branch
-        # result = _run_git(["git", "rev-parse", "--abbrev-ref", "HEAD"], repo=repo, expect_stderr=True)
-        result = _run_git(["git", "status", "--branch"], repo=repo.as_posix(), expect_stderr=True)
-        if result:
+        if result := _run_git(
+            ["git", "status", "--branch"],
+            repo=repo.as_posix(),
+            expect_stderr=True,
+        ):
             lines = result.stdout.decode("utf-8").replace("\r", "").split("\n")
             if lines[0].startswith("On branch"):
                 if lines[0].endswith("master"):
@@ -134,11 +135,11 @@ def synch_submodules(repo: Optional[Union[Path, str]] = None) -> bool:
         ["git", "submodule", "update", "--quiet"],
     ]
     for cmd in cmds:
-        result = _run_git(cmd, repo=repo, expect_stderr=True)
-        if not result:
+        if result := _run_git(cmd, repo=repo, expect_stderr=True):
+            # actually a good result
+            log.debug(result.stderr.decode("utf-8"))
+        else:
             return False
-        # actually a good result
-        log.debug(result.stderr.decode("utf-8"))
     return True
 
 
@@ -203,9 +204,7 @@ def fetch(repo: Union[Path, str]) -> bool:
 
     cmd = ["git", "fetch", "--all", "--tags", "--quiet"]
     result = _run_git(cmd, repo=repo, echo_output=False)
-    if not result:
-        return False
-    return result.returncode == 0
+    return result.returncode == 0 if result else False
 
 
 def pull(repo: Union[Path, str], branch="main") -> bool:

src/stubber/utils/config.py

@@ -42,7 +42,7 @@ class StubberConfig(Config):
     "list of recent versions"
 
     def post_read_hook(self) -> dict:
-        config_updates = dict()
+        config_updates = {}
         # relative to stubs
         config_updates.update(fallback_path=self.stub_path / self.fallback_path)
 

src/stubber/utils/manifest.py

@@ -37,7 +37,7 @@ def manifest(
         firmware = firmware.replace("--", "-")
         firmware = firmware.replace("--", "-")
 
-    mod_manifest = {
+    return {
         "$schema": "https://raw.githubusercontent.com/Josverl/micropython-stubber/main/data/schema/stubber-v1_4_0.json",
         "firmware": {
             "family": family,
@@ -56,7 +56,6 @@ def manifest(
         },
         "modules": [],
     }
-    return mod_manifest
 
 
 def make_manifest(folder: Path, family: str, port: str, version: str, release: str = "", stubtype: str = "", board: str = "") -> bool:
@@ -65,7 +64,7 @@ def make_manifest(folder: Path, family: str, port: str, version: str, release: s
     try:
         # list all *.py files, not strictly modules but decent enough for documentation
         files = list(folder.glob("**/*.py"))
-        if len(files) == 0:
+        if not files:
             files = list(folder.glob("**/*.pyi"))
 
         # sort the list

src/stubber/utils/repos.py

@@ -26,7 +26,7 @@ def switch(tag: str, *, mpy_path: Path, mpy_lib_path: Path):
     git.fetch(mpy_path)
     git.fetch(mpy_lib_path)
 
-    if not tag or tag in ["master", ""]:
+    if not tag or tag in {"master", ""}:
         tag = "latest"
     if tag == "latest":
         git.switch_branch(repo=mpy_path, branch="master")
@@ -48,7 +48,7 @@ def read_micropython_lib_commits(filename="data/micropython_tags.csv"):
     """
     data = pkgutil.get_data("stubber", filename)
     if not data:
-        raise Exception(f"Resource {filename} not found")
+        raise FileNotFoundError(f"Resource {filename} not found")
     version_commit = defaultdict()  # lgtm [py/multiple-definition]
     with tempfile.NamedTemporaryFile(prefix="tags", suffix=".csv", mode="w+t") as ntf:
         ntf.file.write(data.decode(encoding="utf8"))

src/stubber/utils/stubmaker.py

@@ -57,7 +57,7 @@ def generate_pyi_files(modules_folder: Path) -> bool:
     # stubgen cannot process folders with duplicate modules ( ie v1.14 and v1.15 )
     # NOTE: FIX 1 add __init__.py to umqtt
     if (modules_folder / "umqtt/robust.py").exists():  # and not (freeze_path / "umqtt" / "__init__.py").exists():
-        log.debug(f"add missing : umqtt/__init__.py")
+        log.debug("add missing : umqtt/__init__.py")
         with open(modules_folder / "umqtt" / "__init__.py", "a") as f:
             f.write("")
 
@@ -68,7 +68,6 @@ def generate_pyi_files(modules_folder: Path) -> bool:
         for mod_manifest in modlist:
             ## generate fyi files for folder
             r = r and generate_pyi_files(mod_manifest.parent)
-        return r
     else:  # one or less module manifests
         ## generate fyi files for folder
         log.debug("::group::[stubgen] running stubgen on {0}".format(modules_folder))
@@ -113,4 +112,5 @@ def generate_pyi_files(modules_folder: Path) -> bool:
         for py in py_files:
             r = r and generate_pyi_from_file(py)
             # todo: report failures by adding to module manifest
-        return r
+
+    return r

src/stubber/utils/typed_config_toml.py

@@ -60,7 +60,6 @@ def __init__(self, filename: str, prefix: Optional[str] = None, must_exist: bool
                 self.data = {}
 
         # Quick checks on data format
-
         assert isinstance(self.data, Dict)
         for k, v in self.data.items():
             assert isinstance(k, str)

src/stubber/utils/versions.py

@@ -14,20 +14,16 @@ def clean_version(
     "Clean up and transform the many flavours of versions"
     # 'v1.13.0-103-gb137d064e' --> 'v1.13-103'
 
-    if version in ["", "-"]:
+    if version in {"", "-"}:
         return version
     nibbles = version.split("-")
-    if not patch:
-        if nibbles[0] >= "1.10.0" and nibbles[0].endswith(".0"):
+    if not patch and nibbles[0] >= "1.10.0" and nibbles[0].endswith(".0"):
             # remove the last ".0"
-            nibbles[0] = nibbles[0][0:-2]
+        nibbles[0] = nibbles[0][:-2]
     if len(nibbles) == 1:
         version = nibbles[0]
     elif build:
-        if not commit:
-            version = "-".join(nibbles[0:-1])
-        else:
-            version = "-".join(nibbles)
+        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
@@ -39,19 +35,15 @@ def clean_version(
 
     if drop_v:
         version = version.lstrip("v")
-    else:
-        # prefix with `v` but not before latest
-        if not version.startswith("v") and version.lower() != "latest":
-            version = "v" + version
+    elif not version.startswith("v") and version.lower() != "latest":
+        version = "v" + version
     return version
 
 
 def micropython_versions(start="v1.9.2"):
-    g = Github()
-    repo = g.get_repo("micropython/micropython")
-    return [tag.name for tag in repo.get_tags() if parse(tag.name) >= parse(start)]
-
-
-# def micropython_versions():
-#     "static version"
-#     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']
+    try:
+        g = Github()
+        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']