implement details endpoint in Python servers

This commit is contained in:
Sarah Hoffmann
2023-02-03 21:14:33 +01:00
parent 104722a56a
commit 3ac70f7cc2
6 changed files with 100 additions and 19 deletions

View File

@@ -15,15 +15,18 @@ from falcon.asgi import App, Request, Response
from nominatim.api import NominatimAPIAsync
import nominatim.api.v1 as api_impl
from nominatim.config import Configuration
class ParamWrapper(api_impl.ASGIAdaptor):
""" Adaptor class for server glue to Falcon framework.
"""
def __init__(self, req: Request, resp: Response) -> None:
def __init__(self, req: Request, resp: Response,
config: Configuration) -> None:
self.request = req
self.response = resp
self._config = config
def get(self, name: str, default: Optional[str] = None) -> Optional[str]:
@@ -34,8 +37,13 @@ class ParamWrapper(api_impl.ASGIAdaptor):
return cast(Optional[str], self.request.get_header(name, default=default))
def error(self, msg: str) -> falcon.HTTPBadRequest:
return falcon.HTTPBadRequest(description=msg)
def error(self, msg: str, status: int = 400) -> falcon.HTTPError:
if status == 400:
return falcon.HTTPBadRequest(description=msg)
if status == 404:
return falcon.HTTPNotFound(description=msg)
return falcon.HTTPError(status, description=msg)
def create_response(self, status: int, output: str, content_type: str) -> None:
@@ -44,6 +52,10 @@ class ParamWrapper(api_impl.ASGIAdaptor):
self.response.content_type = content_type
def config(self) -> Configuration:
return self._config
class EndpointWrapper:
""" Converter for server glue endpoint functions to Falcon request handlers.
"""
@@ -56,7 +68,7 @@ class EndpointWrapper:
async def on_get(self, req: Request, resp: Response) -> None:
""" Implementation of the endpoint.
"""
await self.func(self.api, ParamWrapper(req, resp))
await self.func(self.api, ParamWrapper(req, resp, self.api.config))
def get_application(project_dir: Path,

View File

@@ -16,6 +16,7 @@ from sanic.response import text as TextResponse
from nominatim.api import NominatimAPIAsync
import nominatim.api.v1 as api_impl
from nominatim.config import Configuration
class ParamWrapper(api_impl.ASGIAdaptor):
""" Adaptor class for server glue to Sanic framework.
@@ -33,8 +34,8 @@ class ParamWrapper(api_impl.ASGIAdaptor):
return cast(Optional[str], self.request.headers.get(name, default))
def error(self, msg: str) -> SanicException:
return SanicException(msg, status_code=400)
def error(self, msg: str, status: int = 400) -> SanicException:
return SanicException(msg, status_code=status)
def create_response(self, status: int, output: str,
@@ -42,6 +43,10 @@ class ParamWrapper(api_impl.ASGIAdaptor):
return TextResponse(output, status=status, content_type=content_type)
def config(self) -> Configuration:
return cast(Configuration, self.request.app.ctx.api.config)
def _wrap_endpoint(func: api_impl.EndpointFunc)\
-> Callable[[Request], Coroutine[Any, Any, HTTPResponse]]:
async def _callback(request: Request) -> HTTPResponse:

View File

@@ -18,9 +18,9 @@ from starlette.requests import Request
from starlette.middleware import Middleware
from starlette.middleware.cors import CORSMiddleware
from nominatim.config import Configuration
from nominatim.api import NominatimAPIAsync
import nominatim.api.v1 as api_impl
from nominatim.config import Configuration
class ParamWrapper(api_impl.ASGIAdaptor):
""" Adaptor class for server glue to Starlette framework.
@@ -38,14 +38,18 @@ class ParamWrapper(api_impl.ASGIAdaptor):
return self.request.headers.get(name, default)
def error(self, msg: str) -> HTTPException:
return HTTPException(400, detail=msg)
def error(self, msg: str, status: int = 400) -> HTTPException:
return HTTPException(status, detail=msg)
def create_response(self, status: int, output: str, content_type: str) -> Response:
return Response(output, status_code=status, media_type=content_type)
def config(self) -> Configuration:
return cast(Configuration, self.request.app.state.API.config)
def _wrap_endpoint(func: api_impl.EndpointFunc)\
-> Callable[[Request], Coroutine[Any, Any, Response]]:
async def _callback(request: Request) -> Response: