X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/bc8b2d4ae0dbaef64448ddcb530de9626da9d82d..32c1e59622a8e9f76c351160e7150e625e3238a3:/nominatim/clicmd/api.py diff --git a/nominatim/clicmd/api.py b/nominatim/clicmd/api.py index b99d37b8..050665f8 100644 --- a/nominatim/clicmd/api.py +++ b/nominatim/clicmd/api.py @@ -1,9 +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 @@ -20,22 +32,22 @@ STRUCTURED_QUERY = ( ) EXTRADATA_PARAMS = ( - ('addressdetails', 'Include a breakdown of the address into elements.'), + ('addressdetails', 'Include a breakdown of the address into elements'), ('extratags', ("Include additional information if available " - "(e.g. wikipedia link, opening hours).")), - ('namedetails', 'Include a list of alternative names.') + "(e.g. wikipedia link, opening hours)")), + ('namedetails', 'Include a list of alternative names') ) DETAILS_SWITCHES = ( - ('addressdetails', 'Include a breakdown of the address into elements.'), - ('keywords', 'Include a list of name keywords and address keywords.'), - ('linkedplaces', 'Include a details of places that are linked with this one.'), - ('hierarchy', 'Include details of places lower in the address hierarchy.'), - ('group_hierarchy', 'Group the places by type.'), - ('polygon_geojson', 'Include geometry of result.') + ('addressdetails', 'Include a breakdown of the address into elements'), + ('keywords', 'Include a list of name keywords and address keywords'), + ('linkedplaces', 'Include a details of places that are linked with this one'), + ('hierarchy', 'Include details of places lower in the address hierarchy'), + ('group_hierarchy', 'Group the places by type'), + ('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'], @@ -47,19 +59,35 @@ def _add_api_output_arguments(parser): help='Preferred language order for presenting search results') group.add_argument('--polygon-output', choices=['geojson', 'kml', 'svg', 'text'], - help='Output geometry of results as a GeoJSON, KML, SVG or WKT.') + help='Output geometry of results as a GeoJSON, KML, SVG or WKT') group.add_argument('--polygon-threshold', type=float, metavar='TOLERANCE', help=("Simplify output geometry." "Parameter is difference tolerance in degrees.")) +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(): + LOG.error("Cannot find API script file.\n\n" + "Make sure to run 'nominatim' from the project directory \n" + "or use the option --project-dir.") + raise UsageError("API script not found.") + + return run_api_script(endpoint, args.project_dir, + phpcgi_bin=args.phpcgi_path, params=params) + class APISearch: """\ - Execute API search query. + Execute a search query. + + This command works exactly the same as if calling the /search endpoint on + the web API. See the online documentation for more details on the + various parameters: + 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') @@ -70,7 +98,7 @@ class APISearch: group = parser.add_argument_group('Result limitation') group.add_argument('--countrycodes', metavar='CC,..', - help='Limit search results to one or more countries.') + help='Limit search results to one or more countries') group.add_argument('--exclude_place_ids', metavar='ID,..', help='List of search object to be excluded') group.add_argument('--limit', type=int, @@ -85,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: @@ -109,16 +137,19 @@ class APISearch: if not args.dedupe: params['dedupe'] = '0' - return run_api_script('search', args.project_dir, - phpcgi_bin=args.phpcgi_path, params=params) + return _run_api('search', args, params) class APIReverse: """\ Execute API reverse query. + + This command works exactly the same as if calling the /reverse endpoint on + the web API. See the online documentation for more details on the + various parameters: + 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)') @@ -130,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: @@ -148,17 +176,20 @@ class APIReverse: if args.polygon_threshold: params['polygon_threshold'] = args.polygon_threshold - return run_api_script('reverse', args.project_dir, - phpcgi_bin=args.phpcgi_path, params=params) + return _run_api('reverse', args, params) class APILookup: """\ Execute API lookup query. + + This command works exactly the same as if calling the /lookup endpoint on + the web API. See the online documentation for more details on the + various parameters: + 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', @@ -167,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: @@ -183,17 +211,20 @@ class APILookup: if args.polygon_threshold: params['polygon_threshold'] = args.polygon_threshold - return run_api_script('lookup', args.project_dir, - phpcgi_bin=args.phpcgi_path, params=params) + return _run_api('lookup', args, params) class APIDetails: """\ Execute API details query. + + This command works exactly the same as if calling the /details endpoint on + the web API. See the online documentation for more details on the + various parameters: + 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, @@ -203,7 +234,7 @@ class APIDetails: objs.add_argument('--relation', '-r', type=int, help="Look up the OSM relation with the given ID.") objs.add_argument('--place_id', '-p', type=int, - help='Database internal identifier of the OSM object to look up.') + help='Database internal identifier of the OSM object to look up') group.add_argument('--class', dest='object_class', help=("Class type to disambiguated multiple entries " "of the same object.")) @@ -214,38 +245,44 @@ 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_script('details', args.project_dir, - phpcgi_bin=args.phpcgi_path, params=params) + 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 + the web API. See the online documentation for more details on the + various parameters: + 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_script('status', args.project_dir, - phpcgi_bin=args.phpcgi_path, - params=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