style: fix typechecking issues

Author: snus-kin

.pre-commit-config.yaml

@@ -9,10 +9,14 @@ repos:
     rev: 0.7.15
     hooks:
       - id: uv-lock
-  - repo: https://github.com/DetachHead/basedpyright-pre-commit-mirror
-    rev: v1.13.0
+  - repo: local
     hooks:
       - id: basedpyright
+        name: basedpyright
+        entry: basedpyright
+        language: system
+        types_or: [python, pyi]
+        pass_filenames: false
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:

examples/classify_single_example.py

@@ -30,12 +30,14 @@ async def classify_single_image_example(
     """Demonstrate single image classification.
 
     Args:
+    ----
         logger: Logger instance for output
         options: Configuration options for the Athena client
         credential_helper: OAuth credential helper for authentication
         image_path: Path to image file to classify (optional)
 
     Returns:
+    -------
         True if classification was successful, False otherwise
 
     """
@@ -117,12 +119,14 @@ async def classify_multiple_single_images_example(
     when you want individual control over each classification request.
 
     Args:
+    ----
         logger: Logger instance for output
         options: Configuration options for the Athena client
         credential_helper: OAuth credential helper for authentication
         num_images: Number of test images to classify
 
     Returns:
+    -------
         Number of successfully classified images
 
     """
@@ -185,7 +189,7 @@ async def classify_multiple_single_images_example(
 async def main() -> int:
     """Run the classify_single examples."""
     logger = logging.getLogger(__name__)
-    load_dotenv()
+    _ = load_dotenv()
 
     # OAuth credentials from environment
     client_id = os.getenv("OAUTH_CLIENT_ID")

examples/example.py

@@ -135,7 +135,7 @@ async def run_oauth_example(
 async def main() -> int:
     """Run the OAuth classification example."""
     logger = logging.getLogger(__name__)
-    load_dotenv()
+    _ = load_dotenv()
 
     # Configuration
     max_test_images = 10_000

pyproject.toml

@@ -62,7 +62,7 @@ exclude = ["src/resolver_athena_client/generated/*", "docs"]
 
 [tool.ruff.lint]
 select = ["ALL"]
-ignore = ["COM812", "D213", "D211", "D203", "S324"]
+ignore = ["COM812", "D213", "D211", "D203", "S324", "ASYNC109"]
 
 [tool.ruff.lint.per-file-ignores]
 # Ignore doc lint rules in tests.
@@ -72,6 +72,9 @@ ignore = ["COM812", "D213", "D211", "D203", "S324"]
 exclude = ["src/resolver_athena_client/generated/*", ".venv"]
 venvPath = "."
 venv = ".venv"
+stubPath = "stubs"
+reportImplicitStringConcatenation = false
+reportAny = false
 
 [tool.pytest.ini_options]
 markers = [

src/resolver_athena_client/client/athena_client.py

@@ -58,21 +58,25 @@ def __init__(
         """Initialize the Athena Client.
 
         Args:
+        ----
             channel: The gRPC channel to use for communication.
             options: Configuration options for the Athena client.
 
         """
-        self.logger = logging.getLogger(__name__)
-        self.options = options
-        self.channel = channel
-        self.classifier = ClassifierServiceClient(self.channel)
+        self.logger: logging.Logger = logging.getLogger(__name__)
+        self.options: AthenaOptions = options
+        self.channel: grpc.aio.Channel = channel
+        self.classifier: ClassifierServiceClient = ClassifierServiceClient(
+            self.channel
+        )
 
     async def classify_images(
         self, images: AsyncIterator[ImageData]
     ) -> AsyncIterator[ClassifyResponse]:
         """Classify images using the Athena service.
 
         Args:
+        ----
             images: An async iterator of ImageData objects containing image
                 bytes and hash lists tracking transformations. Users must create
                 ImageData objects from raw image bytes before passing to this
@@ -82,9 +86,11 @@ async def classify_images(
                 operations.
 
         Yields:
+        ------
             Classification responses from the service.
 
         Example:
+        -------
             # Create ImageData from raw bytes
             image_data = ImageData(image_bytes)
             print(f"Initial hashes: {len(image_data.sha256_hashes)}")  # 1
@@ -180,6 +186,7 @@ async def classify_single(
         - Testing and debugging individual image classifications
 
         Args:
+        ----
             image_data: ImageData object containing image bytes and metadata.
                 The image will be processed through the same transformation
                 pipeline as the streaming classify method (resize, compression)
@@ -189,14 +196,17 @@ async def classify_single(
                 automatically.
 
         Returns:
+        -------
             ClassificationOutput containing either classification results or
             error information for the single image.
 
         Raises:
+        ------
             AthenaError: If the service returns an error.
             grpc.aio.AioRpcError: For gRPC communication errors.
 
         Example:
+        -------
             # Create ImageData from raw bytes
             image_data = ImageData(image_bytes)
 

src/resolver_athena_client/client/channel.py

@@ -3,6 +3,7 @@
 import asyncio
 import json
 import time
+from typing import override
 
 import grpc
 import httpx
@@ -22,11 +23,13 @@ def __init__(self, token: str) -> None:
         """Initialize the plugin with the auth token.
 
         Args:
+        ----
             token: The authorization token to add to requests
 
         """
-        self._token = token
+        self._token: str = token
 
+    @override
     def __call__(
         self,
         _: grpc.AuthMetadataContext,
@@ -37,6 +40,7 @@ def __call__(
         This method will be invoked asynchronously in a separate thread.
 
         Args:
+        ----
             callback: An AuthMetadataPluginCallback to be invoked either
             synchronously or asynchronously.
 
@@ -58,6 +62,7 @@ def __init__(
         """Initialize the credential helper.
 
         Args:
+        ----
             client_id: OAuth client ID
             client_secret: OAuth client secret
             auth_url: OAuth token endpoint URL
@@ -71,24 +76,26 @@ def __init__(
             msg = "client_secret cannot be empty"
             raise CredentialError(msg)
 
-        self._client_id = client_id
-        self._client_secret = client_secret
-        self._auth_url = auth_url
-        self._audience = audience
+        self._client_id: str = client_id
+        self._client_secret: str = client_secret
+        self._auth_url: str = auth_url
+        self._audience: str = audience
         self._token: str | None = None
         self._token_expires_at: float | None = None
-        self._lock = asyncio.Lock()
+        self._lock: asyncio.Lock = asyncio.Lock()
 
     async def get_token(self) -> str:
         """Get a valid authentication token.
 
         This method will return a cached token if it's still valid,
         or fetch a new token if needed.
 
-        Returns:
+        Returns
+        -------
             A valid authentication token
 
-        Raises:
+        Raises
+        ------
             OAuthError: If token acquisition fails
             TokenExpiredError: If token has expired and refresh fails
 
@@ -109,7 +116,8 @@ async def get_token(self) -> str:
     def _is_token_valid(self) -> bool:
         """Check if the current token is valid and not expired.
 
-        Returns:
+        Returns
+        -------
             True if token is valid, False otherwise
 
         """
@@ -122,7 +130,8 @@ def _is_token_valid(self) -> bool:
     async def _refresh_token(self) -> None:
         """Refresh the authentication token by making an OAuth request.
 
-        Raises:
+        Raises
+        ------
             OAuthError: If the OAuth request fails
 
         """
@@ -143,7 +152,7 @@ async def _refresh_token(self) -> None:
                     headers=headers,
                     timeout=30.0,
                 )
-                response.raise_for_status()
+                _ = response.raise_for_status()
 
                 token_data = response.json()
                 self._token = token_data["access_token"]
@@ -195,13 +204,16 @@ async def create_channel_with_credentials(
     """Create a gRPC channel with OAuth credential helper.
 
     Args:
+    ----
         host: The host address to connect to
         credential_helper: The credential helper for OAuth authentication
 
     Returns:
+    -------
         A secure gRPC channel with OAuth authentication
 
     Raises:
+    ------
         InvalidHostError: If host is empty
         OAuthError: If OAuth authentication fails
 

src/resolver_athena_client/client/correlation.py

@@ -4,6 +4,7 @@
 
 import abc
 import hashlib
+from typing import override
 
 from resolver_athena_client.client.consts import MAX_DEPLOYMENT_ID_LENGTH
 
@@ -23,14 +24,17 @@ def get_correlation_id(self, input_data: bytes | str | bytearray) -> str:
         """Generate a correlation ID for the given input data.
 
         Args:
+        ----
             input_data: Data to use as the basis for correlation ID generation.
                 The type and structure of this data depends on the specific
                 implementation.
 
         Returns:
+        -------
             A string containing the generated correlation ID.
 
         Raises:
+        ------
             ValueError: If the input data is not in a format supported by
                 the implementation.
 
@@ -45,6 +49,7 @@ class HashCorrelationProvider(CorrelationProvider):
     input data's bytes, which serves as the correlation ID.
     """
 
+    @override
     def get_correlation_id(self, input_data: bytes | str | bytearray) -> str:
         """Generate a correlation ID by hashing the input data.
 
@@ -54,12 +59,15 @@ def get_correlation_id(self, input_data: bytes | str | bytearray) -> str:
         - Otherwise, convert to string and encode as UTF-8
 
         Args:
+        ----
             input_data: Data to hash for correlation ID generation.
 
         Returns:
+        -------
             A hex string of the SHA-256 hash of the input data.
 
         Raises:
+        ------
             ValueError: If the input data cannot be converted to bytes.
 
         """

src/resolver_athena_client/client/exceptions.py

@@ -1,6 +1,6 @@
 """Base classes for all Athena exceptions."""
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, final
 
 if TYPE_CHECKING:
     from resolver_athena_client.generated.athena.models_pb2 import (
@@ -15,45 +15,46 @@ class AthenaError(Exception):
 class InvalidRequestError(AthenaError):
     """Raised when the request is invalid."""
 
-    default_message = "Invalid request"
+    default_message: str = "Invalid request"
 
 
 class InvalidResponseError(AthenaError):
     """Raised when the response is invalid."""
 
-    default_message = "Invalid response"
+    default_message: str = "Invalid response"
 
 
 class InvalidAuthError(AthenaError):
     """Raised when the authentication is invalid."""
 
-    default_message = "auth_token cannot be empty"
+    default_message: str = "auth_token cannot be empty"
 
 
 class InvalidHostError(AthenaError):
     """Raised when the host is invalid."""
 
-    default_message = "host cannot be empty"
+    default_message: str = "host cannot be empty"
 
 
 class OAuthError(AthenaError):
     """Raised when OAuth authentication fails."""
 
-    default_message = "OAuth authentication failed"
+    default_message: str = "OAuth authentication failed"
 
 
 class TokenExpiredError(AthenaError):
     """Raised when the authentication token has expired."""
 
-    default_message = "Authentication token has expired"
+    default_message: str = "Authentication token has expired"
 
 
 class CredentialError(AthenaError):
     """Raised when there are issues with credential management."""
 
-    default_message = "Credential management error"
+    default_message: str = "Credential management error"
 
 
+@final
 class ClassificationOutputError(AthenaError):
     """Raised when an individual classification output contains an error."""
 
@@ -66,6 +67,7 @@ def __init__(
         """Initialize the classification output error.
 
         Args:
+        ----
             correlation_id: The correlation ID of the failed output
             error: The ClassificationError from the protobuf response
             message: Optional custom error message