stac-fastapi.api 5.2.0__tar.gz → 6.0.0__tar.gz

{stac_fastapi_api-5.2.0 → stac_fastapi_api-6.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stac-fastapi.api
-Version: 5.2.0
+Version: 6.0.0
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering
@@ -19,7 +19,7 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: brotli_asgi
-Requires-Dist: stac-fastapi.types~=5.2
+Requires-Dist: stac-fastapi.types~=6.0
 Provides-Extra: dev
 Requires-Dist: httpx; extra == "dev"
 Requires-Dist: pytest; extra == "dev"

{stac_fastapi_api-5.2.0 → stac_fastapi_api-6.0.0}/setup.py

@@ -7,7 +7,7 @@ with open("README.md") as f:
 
 install_requires = [
     "brotli_asgi",
-    "stac-fastapi.types~=5.2",
+    "stac-fastapi.types~=6.0",
 ]
 
 extra_reqs = {

{stac_fastapi_api-5.2.0 → stac_fastapi_api-6.0.0}/stac_fastapi/api/app.py

@@ -12,7 +12,7 @@ from stac_pydantic.api.collections import Collections
 from stac_pydantic.shared import MimeTypes
 from stac_pydantic.version import STAC_VERSION
 from starlette.middleware import Middleware
-from starlette.responses import JSONResponse, Response
+from starlette.responses import Response
 
 from stac_fastapi.api.errors import DEFAULT_STATUS_CODES, add_exception_handlers
 from stac_fastapi.api.middleware import CORSMiddleware, ProxyHeaderMiddleware
@@ -21,8 +21,10 @@ from stac_fastapi.api.models import (
     CollectionUri,
     EmptyRequest,
     GeoJSONResponse,
+    HealthCheck,
     ItemCollectionUri,
     ItemUri,
+    JSONResponse,
 )
 from stac_fastapi.api.openapi import update_openapi
 from stac_fastapi.api.routes import (
@@ -108,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(
@@ -396,12 +398,15 @@ class StacApi:
         mgmt_router.add_api_route(
             name="Health",
             path="/_mgmt/health",
-            response_model=Dict,
+            response_model=(
+                HealthCheck if self.settings.enable_response_models else None
+            ),
             responses={
                 200: {
                     "content": {
                         MimeTypes.json.value: {},
                     },
+                    "model": HealthCheck,
                 },
             },
             response_class=self.response_class,

{stac_fastapi_api-5.2.0 → stac_fastapi_api-6.0.0}/stac_fastapi/api/errors.py

@@ -8,8 +8,8 @@ from fastapi.encoders import jsonable_encoder
 from fastapi.exceptions import RequestValidationError, ResponseValidationError
 from starlette import status
 from starlette.requests import Request
-from starlette.responses import JSONResponse
 
+from stac_fastapi.api.models import JSONResponse
 from stac_fastapi.types.errors import (
     ConflictError,
     DatabaseError,

{stac_fastapi_api-5.2.0 → stac_fastapi_api-6.0.0}/stac_fastapi/api/models.py

@@ -1,6 +1,6 @@
 """Api request/response models."""
 
-from typing import List, Optional, Type, Union
+from typing import List, Literal, Optional, Type, Union
 
 import attr
 from fastapi import Path, Query
@@ -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)
 
 
@@ -135,3 +136,9 @@ class JSONSchemaResponse(JSONResponse):
     """JSON with custom, vendor content-type."""
 
     media_type = "application/schema+json"
+
+
+class HealthCheck(BaseModel, extra="allow"):
+    """health check response model."""
+
+    status: Literal["UP", "DOWN"]

{stac_fastapi_api-5.2.0 → stac_fastapi_api-6.0.0}/stac_fastapi/api/openapi.py

@@ -2,7 +2,7 @@
 
 from fastapi import FastAPI
 from starlette.requests import Request
-from starlette.responses import JSONResponse, Response
+from starlette.responses import Response
 from starlette.routing import Route, request_response
 
 
@@ -22,7 +22,7 @@ def update_openapi(app: FastAPI) -> FastAPI:
     # Create a patched endpoint function that modifies the content type of the response
     async def patched_openapi_endpoint(req: Request) -> Response:
         # Get the response from the old endpoint function
-        response: JSONResponse = await old_endpoint(req)
+        response = await old_endpoint(req)
         # Update the content type header in place
         response.headers["content-type"] = "application/vnd.oai.openapi+json;version=3.0"
         # Return the updated response

{stac_fastapi_api-5.2.0 → stac_fastapi_api-6.0.0}/stac_fastapi/api/routes.py

@@ -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 @@ def sync_to_async(func):
 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-5.2.0 → stac_fastapi_api-6.0.0}/stac_fastapi/api/version.py

@@ -1,3 +1,3 @@
 """Library version."""
 
-__version__ = "5.2.0"
+__version__ = "6.0.0"

{stac_fastapi_api-5.2.0 → stac_fastapi_api-6.0.0}/stac_fastapi.api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stac-fastapi.api
-Version: 5.2.0
+Version: 6.0.0
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering
@@ -19,7 +19,7 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: brotli_asgi
-Requires-Dist: stac-fastapi.types~=5.2
+Requires-Dist: stac-fastapi.types~=6.0
 Provides-Extra: dev
 Requires-Dist: httpx; extra == "dev"
 Requires-Dist: pytest; extra == "dev"

{stac_fastapi_api-5.2.0 → stac_fastapi_api-6.0.0}/stac_fastapi.api.egg-info/SOURCES.txt

@@ -14,6 +14,7 @@ stac_fastapi/api/errors.py
 stac_fastapi/api/middleware.py
 stac_fastapi/api/models.py
 stac_fastapi/api/openapi.py
+stac_fastapi/api/py.typed
 stac_fastapi/api/routes.py
 stac_fastapi/api/version.py
 tests/test_api.py

{stac_fastapi_api-5.2.0 → stac_fastapi_api-6.0.0}/stac_fastapi.api.egg-info/requires.txt

@@ -1,5 +1,5 @@
 brotli_asgi
-stac-fastapi.types~=5.2
+stac-fastapi.types~=6.0
 
 [benchmark]
 pytest-benchmark

{stac_fastapi_api-5.2.0 → stac_fastapi_api-6.0.0}/tests/test_api.py

@@ -3,10 +3,8 @@ from starlette.testclient import TestClient
 
 from stac_fastapi.api.app import StacApi
 from stac_fastapi.api.models import ItemCollectionUri, create_request_model
-from stac_fastapi.extensions.core import (
-    TokenPaginationExtension,
-    TransactionExtension,
-)
+from stac_fastapi.extensions.core import TokenPaginationExtension, TransactionExtension
+from stac_fastapi.extensions.core.transaction import BaseTransactionsClient
 from stac_fastapi.types import config, core
 
 
@@ -421,7 +419,7 @@ class DummyCoreClient(core.BaseCoreClient):
         ...
 
 
-class DummyTransactionsClient(core.BaseTransactionsClient):
+class DummyTransactionsClient(BaseTransactionsClient):
     """Defines a pattern for implementing the STAC transaction extension."""
 
     def create_item(self, *args, **kwargs):
@@ -430,6 +428,9 @@ class DummyTransactionsClient(core.BaseTransactionsClient):
     def update_item(self, *args, **kwargs):
         return "dummy response"
 
+    def patch_item(self, *args, **kwargs):
+        return "dummy response"
+
     def delete_item(self, *args, **kwargs):
         return "dummy response"
 
@@ -439,6 +440,9 @@ class DummyTransactionsClient(core.BaseTransactionsClient):
     def update_collection(self, *args, **kwargs):
         return "dummy response"
 
+    def patch_collection(self, *args, **kwargs):
+        return "dummy response"
+
     def delete_collection(self, *args, **kwargs):
         return "dummy response"
 

{stac_fastapi_api-5.2.0 → stac_fastapi_api-6.0.0}/tests/test_models.py

@@ -43,7 +43,10 @@ def test_create_get_request_model():
     model = request_model(bbox="0,0,0,1,1,1")
     assert model.bbox == (0.0, 0.0, 0.0, 1.0, 1.0, 1.0)
 
-    with pytest.raises(AssertionError):
+    with pytest.raises(HTTPException):
+        request_model(bbox="a,b")
+
+    with pytest.raises(HTTPException):
         request_model(bbox="0,0,0,1,1")
 
     model = request_model(