+# SPDX-License-Identifier: GPL-2.0-only
+#
+# This file is part of Nominatim. (https://nominatim.org)
+#
+# Copyright (C) 2022 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
# Do not repeat documentation of subcommand classes.
# pylint: disable=C0111
)
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'],
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')
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,
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:
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)')
_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:
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',
_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:
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,
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."))
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['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:
group = parser.add_argument_group('API parameters')
group.add_argument('--format', default='text', choices=['text', 'json'],
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:
+ return _run_api('status', args, dict(format=args.format))
projects / nominatim.git / blobdiff