Merge remote-tracking branch 'upstream/master'

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

diff --git a/nominatim/clicmd/setup.py b/nominatim/clicmd/setup.py
index 7b5f379739e5f7269975970d05ef182cee403b4b..6ffa7afb8babb91c58d7f40c0af16cfbb32f110d 100644 (file)
--- a/nominatim/clicmd/setup.py
+++ b/nominatim/clicmd/setup.py
@@ -7,14 +7,20 @@
 """
 Implementation of the 'import' subcommand.
 """
 """
 Implementation of the 'import' subcommand.
 """

+from typing import Optional
+import argparse

 import logging
 from pathlib import Path
 
 import psutil
 
 import logging
 from pathlib import Path
 
 import psutil
 

-from nominatim.db.connection import connect
+from nominatim.config import Configuration
+from nominatim.db.connection import connect, Connection

 from nominatim.db import status, properties
 from nominatim.db import status, properties

+from nominatim.tokenizer.base import AbstractTokenizer

 from nominatim.version import version_str
 from nominatim.version import version_str

+from nominatim.clicmd.args import NominatimArgs
+from nominatim.errors import UsageError

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


@@ -32,45 +38,46 @@ class SetupAll:
     needs superuser rights on the database.
     """
 
     needs superuser rights on the database.
     """
 

-    @staticmethod
-    def add_args(parser):
+    def add_args(self, parser: argparse.ArgumentParser) -> None:

         group_name = parser.add_argument_group('Required arguments')
         group_name = parser.add_argument_group('Required arguments')

-        group = group_name.add_mutually_exclusive_group(required=True)
-        group.add_argument('--osm-file', metavar='FILE', action='append',
+        group1 = group_name.add_mutually_exclusive_group(required=True)
+        group1.add_argument('--osm-file', metavar='FILE', action='append',

                            help='OSM file to be imported'
                                 ' (repeat for importing multiple files)')
                            help='OSM file to be imported'
                                 ' (repeat for importing multiple files)')

-        group.add_argument('--continue', dest='continue_at',
+        group1.add_argument('--continue', dest='continue_at',

                            choices=['load-data', 'indexing', 'db-postprocess'],
                            help='Continue an import that was interrupted')
                            choices=['load-data', 'indexing', 'db-postprocess'],
                            help='Continue an import that was interrupted')

-        group = parser.add_argument_group('Optional arguments')
-        group.add_argument('--osm2pgsql-cache', metavar='SIZE', type=int,
+        group2 = parser.add_argument_group('Optional arguments')
+        group2.add_argument('--osm2pgsql-cache', metavar='SIZE', type=int,

                            help='Size of cache to be used by osm2pgsql (in MB)')
                            help='Size of cache to be used by osm2pgsql (in MB)')

-        group.add_argument('--reverse-only', action='store_true',
+        group2.add_argument('--reverse-only', action='store_true',

                            help='Do not create tables and indexes for searching')
                            help='Do not create tables and indexes for searching')

-        group.add_argument('--no-partitions', action='store_true',
+        group2.add_argument('--no-partitions', action='store_true',

                            help=("Do not partition search indices "
                                  "(speeds up import of single country extracts)"))
                            help=("Do not partition search indices "
                                  "(speeds up import of single country extracts)"))

-        group.add_argument('--no-updates', action='store_true',
+        group2.add_argument('--no-updates', action='store_true',

                            help="Do not keep tables that are only needed for "
                                 "updating the database later")
                            help="Do not keep tables that are only needed for "
                                 "updating the database later")

-        group.add_argument('--offline', action='store_true',
+        group2.add_argument('--offline', action='store_true',

                            help="Do not attempt to load any additional data from the internet")
                            help="Do not attempt to load any additional data from the internet")

-        group = parser.add_argument_group('Expert options')
-        group.add_argument('--ignore-errors', action='store_true',
+        group3 = parser.add_argument_group('Expert options')
+        group3.add_argument('--ignore-errors', action='store_true',

                            help='Continue import even when errors in SQL are present')
                            help='Continue import even when errors in SQL are present')

-        group.add_argument('--index-noanalyse', action='store_true',
+        group3.add_argument('--index-noanalyse', action='store_true',

                            help='Do not perform analyse operations during index (expert only)')
 
 
                            help='Do not perform analyse operations during index (expert only)')
 
 

-    @staticmethod
-    def run(args):
-        from ..tools import database_import, refresh, postcodes, freeze, country_info
+    def run(self, args: NominatimArgs) -> int: # pylint: disable=too-many-statements
+        from ..data import country_info
+        from ..tools import database_import, refresh, postcodes, freeze

         from ..indexer.indexer import Indexer
 
         country_info.setup_country_config(args.config)
 
         if args.continue_at is None:
             files = args.get_osm_file_list()
         from ..indexer.indexer import Indexer
 
         country_info.setup_country_config(args.config)
 
         if args.continue_at is None:
             files = args.get_osm_file_list()

+            if not files:
+                raise UsageError("No input files (use --osm-file).")

 
             LOG.warning('Creating database')
             database_import.setup_database_skeleton(args.config.get_libpq_dsn(),
 
             LOG.warning('Creating database')
             database_import.setup_database_skeleton(args.config.get_libpq_dsn(),


@@ -87,7 +94,7 @@ class SetupAll:
                                             drop=args.no_updates,
                                             ignore_errors=args.ignore_errors)
 
                                             drop=args.no_updates,
                                             ignore_errors=args.ignore_errors)
 

