mirror of
https://github.com/osm-search/Nominatim.git
synced 2026-02-16 15:47:58 +00:00
32c1e59622
Use a directory for the submodule where the __init__ file contains the public API. This makes it easier to separate public interface from the internal implementation.
82 lines
2.7 KiB
Python
82 lines
2.7 KiB
Python
# SPDX-License-Identifier: GPL-2.0-only
|
|
#
|
|
# This file is part of Nominatim. (https://nominatim.org)
|
|
#
|
|
# Copyright (C) 2023 by the Nominatim developer community.
|
|
# For a full list of authors see the git log.
|
|
"""
|
|
Server implementation using the falcon webserver framework.
|
|
"""
|
|
from typing import Type, Any, Optional, Mapping
|
|
from pathlib import Path
|
|
|
|
import falcon
|
|
import falcon.asgi
|
|
|
|
from nominatim.api import NominatimAPIAsync, StatusResult
|
|
import nominatim.result_formatter.v1 as formatting
|
|
|
|
CONTENT_TYPE = {
|
|
'text': falcon.MEDIA_TEXT,
|
|
'xml': falcon.MEDIA_XML
|
|
}
|
|
|
|
class NominatimV1:
|
|
""" Implementation of V1 version of the Nominatim API.
|
|
"""
|
|
|
|
def __init__(self, project_dir: Path, environ: Optional[Mapping[str, str]]) -> None:
|
|
self.api = NominatimAPIAsync(project_dir, environ)
|
|
self.formatters = {}
|
|
|
|
for rtype in (StatusResult, ):
|
|
self.formatters[rtype] = formatting.create(rtype)
|
|
|
|
|
|
def parse_format(self, req: falcon.asgi.Request, rtype: Type[Any], default: str) -> None:
|
|
""" Get and check the 'format' parameter and prepare the formatter.
|
|
`rtype` describes the expected return type and `default` the
|
|
format value to assume when no parameter is present.
|
|
"""
|
|
req.context.format = req.get_param('format', default=default)
|
|
req.context.formatter = self.formatters[rtype]
|
|
|
|
if not req.context.formatter.supports_format(req.context.format):
|
|
raise falcon.HTTPBadRequest(
|
|
description="Parameter 'format' must be one of: " +
|
|
', '.join(req.context.formatter.list_formats()))
|
|
|
|
|
|
def format_response(self, req: falcon.asgi.Request, resp: falcon.asgi.Response,
|
|
result: Any) -> None:
|
|
""" Render response into a string according to the formatter
|
|
set in `parse_format()`.
|
|
"""
|
|
resp.text = req.context.formatter.format(result, req.context.format)
|
|
resp.content_type = CONTENT_TYPE.get(req.context.format, falcon.MEDIA_JSON)
|
|
|
|
|
|
async def on_get_status(self, req: falcon.asgi.Request, resp: falcon.asgi.Response) -> None:
|
|
""" Implementation of status endpoint.
|
|
"""
|
|
self.parse_format(req, StatusResult, 'text')
|
|
|
|
result = await self.api.status()
|
|
|
|
self.format_response(req, resp, result)
|
|
if result.status and req.context.format == 'text':
|
|
resp.status = 500
|
|
|
|
|
|
def get_application(project_dir: Path,
|
|
environ: Optional[Mapping[str, str]] = None) -> falcon.asgi.App:
|
|
""" Create a Nominatim falcon ASGI application.
|
|
"""
|
|
app = falcon.asgi.App()
|
|
|
|
api = NominatimV1(project_dir, environ)
|
|
|
|
app.add_route('/status', api, suffix='status')
|
|
|
|
return app
|