Initial Type Checking Work

Author: DEKHTIARJonathan

.pre-commit-config.yaml

@@ -23,7 +23,7 @@ repos:
 
   # Run the Ruff linter.
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.2
+    rev: v0.11.11
     hooks:
       # Linter
       - id: ruff
@@ -33,10 +33,43 @@ repos:
       - id: ruff-format
         exclude: ^tests/artifacts/
 
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.15.0
+    # Use a Local Workflow to ensure that `mypy` picks up all the local up-to-date dependencies
+  - repo: local
     hooks:
-      - id: mypy
+      - args:
+          [
+            "run",
+            "--",
+            "--cache-fine-grained",
+            "--config-file",
+            "pyproject.toml",
+          ]
+        description: Static type checker for Python
+        # https://github.com/pre-commit/mirrors-mypy/blob/main/.pre-commit-hooks.yaml
+        entry: dmypy
+        id: mypy
+        language: system
+        name: mypy
+        require_serial: true
+        types_or: [python, pyi]
+
+  # - repo: https://github.com/pre-commit/mirrors-mypy
+  #   rev: v1.15.0
+  #   hooks:
+  #     - id: mypy
+  #       args: [
+  #         "--config-file",
+  #         "pyproject.toml",
+  #       ]
+  #       additional_dependencies:
+  #         - "deepdiff"
+  #         - "hypothesis"
+  #         - "packaging"
+  #         - "platformdirs"
+  #         - "pytest"
+  #         - "tomlkit"
+  #         - "tzlocal"
+  #         - "urwid"
 
   - repo: https://github.com/PyCQA/autoflake
     rev: v2.3.1  # check for the latest version

pyproject.toml

@@ -81,10 +81,6 @@ get-supported-configs = "variantlib.commands.plugins.get_supported_configs:get_s
 testpaths = ["tests/"]
 addopts = "-vvv --cov=variantlib --cov-report=term-missing --no-cov-on-fail"
 
-[tool.mypy]
-disallow_untyped_defs = true
-no_implicit_optional = true
-
 [[tool.mypy.overrides]]
 module = "tests.*"
 disallow_untyped_defs = false
@@ -100,3 +96,33 @@ extras = ["test"]
 commands = [
     ["pytest", "-nauto"],
 ]
+
+# ==== mypy ====
+[tool.mypy]
+exclude = [
+  ".github",
+  ".ipython",
+  ".hypothesis",
+  ".mypy_cache",
+  ".pytest_cache",
+  ".ruff_cache",
+  ".uv",
+  ".venv",
+  ".workdir",
+  "~/.cache",
+  "**/__pycache__/**",
+  "assets",
+  "dist",
+  "tests",
+]
+check_untyped_defs = true
+disable_error_code = "method-assign"
+disallow_untyped_defs = true
+follow_untyped_imports = true
+no_implicit_optional = true
+python_version = "3.13"
+scripts_are_modules = true
+strict = true
+warn_unused_ignores = true
+warn_redundant_casts = true
+warn_unused_configs = true

variantlib/api.py

@@ -43,7 +43,7 @@
 
 def get_variant_hashes_by_priority(
     *,
-    variants_json: dict | VariantsJson,
+    variants_json: dict[str, VariantDescription] | VariantsJson,
     use_auto_install: bool = True,
     isolated: bool = True,
     venv_path: str | pathlib.Path | None = None,

variantlib/cache.py

@@ -9,16 +9,16 @@
     from collections.abc import Callable
 
 T = TypeVar("T")
+RT = TypeVar("RT")
 
 
-class VariantCache(Generic[T]):
+class VariantCache(Generic[RT]):
     """This class is not necessary today - can be used for finer cache control later."""
 
-    def __init__(self) -> None:
-        self.cache: T | None = None
+    cache: RT | None = None
 
-    def __call__(self, func: Callable) -> Callable:
-        def wrapper(*args: Any, **kwargs: dict[str, Any]) -> T:
+    def __call__(self, func: Callable[[T], RT]) -> Callable[[T], RT]:
+        def wrapper(*args: Any, **kwargs: dict[str, Any]) -> RT:
             if self.cache is None:
                 self.cache = func(*args, **kwargs)
             return self.cache

variantlib/commands/analyze_wheel.py

@@ -67,11 +67,14 @@ def analyze_wheel(args: list[str]) -> None:
     )
 
     with zipfile.ZipFile(input_file, "r") as zip_file:
-        # original_xml_data = xmltodict.parse(zip_file.open("Data.xml").read())
         for name in zip_file.namelist():
             if name.endswith(".dist-info/METADATA"):
                 metadata_str = zip_file.open(name).read().decode("utf-8")
                 break
+        else:
+            raise FileNotFoundError(
+                f"Impossible to find the `METADATA` file inside `{input_file}`."
+            )
 
         # Extract the hash value
         hash_match = re.search(rf"{METADATA_VARIANT_HASH_HEADER}: (\w+)", metadata_str)

