fix(core): Typing in generic + network (#700)

Tranquility2 · alexanderankin · web-flow · commit 2061912e6770 · 2025-05-04T13:32:36.000-04:00
Supports: #305 Related : #691 #692 ### Overview 1. Updated Mypy 2. Add a new dev script to allow easy reporting on Mypy errors (Using it in the makefile) 4. fix various type errors (all over core) #### Old ``` Error Summary ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┓ ┃ File Path ┃ Errors ┃ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━┩ │ core/testcontainers/core/version.py │ 12 │ │ core/testcontainers/core/docker_client.py │ 14 │ │ core/testcontainers/core/network.py │ 4 │ │ core/testcontainers/core/image.py │ 17 │ │ core/testcontainers/core/waiting_utils.py │ 8 │ │ core/testcontainers/core/container.py │ 20 │ │ core/tests/test_new_docker_api.py │ 4 │ │ core/tests/test_docker_in_docker.py │ 2 │ │ core/testcontainers/compose/compose.py │ 22 │ │ core/testcontainers/compose/__init__.py │ 2 │ │ core/testcontainers/core/generic.py │ 1 │ │ core/tests/test_version.py │ 2 │ │ core/tests/test_ryuk.py │ 2 │ │ core/tests/test_registry.py │ 1 │ │ core/tests/test_network.py │ 1 │ │ core/tests/test_labels.py │ 1 │ │ core/tests/test_image.py │ 3 │ │ core/tests/test_docker_client.py │ 1 │ │ core/tests/conftest.py │ 1 │ │ core/tests/test_compose.py │ 7 │ └───────────────────────────────────────────┴────────┘ Found 125 errors in 20 files. ``` #### New ``` Error Summary ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┓ ┃ File Path ┃ Errors ┃ ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━┩ │ core/testcontainers/core/version.py │ 12 │ │ core/testcontainers/core/docker_client.py │ 14 │ │ core/testcontainers/core/image.py │ 17 │ │ core/testcontainers/core/waiting_utils.py │ 8 │ │ core/testcontainers/core/container.py │ 20 │ │ core/tests/test_new_docker_api.py │ 4 │ │ core/tests/test_docker_in_docker.py │ 2 │ │ core/testcontainers/compose/compose.py │ 22 │ │ core/testcontainers/compose/__init__.py │ 2 │ │ core/tests/test_version.py │ 2 │ │ core/tests/test_ryuk.py │ 2 │ │ core/tests/test_registry.py │ 1 │ │ core/tests/test_image.py │ 3 │ │ core/tests/test_compose.py │ 7 │ └───────────────────────────────────────────┴────────┘ Found 116 errors in 14 files. ``` --------- Co-authored-by: David Ankin <daveankin@gmail.com>
diff --git a/.github/workflows/ci-lint.yml b/.github/workflows/ci-lint.yml
@@ -20,4 +20,9 @@ jobs:
       - name: Install Python dependencies
         run: poetry install --no-interaction
       - name: Execute pre-commit handler
-        run: poetry run pre-commit run -a
+        run: |
+          poetry run pre-commit run check-toml
+          poetry run pre-commit run trailing-whitespace
+          poetry run pre-commit run end-of-file-fixer
+          poetry run pre-commit run ruff
+          poetry run pre-commit run ruff-format
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -18,13 +18,13 @@ repos:
       - id: ruff-format
         args: [ '--config', 'pyproject.toml' ]
 
-#  - repo: local
-#    hooks:
-#      - id: mypy
-#        name: mypy
-#        entry: poetry run mypy
-#        args: ["--config-file", "pyproject.toml"]
-#        files: "core"  # start with the core being type checked
-#        language: system
-#        types: [ python ]
-#        require_serial: true
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: poetry run mypy
+        args: ["--config-file", "pyproject.toml"]
+        files: "core"  # start with the core being type checked
+        language: system
+        types: [ python ]
+        require_serial: true
diff --git a/Makefile b/Makefile
@@ -31,6 +31,9 @@ coverage:  ## Target to combine and report coverage.
 lint:  ## Lint all files in the project, which we also run in pre-commit
 	poetry run pre-commit run -a
 
+mypy-core-report:
+	poetry run mypy --config-file pyproject.toml core | poetry run python scripts/mypy_report.py
+
 docs: ## Build the docs for the project
 	poetry run sphinx-build -nW . docs/_build
 
diff --git a/core/testcontainers/core/generic.py b/core/testcontainers/core/generic.py
@@ -10,7 +10,7 @@
 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 #    License for the specific language governing permissions and limitations
 #    under the License.
-from typing import Optional
+from typing import Any, Optional
 from urllib.parse import quote
 
 from testcontainers.core.container import DockerContainer
@@ -55,7 +55,7 @@ def _create_connection_url(
         host: Optional[str] = None,
         port: Optional[int] = None,
         dbname: Optional[str] = None,
-        **kwargs,
+        **kwargs: Any,
     ) -> str:
         if raise_for_deprecated_parameter(kwargs, "db_name", "dbname"):
             raise ValueError(f"Unexpected arguments: {','.join(kwargs)}")
diff --git a/core/testcontainers/core/network.py b/core/testcontainers/core/network.py
@@ -11,7 +11,7 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 import uuid
-from typing import Optional
+from typing import Any, Optional
 
 from testcontainers.core.docker_client import DockerClient
 
@@ -21,12 +21,14 @@ class Network:
     Network context manager for programmatically connecting containers.
     """
 
-    def __init__(self, docker_client_kw: Optional[dict] = None, docker_network_kw: Optional[dict] = None) -> None:
+    def __init__(
+        self, docker_client_kw: Optional[dict[str, Any]] = None, docker_network_kw: Optional[dict[str, Any]] = None
+    ):
         self.name = str(uuid.uuid4())
         self._docker = DockerClient(**(docker_client_kw or {}))
         self._docker_network_kw = docker_network_kw or {}
 
-    def connect(self, container_id: str, network_aliases: Optional[list] = None):
+    def connect(self, container_id: str, network_aliases: Optional[list[str]] = None) -> None:
         self._network.connect(container_id, aliases=network_aliases)
 
     def remove(self) -> None:
@@ -40,5 +42,5 @@ def create(self) -> "Network":
     def __enter__(self) -> "Network":
         return self.create()
 
-    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
+    def __exit__(self, exc_type, exc_val, exc_tb) -> None:  # type: ignore[no-untyped-def]
         self.remove()
diff --git a/core/tests/test_docker_client.py b/core/tests/test_docker_client.py
@@ -43,8 +43,8 @@ def test_docker_client_login():
     mock_parse_docker_auth_config = MagicMock(spec=parse_docker_auth_config)
     mock_utils = MagicMock()
     mock_utils.parse_docker_auth_config = mock_parse_docker_auth_config
-    TestAuth = namedtuple("Auth", "value")
-    mock_parse_docker_auth_config.return_value = [TestAuth("test")]
+    Auth = namedtuple("Auth", "value")
+    mock_parse_docker_auth_config.return_value = [Auth("test")]
 
     with (
         mock.patch.object(c, "_docker_auth_config", "test"),
diff --git a/core/tests/test_labels.py b/core/tests/test_labels.py
@@ -10,7 +10,7 @@
 from testcontainers.core.config import RYUK_IMAGE
 
 
-def assert_in_with_value(labels: dict, label: str, value: str, known_before_test_time: bool) -> None:
+def assert_in_with_value(labels: dict[str, str], label: str, value: str, known_before_test_time: bool):
     assert label in labels
     if known_before_test_time:
         assert labels[label] == value
diff --git a/core/tests/test_network.py b/core/tests/test_network.py
@@ -90,6 +90,6 @@ def test_network_has_labels():
     try:
         network.create()
         network = network._docker.client.networks.get(network_id=network.id)
-        assert LABEL_SESSION_ID in network.attrs.get("Labels")
+        assert LABEL_SESSION_ID in network.attrs.get("Labels")  # type: ignore[attr-defined]
     finally:
         network.remove()
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -167,7 +167,7 @@ chroma = ["chromadb-client"]
 trino = ["trino"]
 
 [tool.poetry.group.dev.dependencies]
-mypy = "1.7.1"
+mypy = "1.11.2"
 pre-commit = "^3.6"
 pytest = "7.4.3"
 pytest-cov = "4.1.0"
@@ -284,8 +284,9 @@ namespace_packages = true
 explicit_package_bases = true
 pretty = true
 show_error_codes = true
+warn_return_any = true
 strict = true
-fast_module_lookup = true
+# fast_module_lookup = true
 modules = ["testcontainers.core"]
 mypy_path = [
     "core",
diff --git a/scripts/mypy_report.py b/scripts/mypy_report.py
@@ -0,0 +1,35 @@
+# Description: This script reads the output of mypy and generates a summary of errors by file.
+
+import re
+import sys
+
+from rich.console import Console
+from rich.table import Table
+
+# Regular expression to match file path and error count
+pattern = r"(.*\.py:\d+):\s+error: (.*)"
+
+error_dict = {}
+
+for line in sys.stdin:
+    match = re.search(pattern, line)
+    if match:
+        # Extract file path and error message
+        file_path, _ = match.group(1).split(":")
+        error_message = match.group(2)
+
+        if file_path not in error_dict:
+            error_dict[file_path] = 1
+        else:
+            error_dict[file_path] += 1
+
+table = Table(title="Error Summary")
+table.add_column("File Path")
+table.add_column("Errors", justify="left")
+
+for file_path, error_count in error_dict.items():
+    table.add_row(file_path, str(error_count))
+
+console = Console()
+console.print(table)
+console.print(f"[red]Found {sum(error_dict.values())} errors in {len(error_dict)} files.[/red]")
