Skip to content

do not wrap response into response_class #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 5, 2024
Merged

do not wrap response into response_class #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 8 additions & 20 deletions stac_fastapi/api/stac_fastapi/api/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,7 @@ def register_landing_page(self):
response_model_exclude_unset=False,
response_model_exclude_none=True,
methods=["GET"],
endpoint=create_async_endpoint(
self.client.landing_page, EmptyRequest, self.response_class
),
endpoint=create_async_endpoint(self.client.landing_page, EmptyRequest),
)

def register_conformance_classes(self):
Expand All @@ -170,9 +168,7 @@ def register_conformance_classes(self):
response_model_exclude_unset=True,
response_model_exclude_none=True,
methods=["GET"],
endpoint=create_async_endpoint(
self.client.conformance, EmptyRequest, self.response_class
),
endpoint=create_async_endpoint(self.client.conformance, EmptyRequest),
)

def register_get_item(self):
Expand All @@ -197,9 +193,7 @@ def register_get_item(self):
response_model_exclude_unset=True,
response_model_exclude_none=True,
methods=["GET"],
endpoint=create_async_endpoint(
self.client.get_item, ItemUri, GeoJSONResponse
),
endpoint=create_async_endpoint(self.client.get_item, ItemUri),
)

def register_post_search(self):
Expand Down Expand Up @@ -230,7 +224,7 @@ def register_post_search(self):
response_model_exclude_none=True,
methods=["POST"],
endpoint=create_async_endpoint(
self.client.post_search, self.search_post_request_model, GeoJSONResponse
self.client.post_search, self.search_post_request_model
),
)

Expand Down Expand Up @@ -262,7 +256,7 @@ def register_get_search(self):
response_model_exclude_none=True,
methods=["GET"],
endpoint=create_async_endpoint(
self.client.get_search, self.search_get_request_model, GeoJSONResponse
self.client.get_search, self.search_get_request_model
),
)

Expand Down Expand Up @@ -290,9 +284,7 @@ def register_get_collections(self):
response_model_exclude_unset=True,
response_model_exclude_none=True,
methods=["GET"],
endpoint=create_async_endpoint(
self.client.all_collections, EmptyRequest, self.response_class
),
endpoint=create_async_endpoint(self.client.all_collections, EmptyRequest),
)

def register_get_collection(self):
Expand All @@ -319,9 +311,7 @@ def register_get_collection(self):
response_model_exclude_unset=True,
response_model_exclude_none=True,
methods=["GET"],
endpoint=create_async_endpoint(
self.client.get_collection, CollectionUri, self.response_class
),
endpoint=create_async_endpoint(self.client.get_collection, CollectionUri),
)

def register_get_item_collection(self):
Expand Down Expand Up @@ -358,9 +348,7 @@ def register_get_item_collection(self):
response_model_exclude_unset=True,
response_model_exclude_none=True,
methods=["GET"],
endpoint=create_async_endpoint(
self.client.item_collection, request_model, GeoJSONResponse
),
endpoint=create_async_endpoint(self.client.item_collection, request_model),
)

def register_core(self):
Expand Down
3 changes: 2 additions & 1 deletion stac_fastapi/api/stac_fastapi/api/errors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from typing import Callable, Dict, Type, TypedDict

from fastapi import FastAPI
from fastapi.exceptions import RequestValidationError
from fastapi.exceptions import RequestValidationError, ResponseValidationError
from starlette import status
from starlette.requests import Request
from starlette.responses import JSONResponse
Expand All @@ -27,6 +27,7 @@
DatabaseError: status.HTTP_424_FAILED_DEPENDENCY,
Exception: status.HTTP_500_INTERNAL_SERVER_ERROR,
InvalidQueryParameter: status.HTTP_400_BAD_REQUEST,
ResponseValidationError: status.HTTP_500_INTERNAL_SERVER_ERROR,
}


Expand Down
13 changes: 9 additions & 4 deletions stac_fastapi/api/stac_fastapi/api/routes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,25 @@
from stac_pydantic.shared import StacBaseModel
from starlette.concurrency import run_in_threadpool
from starlette.requests import Request
from starlette.responses import JSONResponse, Response
from starlette.responses import Response
from starlette.routing import BaseRoute, Match
from starlette.status import HTTP_204_NO_CONTENT

from stac_fastapi.api.models import APIRequest


def _wrap_response(resp: Any, response_class: Type[Response]) -> Response:
def _wrap_response(
resp: Any,
response_class: Optional[Type[Response]] = None,
) -> Response:
if isinstance(resp, Response):
return resp
elif isinstance(resp, StacBaseModel):
return resp
elif resp is not None:
return response_class(resp)
if response_class:
return response_class(resp)
return resp
else: # None is returned as 204 No Content
return Response(status_code=HTTP_204_NO_CONTENT)

Expand All @@ -41,7 +46,7 @@ async def run(*args, **kwargs):
def create_async_endpoint(
func: Callable,
request_model: Union[Type[APIRequest], Type[BaseModel], Dict],
response_class: Type[Response] = JSONResponse,
response_class: Optional[Type[Response]] = None,
):
"""Wrap a function in a coroutine which may be used to create a FastAPI endpoint.

Expand Down