nominatim/config.py

   1 """
   2 Nominatim configuration accessor.
   3 """
   4 import os
   5
   6 from dotenv import dotenv_values
   7
   8 class Configuration:
   9     """ Load and manage the project configuration.
  10
  11         Nominatim uses dotenv to configure the software. Configuration options
  12         are resolved in the following order:
  13
  14          * from the OS environment
  15          * from the .env file in the project directory of the installation
  16          * from the default installation in the configuration directory
  17
  18         All Nominatim configuration options are prefixed with 'NOMINATIM_' to
  19         avoid conflicts with other environment variables.
  20     """
  21
  22     def __init__(self, project_dir, config_dir):
  23         self._config = dotenv_values(str((config_dir / 'env.defaults').resolve()))
  24         self._config.update(dotenv_values(str((project_dir / '.env').resolve())))
  25
  26     def __getattr__(self, name):
  27         name = 'NOMINATIM_' + name
  28
  29         return os.environ.get(name) or self._config[name]
  30
  31     def get_os_env(self):
  32         """ Return a copy of the OS environment with the Nominatim configuration
  33             merged in.
  34         """
  35         env = dict(os.environ)
  36         env.update(self._config)
  37
  38         return env