chore: better typing hints

mayeut · auvipy · commit 51e4a997e953 · 2025-02-11T14:58:42.000+06:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -34,6 +34,6 @@ repos:
   rev: v1.15.0
   hooks:
   - id: mypy
-    exclude: ^tests/integration/.*/.*$
+    exclude: ^tests/integration/.*/.*$|^scripts/calculate_symbol_versions.py$
     additional_dependencies:
       - types-requests
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,10 +6,26 @@ build-backend = "setuptools.build_meta"
 # enable version inference
 
 [tool.mypy]
-follow_imports = "silent"
-ignore_missing_imports = true
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = true
+disallow_untyped_defs = false
+enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
+extra_checks = true
+strict = false
+strict_equality = true
+warn_unused_configs = true
+warn_unreachable = false
 warn_unused_ignores = true
 
+[[tool.mypy.overrides]]
+module = "auditwheel.*"
+disallow_untyped_calls = true
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+warn_return_any = true
+
 [[tool.mypy.overrides]]
 module = "auditwheel._vendor.*"
 follow_imports = "skip"
diff --git a/src/auditwheel/architecture.py b/src/auditwheel/architecture.py
@@ -23,11 +23,11 @@ class Architecture(Enum):
     x86_64_v3 = "x86_64_v3"
     x86_64_v4 = "x86_64_v4"
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.value
 
     @property
-    def baseline(self):
+    def baseline(self) -> Architecture:
         if self.value.startswith("x86_64"):
             return Architecture.x86_64
         return self
diff --git a/src/auditwheel/condatools.py b/src/auditwheel/condatools.py
@@ -26,7 +26,7 @@ def __init__(self, in_conda_pkg: str) -> None:
         super().__init__(in_conda_pkg)
         self.path: str | None = None
 
-    def __enter__(self):
+    def __enter__(self):  # type: ignore[no-untyped-def]
         self.path = super().__enter__()
         return self
 
diff --git a/src/auditwheel/elfutils.py b/src/auditwheel/elfutils.py
@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from collections.abc import Iterator
+from collections.abc import Iterable, Iterator
 from os.path import basename
 from pathlib import Path
 
@@ -26,7 +26,7 @@ def elf_read_dt_needed(fn: str) -> list[str]:
     return needed
 
 
-def elf_file_filter(paths: Iterator[str]) -> Iterator[tuple[str, ELFFile]]:
+def elf_file_filter(paths: Iterable[str]) -> Iterator[tuple[str, ELFFile]]:
     """Filter through an iterator of filenames and load up only ELF
     files
     """
