Merge remote-tracking branch 'upstream/master'

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

diff --git a/nominatim/clicmd/special_phrases.py b/nominatim/clicmd/special_phrases.py
index b7e0f5dc6ce825318ef0843669e56eb472312449..626c0053cb4f7793328595fed44c928459e1e926 100644 (file)
--- a/nominatim/clicmd/special_phrases.py
+++ b/nominatim/clicmd/special_phrases.py
@@ -1,29 +1,76 @@
 """
 """

-    Implementation of the 'import-special-phrases' command.
+    Implementation of the 'special-phrases' command.

 """
 import logging
 """
 import logging

-from nominatim.tools.special_phrases import import_from_wiki
+from pathlib import Path
+from nominatim.errors import UsageError

 from nominatim.db.connection import connect
 from nominatim.db.connection import connect

+from nominatim.tools.special_phrases.sp_importer import SPImporter
+from nominatim.tools.special_phrases.sp_wiki_loader import SPWikiLoader
+from nominatim.tools.special_phrases.sp_csv_loader import SPCsvLoader

 
 LOG = logging.getLogger()
 
 # Do not repeat documentation of subcommand classes.
 # pylint: disable=C0111
 
 LOG = logging.getLogger()
 
 # Do not repeat documentation of subcommand classes.
 # pylint: disable=C0111

+# Using non-top-level imports to avoid eventually unused imports.
+# pylint: disable=E0012,C0415

 
 class ImportSpecialPhrases:
     """\
     Import special phrases.
 
 class ImportSpecialPhrases:
     """\
     Import special phrases.

+
+    Special phrases are search terms that narrow down the type of object
+    that should be searched. For example, you might want to search for
+    'Hotels in Barcelona'. The OSM wiki has a selection of special phrases
+    in many languages, which can be imported with this command.
+
+    You can also provide your own phrases in a CSV file. The file needs to have
+    the following five columns:
+     * phrase - the term expected for searching
+     * class - the OSM tag key of the object type
+     * type - the OSM tag value of the object type
+     * operator - the kind of search to be done (one of: in, near, name, -)
+     * plural - whether the term is a plural or not (Y/N)
+
+    An example file can be found in the Nominatim sources at
+    'test/testdb/full_en_phrases_test.csv'.

     """
     @staticmethod
     def add_args(parser):
         group = parser.add_argument_group('Input arguments')
     """
     @staticmethod
     def add_args(parser):
         group = parser.add_argument_group('Input arguments')

-        group.add_argument('--from-wiki', action='store_true',
-                           help='Import special phrases from the OSM wiki to the database.')
+        group.add_argument('--import-from-wiki', action='store_true',
+                           help='Import special phrases from the OSM wiki to the database')
+        group.add_argument('--import-from-csv', metavar='FILE',
+                           help='Import special phrases from a CSV file')
+        group.add_argument('--no-replace', action='store_true',
+                           help='Keep the old phrases and only add the new ones')

 
     @staticmethod
     def run(args):
 
     @staticmethod
     def run(args):

-        if args.from_wiki:
-            LOG.warning('Special phrases importation starting')
-            with connect(args.config.get_libpq_dsn()) as db_connection:
-                import_from_wiki(args.config, db_connection)
+        if args.import_from_wiki:
+            ImportSpecialPhrases.start_import(args, SPWikiLoader(args.config))
+
+        if args.import_from_csv:
+            if not Path(args.import_from_csv).is_file():
+                LOG.fatal("CSV file '%s' does not exist.", args.import_from_csv)
+                raise UsageError('Cannot access file.')
+
+            ImportSpecialPhrases.start_import(args, SPCsvLoader(args.import_from_csv))
+

         return 0
         return 0

+
+    @staticmethod
+    def start_import(args, loader):
+        """
+            Create the SPImporter object containing the right
+            sp loader and then start the import of special phrases.
+        """
+        from ..tokenizer import factory as tokenizer_factory
+
+        tokenizer = tokenizer_factory.get_tokenizer_for_db(args.config)
+        should_replace = not args.no_replace
+        with connect(args.config.get_libpq_dsn()) as db_connection:
+            SPImporter(
+                args.config, args.phplib_dir, db_connection, loader
+            ).import_phrases(tokenizer, should_replace)