variantlib/commands/config/list_paths.py

@@ -9,10 +9,10 @@
 from variantlib.configuration import get_configuration_files
 
 try:
-    from tzlocal import get_localzone
+    from tzlocal import get_localzone  # pyright: ignore[reportAssignmentType]
 except ImportError:
 
-    def get_localzone() -> None:
+    def get_localzone() -> None:  # type: ignore[misc]
         return None
 
 

variantlib/commands/config/main.py

@@ -33,4 +33,4 @@ def main(args: list[str]) -> None:
     parser.parse_args(args=args, namespace=namespace)
 
     main_fn = registered_commands[namespace.command].load()
-    return main_fn(namespace.args)
+    main_fn(namespace.args)

variantlib/commands/config/setup.py

@@ -214,7 +214,7 @@ def setup(args: list[str]) -> None:
                 "property_priorities",
             ):
                 # Always use multiline output for readability.
-                toml_data[key].multiline(multiline=True)
+                toml_data[key].multiline(multiline=True)  # type: ignore[union-attr]
 
             ui.clear()
             sys.stderr.write(

variantlib/commands/config/setup_interfaces/urwid_ui.py

@@ -1,3 +1,8 @@
+# URWID doesn't explicitly export symbols at the top level
+# Disabling errors to prevent noise.
+
+# mypy: disable-error-code="attr-defined,name-defined"
+
 from __future__ import annotations
 
 import sys
@@ -92,10 +97,11 @@ def input_handler(key: str) -> None:
         )
         listbox = urwid.ListBox(urwid.SimpleListWalker([text_widget]))
         scrollable = urwid.ScrollBar(
-            listbox, trough_char=urwid.ScrollBar.Symbols.LITE_SHADE
+            listbox,  # pyright: ignore[reportArgumentType]
+            trough_char=urwid.ScrollBar.Symbols.LITE_SHADE,
         )
-        frame = urwid.Frame(scrollable, footer=footer)
-        loop = urwid.MainLoop(frame, self.palette, unhandled_input=input_handler)
+        frame = urwid.Frame(scrollable, footer=footer)  # type: ignore[var-annotated]
+        loop = urwid.MainLoop(frame, self.palette, unhandled_input=input_handler)  # type: ignore[arg-type]
         try:
             loop.run()
         except KeyboardInterrupt:
@@ -156,11 +162,11 @@ def input_handler(cls, key: str) -> None:
             urwid.Padding(
                 urwid.AttrMap(urwid.LineBox(listbox), "dialog"),
                 align=urwid.CENTER,
-                width=(urwid.RELATIVE, 50),
+                width=(urwid.RELATIVE, 50),  # type: ignore[arg-type]
             ),
             height=height,
         )
-        loop = urwid.MainLoop(frame, self.palette, unhandled_input=State.input_handler)
+        loop = urwid.MainLoop(frame, self.palette, unhandled_input=State.input_handler)  # type: ignore[arg-type]
         loop.run()
         return State.retval
 
@@ -178,7 +184,7 @@ def update_key(
         ]
         required_values_set = set(known_values) if known_values_required else set()
 
-        class MovableCheckBox(urwid.CheckBox):
+        class MovableCheckBox(urwid.CheckBox):  # type: ignore[misc]
             def __init__(self, *args: Any, required: bool, **kwargs: Any):
                 super().__init__(*args, **kwargs)
                 self.mcb_required = required
@@ -191,27 +197,21 @@ def keypress(self, size: tuple[int], key: str) -> str | None:
                 if key in ("f7", "tab"):
                     old_pos = value_box.focus_position
                     if old_pos != 0:
-                        item = value_box.body.pop(old_pos)
-                        value_box.body.insert(old_pos - 1, item)
-                        if old_pos != len(value_box.body) - 1:
+                        item = value_box.body.pop(old_pos)  # pyright: ignore[reportAttributeAccessIssue]
+                        value_box.body.insert(old_pos - 1, item)  # pyright: ignore[reportAttributeAccessIssue]
+                        if old_pos != len(value_box.body) - 1:  # type: ignore[arg-type]
                             value_box.focus_position -= 1
                     return None
 
                 if key in ("f8",):
                     old_pos = value_box.focus_position
-                    if old_pos != len(value_box.body) - 1:
-                        item = value_box.body.pop(old_pos)
-                        value_box.body.insert(old_pos + 1, item)
+                    if old_pos != len(value_box.body) - 1:  # type: ignore[arg-type]
+                        item = value_box.body.pop(old_pos)  # pyright: ignore[reportAttributeAccessIssue]
+                        value_box.body.insert(old_pos + 1, item)  # pyright: ignore[reportAttributeAccessIssue]
                         value_box.focus_position += 1
                     return None
 