-            SetupAll._setup_tables(args.config, args.reverse_only)
+            self._setup_tables(args.config, args.reverse_only)

 
             LOG.warning('Importing wikipedia importance data')
             data_path = Path(args.config.WIKIPEDIA_DATA_PATH or args.project_dir)
 
             LOG.warning('Importing wikipedia importance data')
             data_path = Path(args.config.WIKIPEDIA_DATA_PATH or args.project_dir)


@@ -106,7 +113,7 @@ class SetupAll:
                                       args.threads or psutil.cpu_count() or 1)
 
         LOG.warning("Setting up tokenizer")
                                       args.threads or psutil.cpu_count() or 1)
 
         LOG.warning("Setting up tokenizer")

-        tokenizer = SetupAll._get_tokenizer(args.continue_at, args.config)
+        tokenizer = self._get_tokenizer(args.continue_at, args.config)

 
         if args.continue_at is None or args.continue_at == 'load-data':
             LOG.warning('Calculate postcodes')
 
         if args.continue_at is None or args.continue_at == 'load-data':
             LOG.warning('Calculate postcodes')


@@ -116,7 +123,7 @@ class SetupAll:
         if args.continue_at is None or args.continue_at in ('load-data', 'indexing'):
             if args.continue_at is not None and args.continue_at != 'load-data':
                 with connect(args.config.get_libpq_dsn()) as conn:
         if args.continue_at is None or args.continue_at in ('load-data', 'indexing'):
             if args.continue_at is not None and args.continue_at != 'load-data':
                 with connect(args.config.get_libpq_dsn()) as conn:

-                    SetupAll._create_pending_index(conn, args.config.TABLESPACE_ADDRESS_INDEX)
+                    self._create_pending_index(conn, args.config.TABLESPACE_ADDRESS_INDEX)

             LOG.warning('Indexing places')
             indexer = Indexer(args.config.get_libpq_dsn(), tokenizer,
                               args.threads or psutil.cpu_count() or 1)
             LOG.warning('Indexing places')
             indexer = Indexer(args.config.get_libpq_dsn(), tokenizer,
                               args.threads or psutil.cpu_count() or 1)


@@ -128,7 +135,7 @@ class SetupAll:
                                                   drop=args.no_updates)
             LOG.warning('Create search index for default country names.')
             country_info.create_country_names(conn, tokenizer,
                                                   drop=args.no_updates)
             LOG.warning('Create search index for default country names.')
             country_info.create_country_names(conn, tokenizer,

-                                              args.config.LANGUAGES)
+                                              args.config.get_str_list('LANGUAGES'))

             if args.no_updates:
                 freeze.drop_update_tables(conn)
         tokenizer.finalize_import(args.config)
             if args.no_updates:
                 freeze.drop_update_tables(conn)
         tokenizer.finalize_import(args.config)


@@ -141,13 +148,12 @@ class SetupAll:
         with connect(args.config.get_libpq_dsn()) as conn:
             refresh.setup_website(webdir, args.config, conn)
 
         with connect(args.config.get_libpq_dsn()) as conn:
             refresh.setup_website(webdir, args.config, conn)
 

-        SetupAll._finalize_database(args.config.get_libpq_dsn(), args.offline)
+        self._finalize_database(args.config.get_libpq_dsn(), args.offline)

 
         return 0
 
 
 
         return 0
 
 

-    @staticmethod
-    def _setup_tables(config, reverse_only):
+    def _setup_tables(self, config: Configuration, reverse_only: bool) -> None:

         """ Set up the basic database layout: tables, indexes and functions.
         """
         from ..tools import database_import, refresh
         """ Set up the basic database layout: tables, indexes and functions.
         """
         from ..tools import database_import, refresh


@@ -168,8 +174,8 @@ class SetupAll:
             refresh.create_functions(conn, config, False, False)
 
 
             refresh.create_functions(conn, config, False, False)
 
 

-    @staticmethod
-    def _get_tokenizer(continue_at, config):
+    def _get_tokenizer(self, continue_at: Optional[str],
+                       config: Configuration) -> AbstractTokenizer:

         """ Set up a new tokenizer or load an already initialised one.
         """
         from ..tokenizer import factory as tokenizer_factory
         """ Set up a new tokenizer or load an already initialised one.
         """
         from ..tokenizer import factory as tokenizer_factory


@@ -181,8 +187,8 @@ class SetupAll:
         # just load the tokenizer
         return tokenizer_factory.get_tokenizer_for_db(config)
 
         # just load the tokenizer
         return tokenizer_factory.get_tokenizer_for_db(config)
 

-    @staticmethod
-    def _create_pending_index(conn, tablespace):
+
+    def _create_pending_index(self, conn: Connection, tablespace: str) -> None:

         """ Add a supporting index for finding places still to be indexed.
 
             This index is normally created at the end of the import process
         """ Add a supporting index for finding places still to be indexed.
 
             This index is normally created at the end of the import process


@@ -203,8 +209,7 @@ class SetupAll:
         conn.commit()
 
 
         conn.commit()
 
 

-    @staticmethod
-    def _finalize_database(dsn, offline):
+    def _finalize_database(self, dsn: str, offline: bool) -> None:

         """ Determine the database date and set the status accordingly.
         """
         with connect(dsn) as conn:
         """ Determine the database date and set the status accordingly.
         """
         with connect(dsn) as conn: