Merge pull request #541 from dklimpel/use_mypy

misc: add mypy for type checking

Author: openshift-merge-bot[bot]

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+    rev: v5.0.0
     hooks:
     - id: check-yaml
       exclude: "gating.yml"
@@ -19,3 +19,9 @@ repos:
   rev: 1.39.0
   hooks:
     - id: tmt-lint
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.15.0
+  hooks:
+    - id: mypy
+      pass_filenames: false
+      args: ["--package", "podman"]

Makefile

@@ -19,7 +19,7 @@ podman:
 
 .PHONY: lint
 lint: tox
-	$(PYTHON) -m tox -e format,lint
+	$(PYTHON) -m tox -e format,lint,mypy
 
 .PHONY: tests
 tests: tox

podman/api/cached_property.py

@@ -6,5 +6,5 @@
     from functools import cached_property  # pylint: disable=unused-import
 except ImportError:
 
-    def cached_property(fn):
+    def cached_property(fn):  # type: ignore[no-redef]
         return property(functools.lru_cache()(fn))

podman/api/http_utils.py

@@ -85,6 +85,7 @@ def _filter_values(mapping: Mapping[str, Any], recursion=False) -> dict[str, Any
             continue
 
         # depending on type we need details...
+        proposal: Any
         if isinstance(value, collections.abc.Mapping):
             proposal = _filter_values(value, recursion=True)
         elif isinstance(value, collections.abc.Iterable) and not isinstance(value, str):
@@ -100,5 +101,5 @@ def _filter_values(mapping: Mapping[str, Any], recursion=False) -> dict[str, Any
     return canonical
 
 
-def encode_auth_header(auth_config: dict[str, str]) -> str:
+def encode_auth_header(auth_config: dict[str, str]) -> bytes:
     return base64.urlsafe_b64encode(json.dumps(auth_config).encode('utf-8'))

podman/api/parse_utils.py

@@ -8,7 +8,7 @@
 from typing import Any, Optional, Union
 from collections.abc import Iterator
 
-from requests import Response
+from podman.api.client import APIResponse
 from .output_utils import demux_output
 
 
@@ -59,15 +59,15 @@ def prepare_timestamp(value: Union[datetime, int, None]) -> Optional[int]:
     raise ValueError(f"Type '{type(value)}' is not supported by prepare_timestamp()")
 
 
-def prepare_cidr(value: Union[ipaddress.IPv4Network, ipaddress.IPv6Network]) -> (str, str):
+def prepare_cidr(value: Union[ipaddress.IPv4Network, ipaddress.IPv6Network]) -> tuple[str, str]:
     """Returns network address and Base64 encoded netmask from CIDR.
 
     The return values are dictated by the Go JSON decoder.
     """
     return str(value.network_address), base64.b64encode(value.netmask.packed).decode("utf-8")
 
 
-def frames(response: Response) -> Iterator[bytes]:
+def frames(response: APIResponse) -> Iterator[bytes]:
     """Returns each frame from multiplexed payload, all results are expected in the payload.
 
     The stdout and stderr frames are undifferentiated as they are returned.
@@ -84,7 +84,7 @@ def frames(response: Response) -> Iterator[bytes]:
 
 
 def stream_frames(
-    response: Response, demux: bool = False
+    response: APIResponse, demux: bool = False
 ) -> Iterator[Union[bytes, tuple[bytes, bytes]]]:
     """Returns each frame from multiplexed streamed payload.
 
@@ -111,7 +111,7 @@ def stream_frames(
 
 
 def stream_helper(
-    response: Response, decode_to_json: bool = False
+    response: APIResponse, decode_to_json: bool = False
 ) -> Union[Iterator[bytes], Iterator[dict[str, Any]]]:
     """Helper to stream results and optionally decode to json"""
     for value in response.iter_lines():

podman/domain/containers_manager.py

@@ -120,7 +120,7 @@ def prune(self, filters: Mapping[str, str] = None) -> dict[str, Any]:
                     explanation=f"""Failed to prune container '{entry["Id"]}'""",
                 )
 
-            results["ContainersDeleted"].append(entry["Id"])
+            results["ContainersDeleted"].append(entry["Id"])  # type: ignore[attr-defined]
             results["SpaceReclaimed"] += entry["Size"]
         return results
 

podman/domain/images.py

@@ -1,7 +1,7 @@
 """Model and Manager for Image resources."""
 
 import logging
-from typing import Any, Optional, Literal, Union
+from typing import Any, Optional, Literal, Union, TYPE_CHECKING
 from collections.abc import Iterator
 
 import urllib.parse
@@ -10,12 +10,17 @@
 from podman.domain.manager import PodmanResource
 from podman.errors import ImageNotFound, InvalidArgument
 
+if TYPE_CHECKING:
+    from podman.domain.images_manager import ImagesManager
+
 logger = logging.getLogger("podman.images")
 
 
 class Image(PodmanResource):
     """Details and configuration for an Image managed by the Podman service."""
 
+    manager: "ImagesManager"
+
     def __repr__(self) -> str:
         return f"""<{self.__class__.__name__}: '{"', '".join(self.tags)}'>"""
 

podman/domain/networks_manager.py

@@ -12,7 +12,7 @@
 import ipaddress
 import logging
 from contextlib import suppress
-from typing import Any, Optional, Literal
+from typing import Any, Optional, Literal, Union
 
 from podman.api import http_utils, prepare_filters
 from podman.domain.manager import Manager
@@ -188,7 +188,7 @@ def prune(
 
         return {"NetworksDeleted": deleted, "SpaceReclaimed": 0}
 
-    def remove(self, name: [Network, str], force: Optional[bool] = None) -> None:
+    def remove(self, name: Union[Network, str], force: Optional[bool] = None) -> None:
         """Remove Network resource.
 
         Args:

podman/domain/pods.py

@@ -1,10 +1,13 @@
 """Model and Manager for Pod resources."""
 
 import logging
-from typing import Any, Optional, Union
+from typing import Any, Optional, Union, TYPE_CHECKING
 
 from podman.domain.manager import PodmanResource
 
+if TYPE_CHECKING:
+    from podman.domain.pods_manager import PodsManager
+
 _Timeout = Union[None, int, tuple[int, int], tuple[int, None]]
 
 logger = logging.getLogger("podman.pods")
@@ -13,6 +16,8 @@
 class Pod(PodmanResource):
     """Details and configuration for a pod managed by the Podman service."""
 
+    manager: "PodsManager"
+
     @property
     def id(self):  # pylint: disable=invalid-name
         return self.attrs.get("ID", self.attrs.get("Id"))

podman/errors/__init__.py

@@ -58,7 +58,7 @@ def __init__(self, message, response=None):
     from .exceptions import ImageNotFound
 except ImportError:
 
-    class ImageNotFound(NotFoundError):
+    class ImageNotFound(NotFoundError):  # type: ignore[no-redef]
         """HTTP request returned a http.HTTPStatus.NOT_FOUND.
 
         Specialized for Image not found. Deprecated.