nominatim/tokenizer/factory.py

   1 """
   2 Functions for creating a tokenizer or initialising the right one for an
   3 existing database.
   4
   5 A tokenizer is something that is bound to the lifetime of a database. It
   6 can be choosen and configured before the intial import but then needs to
   7 be used consistently when querying and updating the database.
   8
   9 This module provides the functions to create and configure a new tokenizer
  10 as well as instanciating the appropriate tokenizer for updating an existing
  11 database.
  12
  13 A tokenizer usually also includes PHP code for querying. The appropriate PHP
  14 normalizer module is installed, when the tokenizer is created.
  15 """
  16 import logging
  17 import importlib
  18
  19 from ..errors import UsageError
  20 from ..db import properties
  21 from ..db.connection import connect
  22
  23 LOG = logging.getLogger()
  24
  25 def _import_tokenizer(name):
  26     """ Load the tokenizer.py module from project directory.
  27     """
  28     try:
  29         return importlib.import_module('nominatim.tokenizer.' + name + '_tokenizer')
  30     except ModuleNotFoundError as exp:
  31         LOG.fatal("No tokenizer named '%s' available. "
  32                   "Check the setting of NOMINATIM_TOKENIZER.", name)
  33         raise UsageError('Tokenizer not found') from exp
  34
  35
  36 def create_tokenizer(config, init_db=True, module_name=None):
  37     """ Create a new tokenizer as defined by the given configuration.
  38
  39         The tokenizer data and code is copied into the 'tokenizer' directory
  40         of the project directory and the tokenizer loaded from its new location.
  41     """
  42     if module_name is None:
  43         module_name = config.TOKENIZER
  44
  45     # Create the directory for the tokenizer data
  46     basedir = config.project_dir / 'tokenizer'
  47     if not basedir.exists():
  48         basedir.mkdir()
  49     elif not basedir.is_dir():
  50         LOG.fatal("Tokenizer directory '%s' cannot be created.", basedir)
  51         raise UsageError("Tokenizer setup failed.")
  52
  53     # Import and initialize the tokenizer.
  54     tokenizer_module = _import_tokenizer(module_name)
  55
  56     tokenizer = tokenizer_module.create(config.get_libpq_dsn(), basedir)
  57     tokenizer.init_new_db(config, init_db=init_db)
  58
  59     with connect(config.get_libpq_dsn()) as conn:
  60         properties.set_property(conn, 'tokenizer', module_name)
  61
  62     return tokenizer
  63
  64
  65 def get_tokenizer_for_db(config):
  66     """ Instantiate a tokenizer for an existing database.
  67
  68         The function looks up the appropriate tokenizer in the database
  69         and initialises it.
  70     """
  71     basedir = config.project_dir / 'tokenizer'
  72     if not basedir.is_dir():
  73         LOG.fatal("Cannot find tokenizer data in '%s'.", basedir)
  74         raise UsageError('Cannot initialize tokenizer.')
  75
  76     with connect(config.get_libpq_dsn()) as conn:
  77         name = properties.get_property(conn, 'tokenizer')
  78
  79     if name is None:
  80         LOG.fatal("Tokenizer was not set up properly. Database property missing.")
  81         raise UsageError('Cannot initialize tokenizer.')
  82
  83     tokenizer_module = _import_tokenizer(name)
  84
  85     tokenizer = tokenizer_module.create(config.get_libpq_dsn(), basedir)
  86     tokenizer.init_from_project()
  87
  88     return tokenizer