Add type annotations for spin utils

stefanv · stefanv · commit f3861bc7f0c3 · 2024-05-08T16:08:03.000-07:00
With this in place, we can progressively add more type annotations. Closes #177
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -40,3 +40,8 @@ repos:
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: e5ea6670624c24f8321f6328ef3176dbba76db46 # forzen: v1.10.0
+    hooks:
+      - id: mypy
diff --git a/example_pkg/doc/conf.py b/example_pkg/doc/conf.py
@@ -13,7 +13,7 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+extensions: list[str] = []
 
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
diff --git a/pyproject.toml b/pyproject.toml
@@ -54,6 +54,8 @@ filterwarnings = [
 [tool.ruff]
 line-length = 88
 target-version = "py38"
+
+[tool.ruff.lint]
 select = [
     "C",
     "E",
diff --git a/spin/cmds/meson.py b/spin/cmds/meson.py
@@ -361,7 +361,7 @@ def _get_configured_command(command_name):
 )
 @click.option(
     "--gcov-format",
-    type=click.Choice(GcovReportFormat),
+    type=click.Choice([e.name for e in GcovReportFormat]),
     default="html",
     help=f"Format of the gcov report. Can be one of {', '.join(e.value for e in GcovReportFormat)}.",
 )
diff --git a/spin/cmds/util.py b/spin/cmds/util.py
@@ -7,8 +7,15 @@
 
 
 def run(
-    cmd, cwd=None, replace=False, sys_exit=True, output=True, echo=True, *args, **kwargs
-):
+    cmd: list[str],
+    cwd: str | None = None,
+    replace: bool = False,
+    sys_exit: bool = True,
+    output: bool = True,
+    echo: bool = True,
+    *args,
+    **kwargs,
+) -> subprocess.CompletedProcess:
     """Run a shell command.
 
     Parameters

Original file line number	Diff line number	Diff line change
`@@ -361,7 +361,7 @@ def _get_configured_command(command_name):`
`361`	`361`	`)`
`362`	`362`	`@click.option(`
`363`	`363`	`"--gcov-format",`
`364`		`- type=click.Choice(GcovReportFormat),`
	`364`	`+ type=click.Choice([e.name for e in GcovReportFormat]),`
`365`	`365`	`default="html",`
`366`	`366`	`help=f"Format of the gcov report. Can be one of {', '.join(e.value for e in GcovReportFormat)}.",`
`367`	`367`	`)`