Experiment: check with mypy.

This may be reverted at any point.

Author: ubernostrum

noxfile.py

@@ -323,6 +323,18 @@ def lint_pylint(session: nox.Session) -> None:
     clean()
 
 
+@nox.session(python=["3.13"], tags=["linters"])
+def lint_mypy(session: nox.Session) -> None:
+    """
+    Lint code with mypy.
+
+    """
+    session.install(".", "mypy")
+    session.run(f"python{session.python}", "-Im", "mypy", "--version")
+    session.run(f"python{session.python}", "-Im", "mypy", "src/", "tests/")
+    clean()
+
+
 # Packaging checks.
 # -----------------------------------------------------------------------------------
 

pyproject.toml

@@ -24,6 +24,7 @@ classifiers = [
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
     "Topic :: Utilities",
+    "Typing :: Typed",
 ]
 name = "akismet"
 description = "A Python interface to the Akismet spam-filtering service."
@@ -81,6 +82,14 @@ ignore-init-module = true
 [tool.isort]
 profile = "black"
 
+[[tool.mypy.overrides]]
+module = ["httpx.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["pytest.*"]
+ignore_missing_imports = true
+
 [tool.pdm]
 distribution = true
 

src/akismet/_async_client.py

@@ -8,7 +8,7 @@
 from __future__ import annotations
 
 from types import TracebackType
-from typing import TYPE_CHECKING, Literal, Optional, Type, Union
+from typing import TYPE_CHECKING, Literal, Optional
 
 import httpx
 from typing_extensions import Self, Unpack
@@ -205,7 +205,7 @@ async def __aenter__(self) -> Self:
         return self
 
     async def __aexit__(
-        self, exc_type: Type[BaseException], exc: BaseException, tb: TracebackType
+        self, exc_type: type[BaseException], exc: BaseException, tb: TracebackType
     ):
         """
         Exit method of the async context manager.
@@ -483,7 +483,7 @@ async def key_sites(
         order: Optional[str] = None,
         limit: Optional[int] = None,
         offset: Optional[int] = None,
-    ) -> Union[dict, str]:
+    ) -> dict | str:
         """
         Return Akismet API usage statistics keyed by site.
 

src/akismet/_sync_client.py

@@ -8,7 +8,7 @@
 from __future__ import annotations
 
 from types import TracebackType
-from typing import TYPE_CHECKING, Literal, Optional, Type, Union
+from typing import TYPE_CHECKING, Literal, Optional
 
 import httpx
 from typing_extensions import Self, Unpack
@@ -206,7 +206,7 @@ def __enter__(self) -> Self:
         return self
 
     def __exit__(
-        self, exc_type: Type[BaseException], exc: BaseException, tb: TracebackType
+        self, exc_type: type[BaseException], exc: BaseException, tb: TracebackType
     ):
         """
         Exit method of the context manager.
@@ -479,7 +479,7 @@ def key_sites(  # pylint: disable=too-many-positional-arguments,too-many-argumen
         order: Optional[str] = None,
         limit: Optional[int] = None,
         offset: Optional[int] = None,
-    ) -> Union[dict, str]:
+    ) -> dict | str:
         """
         Return Akismet API usage statistics keyed by site.
 

src/akismet/py.typed

@@ -4,6 +4,7 @@
 """
 
 import csv
+from typing import Any, cast
 
 import pytest
 
@@ -169,7 +170,7 @@ async def test_key_sites_json(akismet_async_client: akismet.AsyncClient):
     key_sites() returns key usage information in JSON format by async default.
 
     """
-    response_json = await akismet_async_client.key_sites()
+    response_json = cast(dict[str, Any], await akismet_async_client.key_sites())
     for key in ["2022-09", "limit", "offset", "total"]:
         assert key in response_json
     sites = response_json["2022-09"]
@@ -192,7 +193,7 @@ async def test_key_sites_csv(akismet_async_client: akismet.AsyncClient):
 
     """
     first, *rest = (
-        await akismet_async_client.key_sites(result_format="csv")
+        cast(str, await akismet_async_client.key_sites(result_format="csv"))
     ).splitlines()
     assert first.startswith("Active sites for")
     reader = csv.DictReader(rest)

tests/async_client/test_api.py

@@ -102,7 +102,7 @@ def akismet_sync_client_fixed_response(
     marker = request.node.get_closest_marker("akismet_fixed_response")
     return akismet.SyncClient(
         http_client=httpx.Client(
-            transport=akismet_fixed_response_transport(**marker.kwargs)
+            transport=akismet_fixed_response_transport(**marker.kwargs)  # type: ignore
         )
     )
 
@@ -122,7 +122,7 @@ def akismet_async_client_fixed_response(
     marker = request.node.get_closest_marker("akismet_fixed_response")
     return akismet.AsyncClient(
         http_client=httpx.AsyncClient(
-            transport=akismet_fixed_response_transport(**marker.kwargs)
+            transport=akismet_fixed_response_transport(**marker.kwargs)  # type: ignore
         )
     )
 

tests/conftest.py

@@ -4,6 +4,7 @@
 """
 
 import csv
+from typing import Any, cast
 
 import pytest
 
@@ -169,7 +170,7 @@ def test_key_sites_json(akismet_sync_client: akismet.SyncClient):
     key_sites() returns key usage information in JSON format by default.
 
     """
-    response_json = akismet_sync_client.key_sites()
+    response_json = cast(dict[str, Any], akismet_sync_client.key_sites())
     for key in ["2022-09", "limit", "offset", "total"]:
         assert key in response_json
     sites = response_json["2022-09"]
@@ -191,7 +192,9 @@ def test_key_sites_csv(akismet_sync_client: akismet.SyncClient):
     key_sites() returns key usage information in CSV format when requested.
 
     """
-    first, *rest = (akismet_sync_client.key_sites(result_format="csv")).splitlines()
+    first, *rest = (
+        cast(str, akismet_sync_client.key_sites(result_format="csv"))
+    ).splitlines()
     assert first.startswith("Active sites for")
     reader = csv.DictReader(rest)
     row = next(reader)