diff --git a/src/auditwheel/lddtree.py b/src/auditwheel/lddtree.py
@@ -311,7 +311,7 @@ def load_ld_paths(root: str = "/", prefix: str = "") -> dict[str, list[str]]:
     -------
     dict containing library paths to search
     """
-    ldpaths: dict = {"conf": [], "env": [], "interp": []}
+    ldpaths: dict[str, list[str]] = {"conf": [], "env": [], "interp": []}
 
     # Load up $LD_LIBRARY_PATH.
     env_ldpath = os.environ.get("LD_LIBRARY_PATH")
diff --git a/src/auditwheel/main.py b/src/auditwheel/main.py
@@ -50,5 +50,5 @@ def main() -> int | None:
     if not hasattr(args, "func"):
         p.print_help()
         return None
-
-    return args.func(args, p)
+    result: int | None = args.func(args, p)
+    return result
diff --git a/src/auditwheel/main_lddtree.py b/src/auditwheel/main_lddtree.py
@@ -6,15 +6,16 @@
 logger = logging.getLogger(__name__)
 
 
-def configure_subparser(sub_parsers):
+def configure_subparser(sub_parsers) -> None:  # type: ignore[no-untyped-def]
     help = "Analyze a single ELF file (similar to ``ldd``)."
     p = sub_parsers.add_parser("lddtree", help=help, description=help)
     p.add_argument("file", help="Path to .so file")
     p.set_defaults(func=execute)
 
 
-def execute(args, p: argparse.ArgumentParser):  # noqa: ARG001
+def execute(args: argparse.Namespace, p: argparse.ArgumentParser) -> int:  # noqa: ARG001
     from . import json
     from .lddtree import ldd
 
     logger.info(json.dumps(ldd(args.file)))
+    return 0
diff --git a/src/auditwheel/main_repair.py b/src/auditwheel/main_repair.py
@@ -12,7 +12,7 @@
 logger = logging.getLogger(__name__)
 
 
-def configure_parser(sub_parsers):
+def configure_parser(sub_parsers) -> None:  # type: ignore[no-untyped-def]
     wheel_policy = WheelPolicies()
     policies = wheel_policy.policies
     policy_names = [p["name"] for p in policies]
@@ -111,7 +111,7 @@ def configure_parser(sub_parsers):
     p.set_defaults(func=execute)
 
 
-def execute(args, parser: argparse.ArgumentParser):
+def execute(args: argparse.Namespace, parser: argparse.ArgumentParser) -> int:
     import os
 
     from .repair import repair_wheel
diff --git a/src/auditwheel/main_show.py b/src/auditwheel/main_show.py
@@ -8,7 +8,7 @@
 logger = logging.getLogger(__name__)
 
 
-def configure_parser(sub_parsers):
+def configure_parser(sub_parsers) -> None:  # type: ignore[no-untyped-def]
     help = "Audit a wheel for external shared library dependencies."
     p = sub_parsers.add_parser("show", help=help, description=help)
     p.add_argument("WHEEL_FILE", help="Path to wheel file.")
@@ -29,7 +29,7 @@ def printp(text: str) -> None:
     print("\n".join(wrap(text, break_long_words=False, break_on_hyphens=False)))
 
 
-def execute(args, parser: argparse.ArgumentParser):
+def execute(args: argparse.Namespace, parser: argparse.ArgumentParser) -> int:
     from os.path import basename, isfile
 
     from . import json
@@ -68,7 +68,7 @@ def execute(args, parser: argparse.ArgumentParser):
             "#fpectl-builds-vs-no-fpectl-builds)"
         )
         if args.verbose < 1:
-            return None
+            return 0
 
     if wheel_policy.get_priority_by_name(winfo.ucs_tag) < wheel_policy.priority_highest:
         printp(
@@ -77,15 +77,15 @@ def execute(args, parser: argparse.ArgumentParser):
             "manylinux1 tag."
         )
         if args.verbose < 1:
-            return None
+            return 0
 
     if (
         wheel_policy.get_priority_by_name(winfo.machine_tag)
         < wheel_policy.priority_highest
     ):
         printp("This wheel depends on unsupported ISA extensions.")
         if args.verbose < 1:
-            return None
+            return 0
 
     if len(libs_with_versions) == 0:
         printp(
@@ -107,7 +107,7 @@ def execute(args, parser: argparse.ArgumentParser):
             "a recent manylinux image."
         )
         if args.verbose < 1:
-            return None
+            return 0
 
     libs = winfo.external_refs[
         wheel_policy.get_policy_name(wheel_policy.priority_lowest)
diff --git a/src/auditwheel/policy/__init__.py b/src/auditwheel/policy/__init__.py
@@ -51,7 +51,7 @@ def __init__(
         if arch is None:
             arch = Architecture.get_native_architecture()
         policies = json.loads(_POLICY_JSON_MAP[libc].read_text())
-        self._policies = []
+        self._policies: list[dict[str, Any]] = []
         self._architecture = arch
         self._libc_variant = libc
         self._musl_policy = musl_policy
@@ -84,18 +84,18 @@ def architecture(self) -> Architecture:
         return self._architecture
 
     @property
-    def policies(self):
+    def policies(self):  # type: ignore[no-untyped-def]
         return self._policies
 
     @property
-    def priority_highest(self):
-        return max(p["priority"] for p in self._policies)
+    def priority_highest(self) -> int:
+        return max(int(p["priority"]) for p in self._policies)
 
     @property
-    def priority_lowest(self):
-        return min(p["priority"] for p in self._policies)
+    def priority_lowest(self) -> int:
+        return min(int(p["priority"]) for p in self._policies)
 
-    def get_policy_by_name(self, name: str) -> dict:
+    def get_policy_by_name(self, name: str) -> dict[str, Any]:
         matches = [
             p for p in self._policies if p["name"] == name or name in p["aliases"]
         ]
@@ -108,7 +108,7 @@ def get_policy_by_name(self, name: str) -> dict:
         return matches[0]
 
     def get_policy_name(self, priority: int) -> str:
-        matches = [p["name"] for p in self._policies if p["priority"] == priority]
+        matches = [str(p["name"]) for p in self._policies if p["priority"] == priority]
         if len(matches) == 0:
             msg = f"no policy with priority {priority} found"
             raise LookupError(msg)
@@ -118,7 +118,7 @@ def get_policy_name(self, priority: int) -> str:
         return matches[0]
 
     def get_priority_by_name(self, name: str) -> int:
-        return self.get_policy_by_name(name)["priority"]
+        return int(self.get_policy_by_name(name)["priority"])
 
     def versioned_symbols_policy(self, versioned_symbols: dict[str, set[str]]) -> int:
         def policy_is_satisfied(
@@ -161,7 +161,7 @@ def policy_is_satisfied(
 
     def lddtree_external_references(
         self, lddtree: DynamicExecutable, wheel_path: str
-    ) -> dict:
+    ) -> dict[str, dict[str, Any]]:
         def filter_libs(libs: frozenset[str], whitelist: set[str]) -> Generator[str]:
             for lib in libs:
                 if "ld-linux" in lib or lib in ["ld64.so.2", "ld64.so.1"]:
@@ -226,7 +226,7 @@ def get_req_external(libs: set[str], whitelist: set[str]) -> set[str]:
         return ret
 
 
-def _validate_pep600_compliance(policies) -> None:
+def _validate_pep600_compliance(policies) -> None:  # type: ignore[no-untyped-def]
     symbol_versions: dict[str, dict[str, set[str]]] = {}
     lib_whitelist: set[str] = set()
     for policy in sorted(policies, key=lambda x: x["priority"], reverse=True):
@@ -258,7 +258,9 @@ def _validate_pep600_compliance(policies) -> None:
             symbol_versions[arch] = symbol_versions_arch
 
 
-def _fixup_musl_libc_soname(libc: Libc, arch: Architecture, whitelist):
+def _fixup_musl_libc_soname(
+    libc: Libc, arch: Architecture, whitelist: list[str]
+) -> list[str]:
     if libc != Libc.MUSL:
         return whitelist
     soname_map = {
@@ -306,7 +308,7 @@ def get_replace_platforms(name: str) -> list[str]:
     return ["linux_" + "_".join(name.split("_")[1:])]
 
 
-def _load_policy_schema():
+def _load_policy_schema():  # type: ignore[no-untyped-def]
     with open(join(dirname(abspath(__file__)), "policy-schema.json")) as f_:
         return json.load(f_)
 
diff --git a/src/auditwheel/repair.py b/src/auditwheel/repair.py
@@ -69,7 +69,7 @@ def repair_wheel(
         # here, fn is a path to an ELF file (lib or executable) in
         # the wheel, and v['libs'] contains its required libs
         for fn, v in external_refs_by_fn.items():
-            ext_libs: dict[str, str] = v[abis[0]]["libs"]
+            ext_libs: dict[str, str | None] = v[abis[0]]["libs"]
             replacements: list[tuple[str, str]] = []
             for soname, src_path in ext_libs.items():
                 assert not any(fnmatch(soname, e) for e in exclude)
diff --git a/src/auditwheel/tools.py b/src/auditwheel/tools.py
@@ -6,10 +6,12 @@
 import zipfile
 from collections.abc import Generator, Iterable
 from datetime import datetime, timezone
-from typing import Any
+from typing import Any, TypeVar
 
+_T = TypeVar("_T")
 
-def unique_by_index(sequence: Iterable[Any]) -> list[Any]:
+
+def unique_by_index(sequence: Iterable[_T]) -> list[_T]:
     """unique elements in `sequence` in the order in which they occur
 
     Parameters
