update type informations (#869)

* update type informations

* update changelog

* run mypy

Author: vincentsarago

.github/workflows/cicd.yaml

@@ -35,6 +35,7 @@ jobs:
         if: ${{ matrix.python-version == env.LATEST_PY_VERSION }}
         run: |
           uv run pre-commit run --all-files
+          uv run --with mypy --with types-attrs mypy -p stac_fastapi
 
       - name: Run tests
         run: uv run pytest -svvv

.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
       - id: ruff-format
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.15.0
+    rev: v1.19.0
     hooks:
     - id: mypy
       language_version: python

CHANGES.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased]
 
+## [6.1.3] - 2025-12-09
+
+### Fixed 
+
+- fixed type hints
+
 ## [6.1.2] - 2025-12-09
 
 ### Fixed 

stac_fastapi/api/stac_fastapi/api/errors.py

@@ -93,6 +93,8 @@ def request_validation_exception_handler(
             status_code=status.HTTP_400_BAD_REQUEST,
         )
 
+    # TODO: Argument 2 to "add_exception_handler" of "Starlette" has incompatible type
     app.add_exception_handler(
-        RequestValidationError, request_validation_exception_handler
+        RequestValidationError,
+        request_validation_exception_handler,  # type: ignore
     )

stac_fastapi/api/stac_fastapi/api/middleware.py

@@ -86,7 +86,7 @@ def _get_forwarded_url_parts(self, scope: Scope) -> Tuple[str, str, str]:
         proto = scope.get("scheme", "http")
         header_host = self._get_header_value_by_name(scope, "host")
         if header_host is None:
-            domain, port = scope.get("server")
+            domain, port = scope["server"]
         else:
             header_host_parts = header_host.split(":")
             if len(header_host_parts) == 2:

stac_fastapi/api/stac_fastapi/api/models.py

@@ -24,19 +24,19 @@
     import orjson  # noqa
     from fastapi.responses import ORJSONResponse as JSONResponse
 except ImportError:  # pragma: nocover
-    from starlette.responses import JSONResponse
+    from starlette.responses import JSONResponse  # type: ignore
 
 
 def create_request_model(
     model_name="SearchGetRequest",
     base_model: Union[Type[BaseModel], Type[APIRequest]] = BaseSearchGetRequest,
     extensions: Optional[List[ApiExtension]] = None,
     mixins: Optional[Union[List[Type[BaseModel]], List[Type[APIRequest]]]] = None,
-    request_type: Optional[str] = "GET",
+    request_type: str = "GET",
 ) -> Union[Type[BaseModel], Type[APIRequest]]:
     """Create a pydantic model for validating request bodies."""
     fields = {}
-    extension_models = []
+    extension_models: List[Union[Type[BaseModel], Type[APIRequest]]] = []
 
     # Check extensions for additional parameters to search
     for extension in extensions or []:
