X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/45c675bd786ff70c1417fc8e92cff8d3a2ad6e75..6e81596609518d9202a00bd457af0a75648d30d9:/nominatim/clicmd/api.py?ds=inline diff --git a/nominatim/clicmd/api.py b/nominatim/clicmd/api.py index 9a4828b8..e198e541 100644 --- a/nominatim/clicmd/api.py +++ b/nominatim/clicmd/api.py @@ -2,7 +2,7 @@ # # This file is part of Nominatim. (https://nominatim.org) # -# Copyright (C) 2022 by the Nominatim developer community. +# 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. @@ -10,13 +10,15 @@ Subcommand definitions for API calls from the command line. from typing import Mapping, Dict import argparse import logging +import json +import sys 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 -from nominatim.apicmd.status import StatusResult -import nominatim.result_formatter.v1 as formatting +import nominatim.api as napi +import nominatim.api.v1 as api_output +from nominatim.api.v1.server_glue import REVERSE_MAX_RANKS # Do not repeat documentation of subcommand classes. # pylint: disable=C0111 @@ -39,15 +41,6 @@ EXTRADATA_PARAMS = ( ('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') -) - def _add_api_output_arguments(parser: argparse.ArgumentParser) -> None: group = parser.add_argument_group('Output arguments') group.add_argument('--format', default='jsonv2', @@ -61,7 +54,8 @@ def _add_api_output_arguments(parser: argparse.ArgumentParser) -> None: group.add_argument('--polygon-output', choices=['geojson', 'kml', 'svg', 'text'], help='Output geometry of results as a GeoJSON, KML, SVG or WKT') - group.add_argument('--polygon-threshold', type=float, metavar='TOLERANCE', + group.add_argument('--polygon-threshold', type=float, default = 0.0, + metavar='TOLERANCE', help=("Simplify output geometry." "Parameter is difference tolerance in degrees.")) @@ -158,26 +152,46 @@ class APIReverse: help='Longitude of coordinate to look up (in WGS84)') group.add_argument('--zoom', type=int, help='Level of detail required for the address') + group.add_argument('--layer', metavar='LAYER', + choices=[n.name.lower() for n in napi.DataLayer if n.name], + action='append', required=False, dest='layers', + help='OSM id to lookup in format (may be repeated)') _add_api_output_arguments(parser) 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 + api = napi.NominatimAPI(args.project_dir) - for param, _ in EXTRADATA_PARAMS: - if getattr(args, param): - params[param] = '1' - if args.lang: - params['accept-language'] = args.lang - if args.polygon_output: - params['polygon_' + args.polygon_output] = '1' - if args.polygon_threshold: - params['polygon_threshold'] = args.polygon_threshold + details = napi.LookupDetails(address_details=True, # needed for display name + geometry_output=args.get_geometry_output(), + geometry_simplification=args.polygon_threshold or 0.0) + + result = api.reverse(napi.Point(args.lon, args.lat), + REVERSE_MAX_RANKS[max(0, min(18, args.zoom or 18))], + args.get_layers(napi.DataLayer.ADDRESS | napi.DataLayer.POI), + details) + + if result: + output = api_output.format_result( + napi.ReverseResults([result]), + args.format, + {'locales': args.get_locales(api.config.DEFAULT_LANGUAGE), + 'extratags': args.extratags, + 'namedetails': args.namedetails, + 'addressdetails': args.addressdetails}) + if args.format != 'xml': + # reformat the result, so it is pretty-printed + json.dump(json.loads(output), sys.stdout, indent=4, ensure_ascii=False) + else: + sys.stdout.write(output) + sys.stdout.write('\n') + + return 0 + + LOG.error("Unable to geocode.") + return 42 - return _run_api('reverse', args, params) class APILookup: @@ -241,29 +255,59 @@ class APIDetails: "of the same object.")) group = parser.add_argument_group('Output arguments') - for name, desc in DETAILS_SWITCHES: - group.add_argument('--' + name, action='store_true', help=desc) + group.add_argument('--addressdetails', action='store_true', + help='Include a breakdown of the address into elements') + group.add_argument('--keywords', action='store_true', + help='Include a list of name keywords and address keywords') + group.add_argument('--linkedplaces', action='store_true', + help='Include a details of places that are linked with this one') + group.add_argument('--hierarchy', action='store_true', + help='Include details of places lower in the address hierarchy') + group.add_argument('--group_hierarchy', action='store_true', + help='Group the places by type') + group.add_argument('--polygon_geojson', action='store_true', + help='Include geometry of result') group.add_argument('--lang', '--accept-language', metavar='LANGS', help='Preferred language order for presenting search results') def run(self, args: NominatimArgs) -> int: + place: napi.PlaceRef if args.node: - params = dict(osmtype='N', osmid=args.node) + place = napi.OsmID('N', args.node, args.object_class) elif args.way: - params = dict(osmtype='W', osmid=args.node) + place = napi.OsmID('W', args.way, args.object_class) elif args.relation: - params = dict(osmtype='R', osmid=args.node) + place = napi.OsmID('R', args.relation, args.object_class) 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 + assert args.place_id is not None + place = napi.PlaceID(args.place_id) + + api = napi.NominatimAPI(args.project_dir) + + details = napi.LookupDetails(address_details=args.addressdetails, + linked_places=args.linkedplaces, + parented_places=args.hierarchy, + keywords=args.keywords) + if args.polygon_geojson: + details.geometry_output = napi.GeometryFormat.GEOJSON + + result = api.details(place, details) + + if result: + output = api_output.format_result( + result, + 'json', + {'locales': args.get_locales(api.config.DEFAULT_LANGUAGE), + 'group_hierarchy': args.group_hierarchy}) + # reformat the result, so it is pretty-printed + json.dump(json.loads(output), sys.stdout, indent=4, ensure_ascii=False) + sys.stdout.write('\n') + + return 0 - return _run_api('details', args, params) + LOG.error("Object not found in database.") + return 42 class APIStatus: @@ -277,13 +321,13 @@ class APIStatus: """ def add_args(self, parser: argparse.ArgumentParser) -> None: - formats = formatting.create(StatusResult).list_formats() + formats = api_output.list_formats(napi.StatusResult) group = parser.add_argument_group('API parameters') group.add_argument('--format', default=formats[0], choices=formats, help='Format of result') def run(self, args: NominatimArgs) -> int: - status = NominatimAPI(args.project_dir).status() - print(formatting.create(StatusResult).format(status, args.format)) + status = napi.NominatimAPI(args.project_dir).status() + print(api_output.format_result(status, args.format, {})) return 0