pre-commit cleanup

Author: alukach

src/stac_auth_proxy/app.py

@@ -10,17 +10,16 @@
 
 from fastapi import FastAPI
 
+from .config import Settings
+from .handlers import ReverseProxyHandler
 from .middleware import (
-    OpenApiMiddleware,
     AddProcessTimeHeaderMiddleware,
-    EnforceAuthMiddleware,
-    BuildCql2FilterMiddleware,
     ApplyCql2FilterMiddleware,
+    BuildCql2FilterMiddleware,
+    EnforceAuthMiddleware,
+    OpenApiMiddleware,
 )
 
-from .config import Settings
-from .handlers import ReverseProxyHandler
-
 logger = logging.getLogger(__name__)
 
 

src/stac_auth_proxy/filters/template.py

@@ -1,10 +1,9 @@
 """Generate CQL2 filter expressions via Jinja2 templating."""
 
-from typing import Any
 from dataclasses import dataclass, field
+from typing import Any
 
 from cql2 import Expr
-from fastapi import Request
 from jinja2 import BaseLoader, Environment
 
 

src/stac_auth_proxy/handlers/reverse_proxy.py

@@ -10,7 +10,6 @@
 from starlette.datastructures import MutableHeaders
 from starlette.responses import StreamingResponse
 
-
 logger = logging.getLogger(__name__)
 
 

src/stac_auth_proxy/middleware/AddProcessTimeHeaderMiddleware.py

@@ -1,9 +1,10 @@
-from fastapi import Request, Response
-from starlette.middleware.base import BaseHTTPMiddleware
-
+"""Middleware to add a header with the process time to the response."""
 
 import time
 
+from fastapi import Request, Response
+from starlette.middleware.base import BaseHTTPMiddleware
+
 
 class AddProcessTimeHeaderMiddleware(BaseHTTPMiddleware):
     """Middleware to add a header with the process time to the response."""

src/stac_auth_proxy/middleware/Cql2FilterMiddleware.py

@@ -1,11 +1,13 @@
-from logging import getLogger
+"""Middleware to build and apply CQL2 filters."""
+
 import json
 from dataclasses import dataclass
+from logging import getLogger
 from typing import Callable, Optional
 
 from cql2 import Expr
-from starlette.types import ASGIApp, Message, Receive, Scope, Send
 from starlette.requests import Request
+from starlette.types import ASGIApp, Message, Receive, Scope, Send
 
 from ..utils import filters, requests
 
@@ -25,6 +27,7 @@ class BuildCql2FilterMiddleware:
     state_key: str = "cql2_filter"
 
     async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
+        """Build the CQL2 filter, place on the request state."""
         if scope["type"] != "http":
             return await self.app(scope, receive, send)
 
@@ -35,6 +38,7 @@ async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
             return await self.app(scope, receive, send)
 
         async def set_filter(body: Optional[dict] = None) -> None:
+            assert filter_builder is not None
             cql2_filter = await filter_builder(
                 {
                     "req": {

src/stac_auth_proxy/middleware/EnforceAuthMiddleware.py

@@ -1,15 +1,16 @@
-from dataclasses import dataclass, field
-from typing import Annotated, Optional, Sequence
+"""Middleware to enforce authentication."""
+
 import json
 import logging
 import urllib.request
+from dataclasses import dataclass, field
+from typing import Annotated, Optional, Sequence
 
-from fastapi import HTTPException, Security, status, Request
+import jwt
+from fastapi import HTTPException, Request, Security, status
 from pydantic import HttpUrl
-from starlette.middleware.base import ASGIApp
 from starlette.responses import JSONResponse
 from starlette.types import ASGIApp, Receive, Scope, Send
-import jwt
 
 from ..config import EndpointMethods
 from ..utils.requests import matches_route

src/stac_auth_proxy/middleware/UpdateOpenApiMiddleware.py

@@ -1,9 +1,11 @@
+"""Middleware to add auth information to the OpenAPI spec served by upstream API."""
+
 import json
 from dataclasses import dataclass
 from typing import Any
 
-from starlette.types import ASGIApp, Message, Receive, Scope, Send
 from starlette.requests import Request
+from starlette.types import ASGIApp, Message, Receive, Scope, Send
 
 from ..config import EndpointMethods
 from ..utils.requests import dict_to_bytes
@@ -52,6 +54,7 @@ async def augment_oidc_spec(message: Message):
         return await self.app(scope, receive, augment_oidc_spec)
 
     def augment_spec(self, openapi_spec) -> dict[str, Any]:
+        """Augment the OpenAPI spec with auth information."""
         components = openapi_spec.setdefault("components", {})
         securitySchemes = components.setdefault("securitySchemes", {})
         securitySchemes[self.oidc_auth_scheme_name] = {

src/stac_auth_proxy/middleware/__init__.py

@@ -1,14 +1,17 @@
 """Custom middleware."""
 
-from .UpdateOpenApiMiddleware import OpenApiMiddleware
 from .AddProcessTimeHeaderMiddleware import AddProcessTimeHeaderMiddleware
+from .Cql2FilterMiddleware import ApplyCql2FilterMiddleware, BuildCql2FilterMiddleware
 from .EnforceAuthMiddleware import EnforceAuthMiddleware
-from .Cql2FilterMiddleware import BuildCql2FilterMiddleware, ApplyCql2FilterMiddleware
+from .UpdateOpenApiMiddleware import OpenApiMiddleware
 
 __all__ = [
-    OpenApiMiddleware,
-    AddProcessTimeHeaderMiddleware,
-    EnforceAuthMiddleware,
-    BuildCql2FilterMiddleware,
-    ApplyCql2FilterMiddleware,
+    x.__name__
+    for x in [
+        OpenApiMiddleware,
+        AddProcessTimeHeaderMiddleware,
+        EnforceAuthMiddleware,
+        BuildCql2FilterMiddleware,
+        ApplyCql2FilterMiddleware,
+    ]
 ]

src/stac_auth_proxy/utils/requests.py

@@ -40,9 +40,8 @@ def dict_to_bytes(d: dict) -> bytes:
 
 def matches_route(request: Request, url_patterns: dict[str, list[str]]) -> bool:
     """
-    Returns True if the incoming request.path and request.method
-    match any of the patterns (and their methods) in url_patterns.
-    Otherwise returns False.
+    Test if the incoming request.path and request.method match any of the patterns
+    (and their methods) in url_patterns.
     """
     path = request.url.path  # e.g. '/collections/123'
     method = request.method.casefold()  # e.g. 'post'

tests/conftest.py

@@ -4,7 +4,7 @@
 import os
 import threading
 from typing import Any, AsyncGenerator
-from unittest.mock import AsyncMock, MagicMock, patch, DEFAULT
+from unittest.mock import DEFAULT, AsyncMock, MagicMock, patch
 
 import pytest
 import uvicorn