@@ -54,7 +54,7 @@ def create_request_model(
     # Handle POST requests
     elif all([issubclass(m, BaseModel) for m in models]):
         for model in models:
-            for k, field_info in model.model_fields.items():
+            for k, field_info in model.model_fields.items():  # type: ignore
                 fields[k] = (field_info.annotation, field_info)
 
         return create_model(model_name, **fields, __base__=base_model)  # type: ignore
@@ -64,11 +64,10 @@ def create_request_model(
 
 def create_get_request_model(
     extensions: Optional[List[ApiExtension]],
-    base_model: BaseSearchGetRequest = BaseSearchGetRequest,
+    base_model: Type[BaseSearchGetRequest] = BaseSearchGetRequest,
 ) -> Type[APIRequest]:
     """Wrap create_request_model to create the GET request model."""
-
-    return create_request_model(
+    return create_request_model(  # type: ignore
         "SearchGetRequest",
         base_model=base_model,
         extensions=extensions,
@@ -78,10 +77,10 @@ def create_get_request_model(
 
 def create_post_request_model(
     extensions: Optional[List[ApiExtension]],
-    base_model: BaseSearchPostRequest = BaseSearchPostRequest,
+    base_model: Type[BaseSearchPostRequest] = BaseSearchPostRequest,
 ) -> Type[BaseModel]:
     """Wrap create_request_model to create the POST request model."""
-    return create_request_model(
+    return create_request_model(  # type: ignore
         "SearchPostRequest",
         base_model=base_model,
         extensions=extensions,

stac_fastapi/api/stac_fastapi/api/openapi.py

@@ -14,8 +14,11 @@ def update_openapi(app: FastAPI) -> FastAPI:
     content-type response header.
     """
     # Find the route for the openapi_url in the app
+    # TODO: Type info is Route, while it shoukd maybe be APIRoute? Check FastAPI source.
     openapi_route: Route = next(
-        route for route in app.router.routes if route.path == app.openapi_url
+        route
+        for route in app.router.routes
+        if route.path == app.openapi_url  # type: ignore
     )
     # Store the old endpoint function so we can call it from the patched function
     old_endpoint = openapi_route.endpoint

stac_fastapi/api/stac_fastapi/api/routes.py

@@ -16,7 +16,7 @@
 from starlette.routing import BaseRoute, Match
 from starlette.status import HTTP_204_NO_CONTENT
 
-from stac_fastapi.api.models import APIRequest
+from stac_fastapi.types.search import APIRequest
 
 
 def _wrap_response(resp: Any) -> Any:
@@ -58,7 +58,7 @@ async def _endpoint(request: Request, request_data: Dict[str, Any]):
 
     elif issubclass(request_model, APIRequest):
 
-        async def _endpoint(request: Request, request_data=Depends(request_model)):
+        async def _endpoint(request: Request, request_data=Depends(request_model)):  # type: ignore
             """Endpoint."""
             return _wrap_response(await func(request=request, **request_data.kwargs()))
 
@@ -100,10 +100,14 @@ def add_route_dependencies(
         _scope = copy.deepcopy(scope)
         for route in routes:
             if scope["path"] == "*":
-                _scope["path"] = route.path
+                # NOTE: ignore type, because BaseRoute has no "path" attribute
+                # but APIRoute does.
+                _scope["path"] = route.path  # type: ignore
 
+            # NOTE: ignore type, because BaseRoute has no "method" attribute
+            # but APIRoute does.
             if scope["method"] == "*":
-                _scope["method"] = list(route.methods)[0]
+                _scope["method"] = list(route.methods)[0]  # type: ignore
 
             match, _ = route.matches({"type": "http", **_scope})
             if match != Match.FULL:
@@ -119,7 +123,10 @@ def add_route_dependencies(
                 route.dependant.dependencies.insert(
                     0,
                     get_parameterless_sub_dependant(
-                        depends=depends, path=route.path_format
+                        # NOTE: ignore type, because BaseRoute has no "path_format"
+                        # attribute but APIRoute does.
+                        depends=depends,
+                        path=route.path_format,  # type: ignore
                     ),
                 )
 
@@ -128,7 +135,9 @@ def add_route_dependencies(
             # app.include_router(router))
             # https://github.com/tiangolo/fastapi/blob/58ab733f19846b4875c5b79bfb1f4d1cb7f4823f/fastapi/applications.py#L337-L360
             # https://github.com/tiangolo/fastapi/blob/58ab733f19846b4875c5b79bfb1f4d1cb7f4823f/fastapi/routing.py#L677-L678
-            route.dependencies.extend(dependencies)
+            # NOTE: ignore type, because BaseRoute has no "dependencies" attribute
+            # but APIRoute does.
+            route.dependencies.extend(dependencies)  # type: ignore
 
 
 def add_direct_response(app: FastAPI) -> None:

stac_fastapi/extensions/stac_fastapi/extensions/core/aggregation/aggregation.py

@@ -1,13 +1,15 @@
 """Aggregation Extension."""
 from enum import Enum
-from typing import List, Union
+from typing import List, Type, Union
 
 import attr
 from fastapi import APIRouter, FastAPI
+from pydantic import BaseModel
 
 from stac_fastapi.api.models import CollectionUri, EmptyRequest
 from stac_fastapi.api.routes import create_async_endpoint
 from stac_fastapi.types.extension import ApiExtension
+from stac_fastapi.types.search import APIRequest
 
 from .client import AsyncBaseAggregationClient, BaseAggregationClient
 from .request import AggregationExtensionGetRequest, AggregationExtensionPostRequest
@@ -50,8 +52,8 @@ class AggregationExtension(ApiExtension):
         conformance_classes: Conformance classes provided by the extension
     """
 
-    GET = AggregationExtensionGetRequest
-    POST = AggregationExtensionPostRequest
+    GET: Type[APIRequest] = AggregationExtensionGetRequest
+    POST: Type[BaseModel] = AggregationExtensionPostRequest
 
     client: Union[AsyncBaseAggregationClient, BaseAggregationClient] = attr.ib(
         factory=BaseAggregationClient

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

@@ -1,17 +1,19 @@
 """Collection-Search extension."""
 
 from enum import Enum
-from typing import List, Optional, Union
+from typing import List, Optional, Type, Union
 
 import attr
 from fastapi import APIRouter, FastAPI
+from pydantic import BaseModel
 from stac_pydantic.api.collections import Collections
 from stac_pydantic.shared import MimeTypes
 
 from stac_fastapi.api.models import GeoJSONResponse, create_request_model
 from stac_fastapi.api.routes import create_async_endpoint
 from stac_fastapi.types.config import ApiSettings
 from stac_fastapi.types.extension import ApiExtension
+from stac_fastapi.types.search import APIRequest
 
 from .client import AsyncBaseCollectionSearchClient, BaseCollectionSearchClient
 from .request import BaseCollectionSearchGetRequest, BaseCollectionSearchPostRequest
@@ -47,8 +49,8 @@ class CollectionSearchExtension(ApiExtension):
             the extension
     """
 
-    GET: BaseCollectionSearchGetRequest = attr.ib(default=BaseCollectionSearchGetRequest)  # type: ignore
-    POST = attr.ib(init=False)
+    GET: Type[APIRequest] = attr.ib(default=BaseCollectionSearchGetRequest)
+    POST: Optional[Type[BaseModel]] = attr.ib(init=False)
 
     conformance_classes: List[str] = attr.ib(
         default=[
@@ -93,7 +95,7 @@ def from_extensions(
         )
 
         return cls(
-            GET=get_request_model,
+            GET=get_request_model,  # type: ignore
             conformance_classes=conformance_classes,
             schema_href=schema_href,
         )
@@ -127,10 +129,8 @@ class CollectionSearchPostExtension(CollectionSearchExtension):
     schema_href: Optional[str] = attr.ib(default=None)
     router: APIRouter = attr.ib(factory=APIRouter)
 
-    GET: BaseCollectionSearchGetRequest = attr.ib(default=BaseCollectionSearchGetRequest)  # type: ignore
-    POST: BaseCollectionSearchPostRequest = attr.ib(  # type: ignore
-        default=BaseCollectionSearchPostRequest
-    )
+    GET: Type[APIRequest] = attr.ib(default=BaseCollectionSearchGetRequest)
+    POST: Type[BaseModel] = attr.ib(default=BaseCollectionSearchPostRequest)
 
     def register(self, app: FastAPI) -> None:
         """Register the extension with a FastAPI application.
@@ -198,8 +198,8 @@ def from_extensions(  # type: ignore
         return cls(
             client=client,
             settings=settings,
-            GET=get_request_model,
-            POST=post_request_model,
+            GET=get_request_model,  # type: ignore
+            POST=post_request_model,  # type: ignore
             conformance_classes=conformance_classes,
             router=router or APIRouter(),
             schema_href=schema_href,