@@ -148,32 +150,40 @@ def tarbz2todir(tarbz2_fname: str, out_dir: str) -> None:
 class EnvironmentDefault(argparse.Action):
     """Get values from environment variable."""
 
-    def __init__(self, env, required=True, default=None, **kwargs):
+    def __init__(
+        self,
+        env: str,
+        required: bool = True,
+        default: str | None = None,
+        choices: Iterable[str] | None = None,
+        **kwargs: Any,
+    ) -> None:
         self.env_default = os.environ.get(env)
         self.env = env
         if self.env_default:
             default = self.env_default
         if default:
             required = False
-        if self.env_default and "choices" in kwargs:
-            choices = kwargs["choices"]
-            if self.env_default not in choices:
-                self.option_strings = kwargs["option_strings"]
-                args = {
-                    "value": self.env_default,
-                    "choices": ", ".join(map(repr, choices)),
-                    "env": self.env,
-                }
-                msg = (
-                    "invalid choice: %(value)r from environment variable "
-                    "%(env)r (choose from %(choices)s)"
-                )
-                raise argparse.ArgumentError(self, msg % args)
-
-        super().__init__(default=default, required=required, **kwargs)
-
-    def __call__(self, parser, namespace, values, option_string=None):
-        # use self assignment to silence ARG002
-        parser = parser  # noqa: PLW0127
-        option_string = option_string  # noqa: PLW0127
+        if self.env_default and choices is not None and self.env_default not in choices:
+            self.option_strings = kwargs["option_strings"]
+            args = {
+                "value": self.env_default,
+                "choices": ", ".join(map(repr, choices)),
+                "env": self.env,
+            }
+            msg = (
+                "invalid choice: %(value)r from environment variable "
+                "%(env)r (choose from %(choices)s)"
+            )
+            raise argparse.ArgumentError(self, msg % args)
+
+        super().__init__(default=default, required=required, choices=choices, **kwargs)
+
+    def __call__(
+        self,
+        parser: argparse.ArgumentParser,  # noqa: ARG002
+        namespace: argparse.Namespace,
+        values: Any,
+        option_string: str | None = None,  # noqa: ARG002
+    ) -> None:
         setattr(namespace, self.dest, values)
diff --git a/src/auditwheel/wheel_abi.py b/src/auditwheel/wheel_abi.py
diff --git a/src/auditwheel/wheeltools.py b/src/auditwheel/wheeltools.py
diff --git a/tests/integration/test_manylinux.py b/tests/integration/test_manylinux.py
diff --git a/tests/unit/test_elfutils.py b/tests/unit/test_elfutils.py
diff --git a/tests/unit/test_musllinux.py b/tests/unit/test_musllinux.py
diff --git a/tests/unit/test_policy.py b/tests/unit/test_policy.py
