X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/8e1d4818aca13a7a0a992af7ba8c5b9ff47f65ed..3bcd32ca2006cb2184f290e18f4e054f8aca8bf4:/nominatim/config.py?ds=sidebyside diff --git a/nominatim/config.py b/nominatim/config.py index 64614bf1..b3934b49 100644 --- a/nominatim/config.py +++ b/nominatim/config.py @@ -1,9 +1,16 @@ +# SPDX-License-Identifier: GPL-2.0-only +# +# This file is part of Nominatim. (https://nominatim.org) +# +# Copyright (C) 2022 by the Nominatim developer community. +# For a full list of authors see the git log. """ Nominatim configuration accessor. """ import logging import os from pathlib import Path +import json import yaml from dotenv import dotenv_values @@ -11,6 +18,27 @@ from dotenv import dotenv_values from nominatim.errors import UsageError LOG = logging.getLogger() +CONFIG_CACHE = {} + +def flatten_config_list(content, section=''): + """ Flatten YAML configuration lists that contain include sections + which are lists themselves. + """ + if not content: + return [] + + if not isinstance(content, list): + raise UsageError(f"List expected in section '{section}'.") + + output = [] + for ele in content: + if isinstance(ele, list): + output.extend(flatten_config_list(ele, section)) + else: + output.append(ele) + + return output + class Configuration: """ Load and manage the project configuration. @@ -34,12 +62,6 @@ class Configuration: if project_dir is not None and (project_dir / '.env').is_file(): self._config.update(dotenv_values(str((project_dir / '.env').resolve()))) - # Add defaults for variables that are left empty to set the default. - # They may still be overwritten by environment variables. - if not self._config['NOMINATIM_ADDRESS_LEVEL_CONFIG']: - self._config['NOMINATIM_ADDRESS_LEVEL_CONFIG'] = \ - str(config_dir / 'address-levels.json') - class _LibDirs: pass @@ -64,19 +86,47 @@ class Configuration: Values of '1', 'yes' and 'true' are accepted as truthy values, everything else is interpreted as false. """ - return self.__getattr__(name).lower() in ('1', 'yes', 'true') + return getattr(self, name).lower() in ('1', 'yes', 'true') def get_int(self, name): """ Return the given configuration parameter as an int. """ try: - return int(self.__getattr__(name)) + return int(getattr(self, name)) except ValueError as exp: LOG.fatal("Invalid setting NOMINATIM_%s. Needs to be a number.", name) raise UsageError("Configuration error.") from exp + def get_str_list(self, name): + """ 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. + """ + raw = getattr(self, name) + + return [v.strip() for v in raw.split(',')] if raw else None + + + def get_path(self, name): + """ 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, a falsy value is returned. + """ + value = getattr(self, name) + if value: + value = Path(value) + + if not value.is_absolute(): + value = self.project_dir / value + + value = value.resolve() + + return value + def get_libpq_dsn(self): """ Get configured database DSN converted into the key/value format understood by libpq and psycopg. @@ -102,12 +152,12 @@ class Configuration: name of the standard styles automatically into a file in the config style. """ - style = self.__getattr__('IMPORT_STYLE') + style = getattr(self, 'IMPORT_STYLE') if style in ('admin', 'street', 'address', 'full', 'extratags'): - return self.config_dir / 'import-{}.style'.format(style) + return self.config_dir / f'import-{style}.style' - return Path(style) + return self.find_config_file('', 'IMPORT_STYLE') def get_os_env(self): @@ -140,21 +190,31 @@ class Configuration: is loaded using this function and added at the position in the configuration tree. """ - assert Path(filename).suffix == '.yaml' + configfile = self.find_config_file(filename, config) - configfile = self._find_config_file(filename, config) + if str(configfile) in CONFIG_CACHE: + return CONFIG_CACHE[str(configfile)] + + if configfile.suffix in ('.yaml', '.yml'): + result = self._load_from_yaml(configfile) + elif configfile.suffix == '.json': + with configfile.open('r', encoding='utf-8') as cfg: + result = json.load(cfg) + else: + raise UsageError(f"Config file '{configfile}' has unknown format.") - return self._load_from_yaml(configfile) + CONFIG_CACHE[str(configfile)] = result + return result - def _find_config_file(self, filename, config=None): + def find_config_file(self, filename, config=None): """ Resolve the location of a configuration file given a filename and an optional configuration option with the file name. Raises a UsageError when the file cannot be found or is not a regular file. """ if config is not None: - cfg_filename = self.__getattr__(config) + cfg_filename = getattr(self, config) if cfg_filename: cfg_filename = Path(cfg_filename) @@ -200,7 +260,7 @@ class Configuration: if Path(fname).is_absolute(): configfile = Path(fname) else: - configfile = self._find_config_file(loader.construct_scalar(node)) + configfile = self.find_config_file(loader.construct_scalar(node)) if configfile.suffix != '.yaml': LOG.fatal("Format error while reading '%s': only YAML format supported.",