add type checking (#842)

Author: vincentsarago

.pre-commit-config.yaml

@@ -5,3 +5,13 @@ repos:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
       - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+    - id: mypy
+      language_version: python
+      exclude: tests/.*
+      additional_dependencies:
+      - types-attrs
+      - pydantic

pyproject.toml

@@ -23,6 +23,12 @@ section-order = ["future", "standard-library", "third-party", "first-party", "lo
 [tool.ruff.format]
 quote-style = "double"
 
+[tool.mypy]
+ignore_missing_imports = true
+namespace_packages = true
+explicit_package_bases = true
+exclude = ["tests", ".venv"]
+
 [tool.bumpversion]
 current_version = "5.2.1"
 parse = """(?x)

stac_fastapi/api/stac_fastapi/api/app.py

@@ -110,7 +110,7 @@ class StacApi:
             ),
             takes_self=True,
         ),
-        converter=update_openapi,
+        converter=update_openapi,  # type: ignore
     )
     router: APIRouter = attr.ib(default=attr.Factory(APIRouter))
     search_get_request_model: Type[BaseSearchGetRequest] = attr.ib(

stac_fastapi/api/stac_fastapi/api/models.py

@@ -56,7 +56,8 @@ def create_request_model(
         for model in models:
             for k, field_info in model.model_fields.items():
                 fields[k] = (field_info.annotation, field_info)
-        return create_model(model_name, **fields, __base__=base_model)
+
+        return create_model(model_name, **fields, __base__=base_model)  # type: ignore
 
     raise TypeError("Mixed Request Model types. Check extension request types.")
 
@@ -121,7 +122,7 @@ class ItemCollectionUri(APIRequest, DatetimeMixin):
             description="Limits the number of results that are included in each page of the response (capped to 10_000)."  # noqa: E501
         ),
     ] = attr.ib(default=10)
-    bbox: Optional[BBox] = attr.ib(default=None, converter=_bbox_converter)
+    bbox: Optional[BBox] = attr.ib(default=None, converter=_bbox_converter)  # type: ignore
     datetime: DateTimeQueryType = attr.ib(default=None, validator=_validate_datetime)
 
 

stac_fastapi/api/stac_fastapi/api/py.typed

@@ -3,7 +3,7 @@
 import copy
 import functools
 import inspect
-from typing import Any, Callable, Dict, List, Optional, Type, TypedDict, Union
+from typing import Any, Awaitable, Callable, Dict, List, Optional, Type, TypedDict, Union
 
 from fastapi import Depends, FastAPI, params
 from fastapi.datastructures import DefaultPlaceholder
@@ -39,7 +39,7 @@ async def run(*args, **kwargs):
 def create_async_endpoint(
     func: Callable,
     request_model: Union[Type[APIRequest], Type[BaseModel], Dict],
-):
+) -> Callable[[Any, Any], Awaitable[Any]]:
     """Wrap a function in a coroutine which may be used to create a FastAPI endpoint.
 
     Synchronous functions are executed asynchronously using a background thread.
@@ -48,32 +48,28 @@ def create_async_endpoint(
     if not inspect.iscoroutinefunction(func):
         func = sync_to_async(func)
 
-    if issubclass(request_model, APIRequest):
+    _endpoint: Callable[[Any, Any], Awaitable[Any]]
 
-        async def _endpoint(
-            request: Request,
-            request_data: request_model = Depends(),  # type:ignore
-        ):
+    if isinstance(request_model, dict):
+
+        async def _endpoint(request: Request, request_data: Dict[str, Any]):
+            """Endpoint."""
+            return _wrap_response(await func(request_data, request=request))
+
+    elif issubclass(request_model, APIRequest):
+
+        async def _endpoint(request: Request, request_data=Depends(request_model)):
             """Endpoint."""
             return _wrap_response(await func(request=request, **request_data.kwargs()))
 
     elif issubclass(request_model, BaseModel):
 
-        async def _endpoint(
-            request: Request,
-            request_data: request_model,  # type:ignore
-        ):
+        async def _endpoint(request: Request, request_data: request_model):  # type: ignore
             """Endpoint."""
             return _wrap_response(await func(request_data, request=request))
 
     else:
-
-        async def _endpoint(
-            request: Request,
-            request_data: Dict[str, Any],  # type:ignore
-        ):
-            """Endpoint."""
-            return _wrap_response(await func(request_data, request=request))
+        raise ValueError(f"Unsupported type for request model {type(request_model)}")
 
     return _endpoint
 

stac_fastapi/api/stac_fastapi/api/routes.py

@@ -4,7 +4,7 @@
 
 import attr
 
-from stac_fastapi.types import stac
+from stac_fastapi.types.stac import ItemCollection
 
 from .request import BaseCollectionSearchPostRequest
 
@@ -18,7 +18,7 @@ async def post_all_collections(
         self,
         search_request: BaseCollectionSearchPostRequest,
         **kwargs,
-    ) -> stac.ItemCollection:
+    ) -> ItemCollection:
         """Get all available collections.
 
         Called with `POST /collections`.
@@ -37,7 +37,7 @@ class BaseCollectionSearchClient(abc.ABC):
     @abc.abstractmethod
     def post_all_collections(
         self, search_request: BaseCollectionSearchPostRequest, **kwargs
-    ) -> stac.ItemCollection:
+    ) -> ItemCollection:
         """Get all available collections.
 
         Called with `POST /collections`.

stac_fastapi/extensions/stac_fastapi/extensions/core/collection_search/client.py

@@ -47,13 +47,13 @@ class CollectionSearchExtension(ApiExtension):
             the extension
     """
 
-    GET: BaseCollectionSearchGetRequest = attr.ib(default=BaseCollectionSearchGetRequest)
-    POST = None
+    GET: BaseCollectionSearchGetRequest = attr.ib(default=BaseCollectionSearchGetRequest)  # type: ignore
+    POST = attr.ib(init=False)
 
     conformance_classes: List[str] = attr.ib(
         default=[
-            CollectionSearchConformanceClasses.COLLECTIONSEARCH,
-            CollectionSearchConformanceClasses.BASIS,
+            CollectionSearchConformanceClasses.COLLECTIONSEARCH.value,
+            CollectionSearchConformanceClasses.BASIS.value,
         ]
     )
     schema_href: Optional[str] = attr.ib(default=None)
@@ -73,13 +73,14 @@ def register(self, app: FastAPI) -> None:
     def from_extensions(
         cls,
         extensions: List[ApiExtension],
+        *,
         schema_href: Optional[str] = None,
     ) -> "CollectionSearchExtension":
         """Create CollectionSearchExtension object from extensions."""
 
         conformance_classes = [
-            CollectionSearchConformanceClasses.COLLECTIONSEARCH,
-            CollectionSearchConformanceClasses.BASIS,
+            CollectionSearchConformanceClasses.COLLECTIONSEARCH.value,
+            CollectionSearchConformanceClasses.BASIS.value,
         ]
         for ext in extensions:
             conformance_classes.extend(ext.conformance_classes)
@@ -119,15 +120,15 @@ class CollectionSearchPostExtension(CollectionSearchExtension):
     settings: ApiSettings = attr.ib()
     conformance_classes: List[str] = attr.ib(
         default=[
-            CollectionSearchConformanceClasses.COLLECTIONSEARCH,
-            CollectionSearchConformanceClasses.BASIS,
+            CollectionSearchConformanceClasses.COLLECTIONSEARCH.value,
+            CollectionSearchConformanceClasses.BASIS.value,
         ]
     )
     schema_href: Optional[str] = attr.ib(default=None)
     router: APIRouter = attr.ib(factory=APIRouter)
 
-    GET: BaseCollectionSearchGetRequest = attr.ib(default=BaseCollectionSearchGetRequest)
-    POST: BaseCollectionSearchPostRequest = attr.ib(
+    GET: BaseCollectionSearchGetRequest = attr.ib(default=BaseCollectionSearchGetRequest)  # type: ignore
+    POST: BaseCollectionSearchPostRequest = attr.ib(  # type: ignore
         default=BaseCollectionSearchPostRequest
     )
 
@@ -163,19 +164,19 @@ def register(self, app: FastAPI) -> None:
         app.include_router(self.router)
 
     @classmethod
-    def from_extensions(
+    def from_extensions(  # type: ignore
         cls,
         extensions: List[ApiExtension],
         *,
+        schema_href: Optional[str] = None,
         client: Union[AsyncBaseCollectionSearchClient, BaseCollectionSearchClient],
         settings: ApiSettings,
-        schema_href: Optional[str] = None,
         router: Optional[APIRouter] = None,
     ) -> "CollectionSearchPostExtension":
         """Create CollectionSearchPostExtension object from extensions."""
         conformance_classes = [
-            CollectionSearchConformanceClasses.COLLECTIONSEARCH,
-            CollectionSearchConformanceClasses.BASIS,
+            CollectionSearchConformanceClasses.COLLECTIONSEARCH.value,
+            CollectionSearchConformanceClasses.BASIS.value,
         ]
         for ext in extensions:
             conformance_classes.extend(ext.conformance_classes)

stac_fastapi/extensions/stac_fastapi/extensions/core/collection_search/collection_search.py

@@ -24,7 +24,7 @@
 class BaseCollectionSearchGetRequest(APIRequest, DatetimeMixin):
     """Basics additional Collection-Search parameters for the GET request."""
 
-    bbox: Optional[BBox] = attr.ib(default=None, converter=_bbox_converter)
+    bbox: Optional[BBox] = attr.ib(default=None, converter=_bbox_converter)  # type: ignore
     datetime: DateTimeQueryType = attr.ib(default=None, validator=_validate_datetime)
     limit: Annotated[
         Optional[Limit],