X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/7b7203c14973fb3395bd4d745e580c2bc9be0d6c..a7a920a9a5b55bf4290b184f05898a8589c95b40:/nominatim/config.py diff --git a/nominatim/config.py b/nominatim/config.py index 7f57a3be..3344a425 100644 --- a/nominatim/config.py +++ b/nominatim/config.py @@ -17,9 +17,11 @@ import json import yaml from dotenv import dotenv_values +from psycopg2.extensions import parse_dsn from nominatim.typing import StrPath from nominatim.errors import UsageError +import nominatim.paths LOG = logging.getLogger() CONFIG_CACHE : Dict[str, Any] = {} @@ -45,34 +47,33 @@ def flatten_config_list(content: Any, section: str = '') -> List[Any]: class Configuration: - """ Load and manage the project configuration. - - Nominatim uses dotenv to configure the software. Configuration options - are resolved in the following order: - - * from the OS environment (or the dirctionary given in `environ` - * from the .env file in the project directory of the installation - * from the default installation in the configuration directory + """ This class wraps access to the configuration settings + for the Nominatim instance in use. All Nominatim configuration options are prefixed with 'NOMINATIM_' to - avoid conflicts with other environment variables. + avoid conflicts with other environment variables. All settings can + be accessed as properties of the class under the same name as the + setting but with the `NOMINATIM_` prefix removed. In addition, there + are accessor functions that convert the setting values to types + other than string. """ - def __init__(self, project_dir: Path, config_dir: Path, + def __init__(self, project_dir: Optional[Path], environ: Optional[Mapping[str, str]] = None) -> None: self.environ = environ or os.environ self.project_dir = project_dir - self.config_dir = config_dir - self._config = dotenv_values(str((config_dir / 'env.defaults').resolve())) - if project_dir is not None and (project_dir / '.env').is_file(): - self._config.update(dotenv_values(str((project_dir / '.env').resolve()))) + self.config_dir = nominatim.paths.CONFIG_DIR + self._config = dotenv_values(str(self.config_dir / 'env.defaults')) + if self.project_dir is not None and (self.project_dir / '.env').is_file(): + self.project_dir = self.project_dir.resolve() + self._config.update(dotenv_values(str(self.project_dir / '.env'))) class _LibDirs: module: Path osm2pgsql: Path - php: Path - sql: Path - data: Path + php = nominatim.paths.PHPLIB_DIR + sql = nominatim.paths.SQLLIB_DIR + data = nominatim.paths.DATA_DIR self.lib_dir = _LibDirs() self._private_plugins: Dict[str, object] = {} @@ -82,7 +83,7 @@ class Configuration: """ Set paths to library functions and data. """ for key, value in kwargs.items(): - setattr(self.lib_dir, key, Path(value).resolve()) + setattr(self.lib_dir, key, Path(value)) def __getattr__(self, name: str) -> str: @@ -96,14 +97,29 @@ class Configuration: def get_bool(self, name: str) -> bool: """ Return the given configuration parameter as a boolean. - Values of '1', 'yes' and 'true' are accepted as truthy values, - everything else is interpreted as false. + + Parameters: + name: Name of the configuration parameter with the NOMINATIM_ + prefix removed. + + Returns: + `True` for values of '1', 'yes' and 'true', `False` otherwise. """ return getattr(self, name).lower() in ('1', 'yes', 'true') def get_int(self, name: str) -> int: """ Return the given configuration parameter as an int. + + Parameters: + name: Name of the configuration parameter with the NOMINATIM_ + prefix removed. + + Returns: + The configuration value converted to int. + + Raises: + ValueError: when the value is not a number. """ try: return int(getattr(self, name)) @@ -115,8 +131,17 @@ class Configuration: def get_str_list(self, name: str) -> Optional[List[str]]: """ Return the given configuration parameter as a list of strings. The values are assumed to be given as a comma-sparated list and - will be stripped before returning them. On empty values None - is returned. + will be stripped before returning them. + + Parameters: + name: Name of the configuration parameter with the NOMINATIM_ + prefix removed. + + Returns: + (List[str]): The comma-split parameter as a list. The + elements are stripped of leading and final spaces before + being returned. + (None): The configuration parameter was unset or empty. """ raw = getattr(self, name) @@ -125,9 +150,16 @@ class Configuration: def get_path(self, name: str) -> Optional[Path]: """ Return the given configuration parameter as a Path. - If a relative path is configured, then the function converts this - into an absolute path with the project directory as root path. - If the configuration is unset, None is returned. + + Parameters: + name: Name of the configuration parameter with the NOMINATIM_ + prefix removed. + + Returns: + (Path): A Path object of the parameter value. + If a relative path is configured, then the function converts this + into an absolute path with the project directory as root path. + (None): The configuration parameter was unset or empty. """ value = getattr(self, name) if not value: @@ -136,6 +168,7 @@ class Configuration: cfgpath = Path(value) if not cfgpath.is_absolute(): + assert self.project_dir is not None cfgpath = self.project_dir / cfgpath return cfgpath.resolve() @@ -161,6 +194,18 @@ class Configuration: return dsn + def get_database_params(self) -> Mapping[str, str]: + """ Get the configured parameters for the database connection + as a mapping. + """ + dsn = self.DATABASE_DSN + + if dsn.startswith('pgsql:'): + return dict((p.split('=', 1) for p in dsn[6:].split(';'))) + + return parse_dsn(dsn) + + def get_import_style_file(self) -> Path: """ Return the import style file as a path object. Translates the name of the standard styles automatically into a file in the @@ -169,16 +214,16 @@ class Configuration: style = getattr(self, 'IMPORT_STYLE') if style in ('admin', 'street', 'address', 'full', 'extratags'): - return self.config_dir / f'import-{style}.style' + return self.config_dir / f'import-{style}.lua' return self.find_config_file('', 'IMPORT_STYLE') - def get_os_env(self) -> Dict[str, Optional[str]]: + def get_os_env(self) -> Dict[str, str]: """ Return a copy of the OS environment with the Nominatim configuration merged in. """ - env = dict(self._config) + env = {k: v for k, v in self._config.items() if v is not None} env.update(self.environ) return env @@ -222,7 +267,7 @@ class Configuration: return result - def load_plugin_module(self, module_name: str, internal_path: str) -> object: + def load_plugin_module(self, module_name: str, internal_path: str) -> Any: """ Load a Python module as a plugin. The module_name may have three variants: