More basedpyright progress

Author: multiplemonomials

tools/pyproject.toml

@@ -224,12 +224,17 @@ include = [
 # We will allow code where the types of things are partially unknown, as there is
 # lots of legacy code in that category.
 # Also the PlatformIO code has to work with SCons, which is fundamentally type
-# annotation proof, so that can likely never pass these checks.
+# annotation proof, so it can likely never pass these checks.
 reportUnknownVariableType = false
 reportUnknownMemberType = false
 reportUnknownLambdaType = false
 reportMissingTypeArgument = false
 reportUnknownArgumentType = false
 reportUnknownParameterType = false
 reportAny = false
-reportExplicitAny = false
+reportExplicitAny = false
+
+# Use "medium strict" member variable annotation rules, where the type checker
+# is allowed to infer the types of class variables based on what gets assigned in __init__
+reportIncompatibleUnannotatedOverride = true
+reportUnannotatedClassAttribute = false

tools/python/mbed_tools/cli/main.py

@@ -66,8 +66,12 @@ def print_version(context: click.Context, _param: Union[click.Option, click.Para
     count=True,
     help="Set the verbosity level, enter multiple times to increase verbosity.",
 )
-def cli(verbose: int) -> None:
+@click.option("-t", "--traceback", is_flag=True, show_default=True, help="Show a traceback when an error is raised.")
+def cli(verbose: int, _traceback: bool) -> None:
     """Command line tool for interacting with Mbed OS."""
+    # note: traceback parameter not used here but is accessed through
+    # click.context.params in GroupWithExceptionHandling
+
     set_log_level(verbose)
 
 

tools/python/mbed_tools/project/_internal/git_utils.py

@@ -7,9 +7,10 @@
 import logging
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Optional
+from typing import Callable, Optional, TypedDict, Union
 
 import git
+from typing_extensions import NotRequired
 
 from mbed_tools.project._internal.progress import ProgressReporter
 from mbed_tools.project.exceptions import VersionControlError
@@ -52,13 +53,25 @@ def clone(url: str, dst_dir: Path, ref: Optional[str] = None, depth: int = 1) ->
         msg = f"{dst_dir} exists and is not an empty directory."
         raise VersionControlError(msg)
 
-    clone_from_kwargs = {"url": url, "to_path": str(dst_dir), "progress": ProgressReporter(name=url), "depth": depth}
+    class CloneFromKwargs(TypedDict):
+        url: str
+        to_path: str
+        progress: Callable[[int, Union[str, float], Union[str, float, None], str], None]
+        depth: int
+        branch: NotRequired[str]
+
+    clone_from_kwargs: CloneFromKwargs = {
+        "url": url,
+        "to_path": str(dst_dir),
+        "progress": ProgressReporter(name=url),
+        "depth": depth,
+    }
     if ref:
         clone_from_kwargs["branch"] = ref
 
     try:
         return git.Repo.clone_from(**clone_from_kwargs)
-    except git.exc.GitCommandError as err:
+    except git.GitCommandError as err:
         msg = f"Cloning git repository from url '{url}' failed. Error from VCS: {err}"
         raise VersionControlError(msg) from err
 
@@ -77,7 +90,7 @@ def checkout(repo: git.Repo, ref: str, force: bool = False) -> None:
     try:
         git_args = [ref, "--force"] if force else [ref]
         repo.git.checkout(*git_args)
-    except git.exc.GitCommandError as err:
+    except git.GitCommandError as err:
         msg = f"Failed to check out revision '{ref}'. Error from VCS: {err}"
         raise VersionControlError(msg) from err
 
@@ -95,7 +108,7 @@ def fetch(repo: git.Repo, ref: str) -> None:
     """
     try:
         repo.git.fetch("origin", ref)
-    except git.exc.GitCommandError as err:
+    except git.GitCommandError as err:
         msg = f"Failed to fetch. Error from VCS: {err}"
         raise VersionControlError(msg) from err
 
@@ -115,7 +128,7 @@ def init(path: Path) -> git.Repo:
     """
     try:
         return git.Repo.init(str(path))
-    except git.exc.GitCommandError as err:
+    except git.GitCommandError as err:
         msg = f"Failed to initialise git repository at path '{path}'. Error from VCS: {err}"
         raise VersionControlError(msg) from err
 
@@ -135,7 +148,7 @@ def get_repo(path: Path) -> git.Repo:
     """
     try:
         return git.Repo(str(path))
-    except git.exc.InvalidGitRepositoryError as err:
+    except git.InvalidGitRepositoryError as err:
         msg = "Could not find a valid git repository at this path. Please perform a `git init` command."
         raise VersionControlError(msg) from err
 
@@ -155,6 +168,6 @@ def get_default_branch(repo: git.Repo) -> str:
     """
     try:
         return str(repo.git.symbolic_ref("refs/remotes/origin/HEAD").rsplit("/", maxsplit=1)[-1])
-    except git.exc.GitCommandError as err:
+    except git.GitCommandError as err:
         msg = f"Could not resolve default repository branch name. Error from VCS: {err}"
         raise VersionControlError(msg) from err

tools/python/mbed_tools/project/_internal/libraries.py

@@ -124,7 +124,7 @@ def _clone_at_ref(url: str, path: Path, ref: str) -> None:
     if ref:
         logger.info(f"Checking out revision {ref} for library {url}.")
         try:
-            git_utils.clone(url, path, ref)
+            _ = git_utils.clone(url, path, ref)
         except VersionControlError:
             # We weren't able to clone. Try again without the ref.
             repo = git_utils.clone(url, path)
@@ -135,4 +135,4 @@ def _clone_at_ref(url: str, path: Path, ref: str) -> None:
             git_utils.fetch(repo, ref)
             git_utils.checkout(repo, "FETCH_HEAD")
     else:
-        git_utils.clone(url, path)
+        _ = git_utils.clone(url, path)

tools/python/mbed_tools/project/_internal/progress.py

@@ -4,11 +4,16 @@
 #
 """Progress bar for git operations."""
 
+from __future__ import annotations
+
 import sys
 from typing import Any, Optional
 
 from git import RemoteProgress
 from tqdm import tqdm
+from typing_extensions import override
+
+from mbed_tools.project.exceptions import VersionControlError
 
 
 class ProgressBar(tqdm):
@@ -27,12 +32,14 @@ def update_progress(self, block_num: float = 1, block_size: float = 1, total_siz
         """
         if total_size is not None and self.total != total_size:
             self.total = total_size
-        self.update(block_num * block_size - self.n)
+        _ = self.update(block_num * block_size - self.n)
 
 
 class ProgressReporter(RemoteProgress):
     """GitPython RemoteProgress subclass that displays a progress bar for git fetch and push operations."""
 
+    bar: Optional[ProgressBar] = None
+
     def __init__(self, *args: Any, name: str = "", **kwargs: Any) -> None:
         """
         Initialiser.
@@ -43,19 +50,30 @@ def __init__(self, *args: Any, name: str = "", **kwargs: Any) -> None:
         self.name = name
         super().__init__(*args, **kwargs)
 
-    def update(self, op_code: int, cur_count: float, max_count: Optional[float] = None, _message: str = "") -> None:
+    @override
+    def update(
+        self, op_code: int, cur_count: str | float, max_count: str | float | None = None, message: str = ""
+    ) -> None:
         """
         Called whenever the progress changes.
 
         Args:
             op_code: Integer describing the stage of the current operation.
             cur_count: Current item count.
             max_count: Maximum number of items expected.
-            _message: Message string describing the number of bytes transferred in the WRITING operation.
+            message: Message string describing the number of bytes transferred in the WRITING operation.
         """
+        cur_count = float(cur_count)
+        if max_count is not None:
+            max_count = float(max_count)
+
         if self.BEGIN & op_code:
             self.bar = ProgressBar(total=max_count, file=sys.stderr, leave=False)
 
+        if self.bar is None:
+            err_message = "Did not get BEGIN opcode from git first!"
+            raise VersionControlError(err_message)
+
         self.bar.desc = f"{self.name} {self._cur_line}"
         self.bar.update_progress(block_num=cur_count, total_size=max_count)
 

tools/python/mbed_tools/project/_internal/project_data.py

@@ -4,18 +4,11 @@
 #
 """Objects representing Mbed program and library data."""
 
-import json
 import logging
 from dataclasses import dataclass
 from pathlib import Path
 from typing import Optional
 
-from mbed_tools.project._internal.render_templates import (
-    render_cmakelists_template,
-    render_gitignore_template,
-    render_main_cpp_template,
-)
-
 logger = logging.getLogger(__name__)
 
 # Mbed program file names and constants.
@@ -63,44 +56,6 @@ class MbedProgramFiles:
     cmake_build_dir: Path
     custom_targets_json: Path
 
-    @classmethod
-    def from_new(cls, root_path: Path) -> "MbedProgramFiles":
-        """
-        Create MbedProgramFiles from a new directory.
-
-        A "new directory" in this context means it doesn't already contain an Mbed program.
-
-        Args:
-            root_path: The directory in which to create the program data files.
-
-        Raises:
-            ValueError: A program .mbed or mbed-os.lib file already exists at this path.
-        """
-        app_config = root_path / APP_CONFIG_FILE_NAME_JSON5
-        mbed_os_ref = root_path / MBED_OS_REFERENCE_FILE_NAME
-        cmakelists_file = root_path / CMAKELISTS_FILE_NAME
-        main_cpp = root_path / MAIN_CPP_FILE_NAME
-        gitignore = root_path / ".gitignore"
-        cmake_build_dir = root_path / BUILD_DIR
-        custom_targets_json = root_path / CUSTOM_TARGETS_JSON_FILE_NAME
-
-        if mbed_os_ref.exists():
-            msg = f"Program already exists at path {root_path}."
-            raise ValueError(msg)
-
-        app_config.write_text(json.dumps(DEFAULT_APP_CONFIG, indent=4))
-        mbed_os_ref.write_text(f"{MBED_OS_REFERENCE_URL}#{MBED_OS_REFERENCE_ID}")
-        render_cmakelists_template(cmakelists_file, root_path.stem)
-        render_main_cpp_template(main_cpp)
-        render_gitignore_template(gitignore)
-        return cls(
-            app_config_file=app_config,
-            mbed_os_ref=mbed_os_ref,
-            cmakelists_file=cmakelists_file,
-            cmake_build_dir=cmake_build_dir,
-            custom_targets_json=custom_targets_json,
-        )
-
     @classmethod
     def from_existing(cls, root_path: Path, build_dir: Path) -> "MbedProgramFiles":
         """

tools/python/mbed_tools/project/_internal/render_templates.py

@@ -4,49 +4,13 @@
 #
 """Render jinja templates required by the project package."""
 
-import datetime
 from pathlib import Path
 
 import jinja2
 
 TEMPLATES_DIRECTORY = Path("_internal", "templates")
 
 
-def render_cmakelists_template(cmakelists_file: Path, program_name: str) -> None:
-    """
-    Render CMakeLists.tmpl with the copyright year and program name as the app target name.
-
-    Args:
-        cmakelists_file: The path where CMakeLists.txt will be written.
-        program_name: The name of the program, will be used as the app target name.
-    """
-    cmakelists_file.write_text(
-        render_jinja_template(
-            "CMakeLists.tmpl", {"program_name": program_name, "year": str(datetime.datetime.now().year)}
-        )
-    )
-
-
-def render_main_cpp_template(main_cpp: Path) -> None:
-    """
-    Render a basic main.cpp which prints a hello message and returns.
-
-    Args:
-        main_cpp: Path where the main.cpp file will be written.
-    """
-    main_cpp.write_text(render_jinja_template("main.tmpl", {"year": str(datetime.datetime.now().year)}))
-
-
-def render_gitignore_template(gitignore: Path) -> None:
-    """
-    Write out a basic gitignore file ignoring the build and config directory.
-
-    Args:
-        gitignore: The path where the gitignore file will be written.
-    """
-    gitignore.write_text(render_jinja_template("gitignore.tmpl", {}))
-
-
 def render_jinja_template(template_name: str, context: dict) -> str:
     """
     Render a jinja template.