X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/bc7f6209d83dcc161f093ce9907991facabb3491..556bb2386d5882e4e6aa8bdbcc2661f12d66b726:/nominatim/clicmd/api.py diff --git a/nominatim/clicmd/api.py b/nominatim/clicmd/api.py index b899afad..523013a6 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,10 +10,14 @@ 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 +import nominatim.api as napi +import nominatim.api.v1 as api_output # Do not repeat documentation of subcommand classes. # pylint: disable=C0111 @@ -36,15 +40,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', @@ -238,33 +233,70 @@ 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' + 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 + if args.lang: - params['accept-language'] = args.lang + locales = napi.Locales.from_accept_languages(args.lang) + elif api.config.DEFAULT_LANGUAGE: + locales = napi.Locales.from_accept_languages(api.config.DEFAULT_LANGUAGE) + else: + locales = napi.Locales() + + result = api.lookup(place, details) + + if result: + output = api_output.format_result( + result, + 'details-json', + {'locales': locales, + 'group_hierarchy': args.group_hierarchy}) + # reformat the result, so it is pretty-printed + json.dump(json.loads(output), sys.stdout, indent=4) + sys.stdout.write('\n') - return _run_api('details', args, params) + return 0 + + LOG.error("Object not found in database.") + return 42 class APIStatus: - """\ + """ Execute API status query. This command works exactly the same as if calling the /status endpoint on @@ -274,10 +306,13 @@ class APIStatus: """ def add_args(self, parser: argparse.ArgumentParser) -> None: + formats = api_output.list_formats(napi.StatusResult) 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') def run(self, args: NominatimArgs) -> int: - return _run_api('status', args, dict(format=args.format)) + status = napi.NominatimAPI(args.project_dir).status() + print(api_output.format_result(status, args.format, {})) + return 0