implement command line status call in Python

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

diff --git a/nominatim/clicmd/api.py b/nominatim/clicmd/api.py
index 70baa8ff4ad0910c368025a1c14c014129e5f319..9a4828b8ce1e02384d65a7badbf133570f511519 100644 (file)
--- a/nominatim/clicmd/api.py
+++ b/nominatim/clicmd/api.py
@@ -1,10 +1,22 @@
+# 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.
 """
 """
 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
 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
+from nominatim.apicmd.status import StatusResult
+import nominatim.result_formatter.v1 as formatting

 
 # Do not repeat documentation of subcommand classes.
 # pylint: disable=C0111
 
 # Do not repeat documentation of subcommand classes.
 # pylint: disable=C0111


@@ -36,7 +48,7 @@ DETAILS_SWITCHES = (
     ('polygon_geojson', 'Include geometry of result')
 )
 
     ('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'],


@@ -54,7 +66,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():


@@ -76,8 +88,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')


@@ -103,8 +114,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:


@@ -139,8 +150,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)')


@@ -152,8 +162,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


@@ -181,8 +190,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',


@@ -191,9 +199,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):


@@ -218,8 +225,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,


@@ -240,8 +246,8 @@ class APIDetails:
         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:

         if args.node:
             params = dict(osmtype='N', osmid=args.node)
         elif args.way:
         if args.node:
             params = dict(osmtype='N', osmid=args.node)
         elif args.way:


@@ -261,7 +267,7 @@ class APIDetails:
 
 
 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


@@ -270,12 +276,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 = formatting.create(StatusResult).list_formats()

         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 = NominatimAPI(args.project_dir).status()
+        print(formatting.create(StatusResult).format(status, args.format))
+        return 0