-                return super().keypress(size, key)
-
-        def input_handler(key: str) -> None:
-            if key in ("s", "S"):
-                value_box.focus_position = len(value_box) - 2
-            if key in ("esc", "a", "A"):
-                value_box.focus_position = len(value_box) - 1
+                return super().keypress(size, key)  # type: ignore[no-any-return]
 
         def save_button(_: Any) -> None:
             raise urwid.ExitMainLoop
@@ -242,32 +242,39 @@ def abort_button(_: Any) -> None:
                 ]
             )
         )
-        listbox = urwid.Frame(
+        listbox = urwid.Frame(  # type: ignore[var-annotated]
             urwid.ScrollBar(
-                urwid.AttrMap(value_box, "list"),
+                urwid.AttrMap(value_box, "list"),  # pyright: ignore[reportArgumentType]
                 trough_char=urwid.ScrollBar.Symbols.LITE_SHADE,
             ),
-            header=urwid.Text(INSTRUCTIONS[key]),
+            header=urwid.Text(INSTRUCTIONS[key]),  # type: ignore[arg-type]
         )
         frame = urwid.Filler(
             urwid.Padding(
                 urwid.AttrMap(urwid.LineBox(listbox, title=key), "dialog"),
                 align=urwid.CENTER,
-                width=(urwid.RELATIVE, 100),
+                width=(urwid.RELATIVE, 100),  # type: ignore[arg-type]
                 left=2,
                 right=2,
             ),
             valign=urwid.MIDDLE,
-            height=(urwid.RELATIVE, 100),
+            height=(urwid.RELATIVE, 100),  # type: ignore[arg-type]
             top=2,
             bottom=2,
         )
-        loop = urwid.MainLoop(frame, self.palette, unhandled_input=input_handler)
+
+        def input_handler(key: str) -> None:
+            if key in ("s", "S"):
+                value_box.focus_position = len(value_box) - 2  # pyright: ignore[reportArgumentType]
+            if key in ("esc", "a", "A"):
+                value_box.focus_position = len(value_box) - 1  # pyright: ignore[reportArgumentType]
+
+        loop = urwid.MainLoop(frame, self.palette, unhandled_input=input_handler)  # type: ignore[arg-type]
         loop.run()
 
         new_values = [
             item.base_widget.label
-            for item in value_box.body
+            for item in value_box.body  # pyright: ignore[reportGeneralTypeIssues]
             if isinstance(item, urwid.AttrMap)
             and isinstance(item.base_widget, MovableCheckBox)
             and item.base_widget.get_state()

variantlib/commands/index_json_utils.py

@@ -63,7 +63,7 @@ def append_variant_info_to_json_file(
     if path.exists():
         data = json.loads(path.read_text())
 
-    for key, default_val in [  # type: ignore[var-annotated]
+    for key, default_val in [
         (VARIANTS_JSON_SCHEMA_KEY, VARIANTS_JSON_SCHEMA_URL),
         (VARIANTS_JSON_VARIANT_DATA_KEY, {}),
         (

variantlib/commands/main.py

@@ -46,4 +46,4 @@ def main() -> None:
     parser.parse_args(namespace=namespace)
 
     main_fn = registered_commands[namespace.command].load()
-    return main_fn(namespace.args)
+    main_fn(namespace.args)

variantlib/commands/plugins/main.py

@@ -35,4 +35,4 @@ def main(args: list[str]) -> None:
 
     with EntryPointPluginLoader() as loader:
         main_fn = registered_commands[namespace.command].load()
-        return main_fn(namespace.args, plugin_loader=loader)
+        main_fn(namespace.args, plugin_loader=loader)

variantlib/configuration.py

@@ -8,7 +8,6 @@
 from pathlib import Path
 from typing import TYPE_CHECKING
 from typing import Any
-from typing import Callable
 from typing import TypeVar
 
 import platformdirs
@@ -20,6 +19,8 @@
 from variantlib.utils import classproperty
 
 if TYPE_CHECKING:
+    from collections.abc import Callable
+
     from variantlib.models.variant import VariantFeature
     from variantlib.models.variant import VariantProperty
 

variantlib/dist_metadata.py

@@ -30,14 +30,8 @@
 from variantlib.validators.base import validate_matches_re
 
 if TYPE_CHECKING:
-    import sys
     from email.message import Message
 
-    if sys.version_info >= (3, 11):
-        pass
-    else:
-        pass
-
 
 @dataclass(init=False)
 class DistMetadata(VariantMetadata):

variantlib/models/base.py

@@ -1,15 +1,12 @@
-from dataclasses import dataclass
-from typing import TYPE_CHECKING
+from __future__ import annotations
 
-if TYPE_CHECKING:
-    from dataclasses import Field
+from dataclasses import dataclass
 
 
 @dataclass(frozen=True)
 class BaseModel:
     def __post_init__(self) -> None:
         # Execute the validator
-        field_def: Field
         for field_name, field_def in self.__dataclass_fields__.items():
             value = getattr(self, field_name)
             if (validator := field_def.metadata.get("validator", None)) is not None: