X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/d7cf81c0473a3d6c280607ed8b90ba17fdf414f7..ae8694a6a6862d7cb66cd91102d2802c9899e7cf:/src/nominatim_api/server/asgi_adaptor.py diff --git a/src/nominatim_api/server/asgi_adaptor.py b/src/nominatim_api/server/asgi_adaptor.py index 49fe288f..77c50f31 100644 --- a/src/nominatim_api/server/asgi_adaptor.py +++ b/src/nominatim_api/server/asgi_adaptor.py @@ -16,13 +16,13 @@ from ..core import NominatimAPIAsync from ..result_formatting import FormatDispatcher from .content_types import CONTENT_TEXT + class ASGIAdaptor(abc.ABC): """ Adapter class for the different ASGI frameworks. Wraps functionality over concrete requests and responses. """ content_type: str = CONTENT_TEXT - @abc.abstractmethod def get(self, name: str, default: Optional[str] = None) -> Optional[str]: """ Return an input parameter as a string. If the parameter was @@ -35,14 +35,12 @@ class ASGIAdaptor(abc.ABC): not provided, return the 'default' value. """ - @abc.abstractmethod def error(self, msg: str, status: int = 400) -> Exception: """ Construct an appropriate exception from the given error message. The exception must result in a HTTP error with the given status. """ - @abc.abstractmethod def create_response(self, status: int, output: str, num_results: int) -> Any: """ Create a response from the given parameters. The result will @@ -55,25 +53,21 @@ class ASGIAdaptor(abc.ABC): body of the response to 'output'. """ - @abc.abstractmethod def base_uri(self) -> str: """ Return the URI of the original request. """ - @abc.abstractmethod def config(self) -> Configuration: """ Return the current configuration object. """ - @abc.abstractmethod def formatting(self) -> FormatDispatcher: """ Return the formatting object to use. """ - def get_int(self, name: str, default: Optional[int] = None) -> int: """ Return an input parameter as an int. Raises an exception if the parameter is given but not in an integer format. @@ -97,7 +91,6 @@ class ASGIAdaptor(abc.ABC): return intval - def get_float(self, name: str, default: Optional[float] = None) -> float: """ Return an input parameter as a flaoting-point number. Raises an exception if the parameter is given but not in an float format. @@ -124,7 +117,6 @@ class ASGIAdaptor(abc.ABC): return fval - def get_bool(self, name: str, default: Optional[bool] = None) -> bool: """ Return an input parameter as bool. Only '0' is accepted as an input for 'false' all other inputs will be interpreted as 'true'. @@ -143,7 +135,6 @@ class ASGIAdaptor(abc.ABC): return value != '0' - def raise_error(self, msg: str, status: int = 400) -> NoReturn: """ Raise an exception resulting in the given HTTP status and message. The message will be formatted according to the