X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/345c812e4357087e1568f44e6e9d451e5ee6729a..32c1e59622a8e9f76c351160e7150e625e3238a3:/nominatim/clicmd/api.py diff --git a/nominatim/clicmd/api.py b/nominatim/clicmd/api.py index e0dfab79..050665f8 100644 --- a/nominatim/clicmd/api.py +++ b/nominatim/clicmd/api.py @@ -1,10 +1,21 @@ +# 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. """ Subcommand definitions for API calls from the command line. """ +from typing import Mapping, Dict +import argparse import logging from nominatim.tools.exec_utils import run_api_script from nominatim.errors import UsageError +from nominatim.clicmd.args import NominatimArgs +from nominatim.api import NominatimAPI, StatusResult +import nominatim.result_formatter.v1 as formatting # Do not repeat documentation of subcommand classes. # pylint: disable=C0111 @@ -36,7 +47,7 @@ DETAILS_SWITCHES = ( ('polygon_geojson', 'Include geometry of result') ) -def _add_api_output_arguments(parser): +def _add_api_output_arguments(parser: argparse.ArgumentParser) -> None: group = parser.add_argument_group('Output arguments') group.add_argument('--format', default='jsonv2', choices=['xml', 'json', 'jsonv2', 'geojson', 'geocodejson'], @@ -54,7 +65,7 @@ def _add_api_output_arguments(parser): "Parameter is difference tolerance in degrees.")) -def _run_api(endpoint, args, params): +def _run_api(endpoint: str, args: NominatimArgs, params: Mapping[str, object]) -> int: script_file = args.project_dir / 'website' / (endpoint + '.php') if not script_file.exists(): @@ -76,8 +87,7 @@ class APISearch: https://nominatim.org/release-docs/latest/api/Search/ """ - @staticmethod - def add_args(parser): + def add_args(self, parser: argparse.ArgumentParser) -> None: group = parser.add_argument_group('Query arguments') group.add_argument('--query', help='Free-form query string') @@ -103,8 +113,8 @@ class APISearch: help='Do not remove duplicates from the result list') - @staticmethod - def run(args): + def run(self, args: NominatimArgs) -> int: + params: Dict[str, object] if args.query: params = dict(q=args.query) else: @@ -139,8 +149,7 @@ class APIReverse: https://nominatim.org/release-docs/latest/api/Reverse/ """ - @staticmethod - def add_args(parser): + def add_args(self, parser: argparse.ArgumentParser) -> None: group = parser.add_argument_group('Query arguments') group.add_argument('--lat', type=float, required=True, help='Latitude of coordinate to look up (in WGS84)') @@ -152,17 +161,14 @@ class APIReverse: _add_api_output_arguments(parser) - @staticmethod - def run(args): - params = dict(lat=args.lat, lon=args.lon) + def run(self, args: NominatimArgs) -> int: + params = dict(lat=args.lat, lon=args.lon, format=args.format) if args.zoom is not None: params['zoom'] = args.zoom for param, _ in EXTRADATA_PARAMS: if getattr(args, param): params[param] = '1' - if args.format: - params['format'] = args.format if args.lang: params['accept-language'] = args.lang if args.polygon_output: @@ -183,8 +189,7 @@ class APILookup: https://nominatim.org/release-docs/latest/api/Lookup/ """ - @staticmethod - def add_args(parser): + def add_args(self, parser: argparse.ArgumentParser) -> None: group = parser.add_argument_group('Query arguments') group.add_argument('--id', metavar='OSMID', action='append', required=True, dest='ids', @@ -193,15 +198,12 @@ class APILookup: _add_api_output_arguments(parser) - @staticmethod - def run(args): - params = dict(osm_ids=','.join(args.ids)) + def run(self, args: NominatimArgs) -> int: + params: Dict[str, object] = dict(osm_ids=','.join(args.ids), format=args.format) for param, _ in EXTRADATA_PARAMS: if getattr(args, param): params[param] = '1' - if args.format: - params['format'] = args.format if args.lang: params['accept-language'] = args.lang if args.polygon_output: @@ -222,8 +224,7 @@ class APIDetails: https://nominatim.org/release-docs/latest/api/Details/ """ - @staticmethod - def add_args(parser): + def add_args(self, parser: argparse.ArgumentParser) -> None: group = parser.add_argument_group('Query arguments') objs = group.add_mutually_exclusive_group(required=True) objs.add_argument('--node', '-n', type=int, @@ -244,26 +245,28 @@ class APIDetails: group.add_argument('--lang', '--accept-language', metavar='LANGS', help='Preferred language order for presenting search results') - @staticmethod - def run(args): + + def run(self, args: NominatimArgs) -> int: if args.node: params = dict(osmtype='N', osmid=args.node) elif args.way: - params = dict(osmtype='W', osmid=args.node) + params = dict(osmtype='W', osmid=args.way) elif args.relation: - params = dict(osmtype='R', osmid=args.node) + params = dict(osmtype='R', osmid=args.relation) else: params = dict(place_id=args.place_id) if args.object_class: params['class'] = args.object_class for name, _ in DETAILS_SWITCHES: params[name] = '1' if getattr(args, name) else '0' + if args.lang: + params['accept-language'] = args.lang return _run_api('details', args, params) class APIStatus: - """\ + """ Execute API status query. This command works exactly the same as if calling the /status endpoint on @@ -272,12 +275,14 @@ class APIStatus: https://nominatim.org/release-docs/latest/api/Status/ """ - @staticmethod - def add_args(parser): + def add_args(self, parser: argparse.ArgumentParser) -> None: + formats = formatting.create(StatusResult).list_formats() group = parser.add_argument_group('API parameters') - group.add_argument('--format', default='text', choices=['text', 'json'], + group.add_argument('--format', default=formats[0], choices=formats, help='Format of result') - @staticmethod - def run(args): - return _run_api('status', args, dict(format=args.format)) + + def run(self, args: NominatimArgs) -> int: + status = NominatimAPI(args.project_dir).status() + print(formatting.create(StatusResult).format(status, args.format)) + return 0