Add docstring for pre-commit

Author: alukach

src/stac_auth_proxy/config.py

@@ -11,6 +11,8 @@
 
 
 class ClassInput(BaseModel):
+    """Input model for dynamically loading a class or function."""
+
     cls: str
     args: Optional[Sequence[str]] = []
     kwargs: Optional[dict[str, str]] = {}

src/stac_auth_proxy/guards/__init__.py

@@ -1,3 +1,5 @@
+"""Module to define the access policy guards for the application."""
+
 from .cel import cel
 
 __all__ = ["cel"]

src/stac_auth_proxy/guards/cel.py

@@ -1,3 +1,5 @@
+"""Guard using CEL (Common Expression Language, https://cel.dev)."""
+
 from typing import Any, Callable
 
 import celpy
@@ -7,7 +9,7 @@
 
 
 def cel(expression: str, token_dependency: Callable[..., Any]):
-    """Custom middleware."""
+    """Cel check factory."""
     env = celpy.Environment()
     ast = env.compile(expression)
     program = env.program(ast)

src/stac_auth_proxy/utils.py

@@ -20,6 +20,10 @@ def safe_headers(headers: Headers) -> dict[str, str]:
 
 
 def extract_variables(url: str) -> dict:
+    """
+    Extract variables from a URL path. Being that we use a catch-all endpoint for the proxy,
+    we can't rely on the path parameters that FastAPI provides.
+    """
     path = urlparse(url).path
     # This allows either /items or /bulk_items, with an optional item_id following.
     pattern = r"^/collections/(?P<collection_id>[^/]+)(?:/(?:items|bulk_items)(?:/(?P<item_id>[^/]+))?)?/?$"

tests/test_guards_cel.py

@@ -27,6 +27,7 @@ def test_guard_query_params(
     endpoint,
     expected_status_code,
 ):
+    """Test guard with query parameters."""
     app = app_factory(
         upstream_url=source_api_server,
         guard={
@@ -55,6 +56,7 @@ def test_guard_auth_token(
     token_payload,
     expected_status_code,
 ):
+    """Test guard with auth token."""
     app = app_factory(
         upstream_url=source_api_server,
         guard={

tests/test_utils.py

@@ -17,4 +17,5 @@
     ),
 )
 def test_extract_variables(url, expected):
+    """Test extracting variables from a URL path."""
     assert extract_variables(url) == expected