add HTML-formatted debug output to lookup

[nominatim.git] / nominatim / clicmd / api.py

diff --git a/nominatim/clicmd/api.py b/nominatim/clicmd/api.py
index ab7d16582cb5b8f8ba93800080166c4b7ecdb192..523013a66ba512fa534973d6bb56c25aa26f56b6 100644 (file)
--- a/nominatim/clicmd/api.py
+++ b/nominatim/clicmd/api.py
@@ -2,15 +2,22 @@
 #
 # This file is part of Nominatim. (https://nominatim.org)
 #
 #
 # 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.
 """
 # 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
 import logging

+import json
+import sys

 
 from nominatim.tools.exec_utils import run_api_script
 from nominatim.errors import UsageError
 
 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
 
 # Do not repeat documentation of subcommand classes.
 # pylint: disable=C0111


@@ -33,16 +40,7 @@ EXTRADATA_PARAMS = (
     ('namedetails', 'Include a list of alternative names')
 )
 
     ('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):
+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'],
     group = parser.add_argument_group('Output arguments')
     group.add_argument('--format', default='jsonv2',
                        choices=['xml', 'json', 'jsonv2', 'geojson', 'geocodejson'],


@@ -60,7 +58,7 @@ def _add_api_output_arguments(parser):
                              "Parameter is difference tolerance in degrees."))
 
 
                              "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():
     script_file = args.project_dir / 'website' / (endpoint + '.php')
 
     if not script_file.exists():


@@ -82,8 +80,7 @@ class APISearch:
     https://nominatim.org/release-docs/latest/api/Search/
     """
 
     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('Query arguments')
         group.add_argument('--query',
                            help='Free-form query string')


@@ -109,8 +106,8 @@ class APISearch:
                            help='Do not remove duplicates from the result list')
 
 
                            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 args.query:
             params = dict(q=args.query)
         else:


@@ -145,8 +142,7 @@ class APIReverse:
     https://nominatim.org/release-docs/latest/api/Reverse/
     """
 
     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)')
         group = parser.add_argument_group('Query arguments')
         group.add_argument('--lat', type=float, required=True,
                            help='Latitude of coordinate to look up (in WGS84)')


@@ -158,8 +154,7 @@ class APIReverse:
         _add_api_output_arguments(parser)
 
 
         _add_api_output_arguments(parser)
 
 

-    @staticmethod
-    def run(args):
+    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
         params = dict(lat=args.lat, lon=args.lon, format=args.format)
         if args.zoom is not None:
             params['zoom'] = args.zoom


@@ -187,8 +182,7 @@ class APILookup:
     https://nominatim.org/release-docs/latest/api/Lookup/
     """
 
     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',
         group = parser.add_argument_group('Query arguments')
         group.add_argument('--id', metavar='OSMID',
                            action='append', required=True, dest='ids',


@@ -197,9 +191,8 @@ class APILookup:
         _add_api_output_arguments(parser)
 
 
         _add_api_output_arguments(parser)
 
 

-    @staticmethod
-    def run(args):
-        params = dict(osm_ids=','.join(args.ids), format=args.format)
+    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):
 
         for param, _ in EXTRADATA_PARAMS:
             if getattr(args, param):


@@ -224,8 +217,7 @@ class APIDetails:
     https://nominatim.org/release-docs/latest/api/Details/
     """
 
     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,
         group = parser.add_argument_group('Query arguments')
         objs = group.add_mutually_exclusive_group(required=True)
         objs.add_argument('--node', '-n', type=int,


@@ -241,33 +233,70 @@ class APIDetails:
                                  "of the same object."))
 
         group = parser.add_argument_group('Output arguments')
                                  "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')
 
         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:
+        place: napi.PlaceRef

         if args.node:
         if args.node:

-            params = dict(osmtype='N', osmid=args.node)
+            place = napi.OsmID('N', args.node, args.object_class)

         elif args.way:
         elif args.way:

-            params = dict(osmtype='W', osmid=args.node)
+            place = napi.OsmID('W', args.way, args.object_class)

         elif args.relation:
         elif args.relation:

-            params = dict(osmtype='R', osmid=args.node)
+            place = napi.OsmID('R', args.relation, args.object_class)

         else:
         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:
         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 0

 
 

-        return _run_api('details', args, params)
+        LOG.error("Object not found in database.")
+        return 42

 
 
 class APIStatus:
 
 
 class APIStatus:

-    """\
+    """

     Execute API status query.
 
     This command works exactly the same as if calling the /status endpoint on
     Execute API status query.
 
     This command works exactly the same as if calling the /status endpoint on


@@ -276,12 +305,14 @@ class APIStatus:
     https://nominatim.org/release-docs/latest/api/Status/
     """
 
     https://nominatim.org/release-docs/latest/api/Status/
     """
 

-    @staticmethod
-    def add_args(parser):
+    def add_args(self, parser: argparse.ArgumentParser) -> None:
+        formats = api_output.list_formats(napi.StatusResult)

         group = parser.add_argument_group('API parameters')
         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')
 
                            help='Format of result')
 

-    @staticmethod
-    def run(args):
-        return _run_api('status', args, dict(format=args.format))
+
+    def run(self, args: NominatimArgs) -> int:
+        status = napi.NominatimAPI(args.project_dir).status()
+        print(api_output.format_result(status, args.format, {}))
+        return 0