X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/f22fa992f7975757d84ae17e42ff98c15f7a572b..c32f686c62e8789494f68ec7ddb589c6f86bac26:/nominatim/config.py?ds=inline diff --git a/nominatim/config.py b/nominatim/config.py index adc022e2..e0f19b04 100644 --- a/nominatim/config.py +++ b/nominatim/config.py @@ -8,8 +8,10 @@ Nominatim configuration accessor. """ from typing import Dict, Any, List, Mapping, Optional +import importlib.util import logging import os +import sys from pathlib import Path import json import yaml @@ -18,6 +20,7 @@ from dotenv import dotenv_values from nominatim.typing import StrPath from nominatim.errors import UsageError +import nominatim.paths LOG = logging.getLogger() CONFIG_CACHE : Dict[str, Any] = {} @@ -56,26 +59,32 @@ class Configuration: avoid conflicts with other environment variables. """ - 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: - pass + module: Path + osm2pgsql: 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] = {} def set_libdirs(self, **kwargs: StrPath) -> None: """ 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: @@ -129,6 +138,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() @@ -162,16 +172,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 @@ -181,7 +191,7 @@ class Configuration: config: Optional[str] = None) -> Any: """ Load additional configuration from a file. `filename` is the name of the configuration file. The file is first searched in the - project directory and then in the global settings dirctory. + project directory and then in the global settings directory. If `config` is set, then the name of the configuration file can be additionally given through a .env configuration option. When @@ -215,6 +225,49 @@ class Configuration: return result + 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: + + * A name without any '.' is assumed to be an internal module + and will be searched relative to `internal_path`. + * If the name ends in `.py`, module_name is assumed to be a + file name relative to the project directory. + * Any other name is assumed to be an absolute module name. + + In either of the variants the module name must start with a letter. + """ + if not module_name or not module_name[0].isidentifier(): + raise UsageError(f'Invalid module name {module_name}') + + if '.' not in module_name: + module_name = module_name.replace('-', '_') + full_module = f'{internal_path}.{module_name}' + return sys.modules.get(full_module) or importlib.import_module(full_module) + + if module_name.endswith('.py'): + if self.project_dir is None or not (self.project_dir / module_name).exists(): + raise UsageError(f"Cannot find module '{module_name}' in project directory.") + + if module_name in self._private_plugins: + return self._private_plugins[module_name] + + file_path = str(self.project_dir / module_name) + spec = importlib.util.spec_from_file_location(module_name, file_path) + if spec: + module = importlib.util.module_from_spec(spec) + # Do not add to global modules because there is no standard + # module name that Python can resolve. + self._private_plugins[module_name] = module + assert spec.loader is not None + spec.loader.exec_module(module) + + return module + + return sys.modules.get(module_name) or importlib.import_module(module_name) + + def find_config_file(self, filename: StrPath, config: Optional[str] = None) -> Path: """ Resolve the location of a configuration file given a filename and @@ -262,7 +315,7 @@ class Configuration: """ Handler for the '!include' operator in YAML files. When the filename is relative, then the file is first searched in the - project directory and then in the global settings dirctory. + project directory and then in the global settings directory. """ fname = loader.construct_scalar(node)