"""passbook lib config loader""" import os from collections.abc import Mapping from contextlib import contextmanager from glob import glob from logging import getLogger from typing import Any import yaml from django.conf import ImproperlyConfigured from django.utils.autoreload import autoreload_started SEARCH_PATHS = [ 'passbook/lib/default.yml', '/etc/passbook/config.yml', '.', ] + glob('/etc/passbook/config.d/*.yml', recursive=True) LOGGER = getLogger(__name__) ENVIRONMENT = os.getenv('PASSBOOK_ENV', 'local') class ConfigLoader: """Search through SEARCH_PATHS and load configuration""" loaded_file = [] __config = {} __context_default = None __sub_dicts = [] def __init__(self): super().__init__() base_dir = os.path.realpath(os.path.join( os.path.dirname(__file__), '../..')) for path in SEARCH_PATHS: # Check if path is relative, and if so join with base_dir if not os.path.isabs(path): path = os.path.join(base_dir, path) if os.path.isfile(path) and os.path.exists(path): # Path is an existing file, so we just read it and update our config with it self.update_from_file(path) elif os.path.isdir(path) and os.path.exists(path): # Path is an existing dir, so we try to read the env config from it env_paths = [os.path.join(path, ENVIRONMENT+'.yml'), os.path.join(path, ENVIRONMENT+'.env.yml')] for env_file in env_paths: if os.path.isfile(env_file) and os.path.exists(env_file): # Update config with env file self.update_from_file(env_file) self.handle_secret_key() def handle_secret_key(self): """Handle `secret_key_file`""" if 'secret_key_file' in self.__config: secret_key_file = self.__config.get('secret_key_file') if os.path.isfile(secret_key_file) and os.path.exists(secret_key_file): with open(secret_key_file) as file: self.__config['secret_key'] = file.read().replace('\n', '') def update(self, root, updatee): """Recursively update dictionary""" for key, value in updatee.items(): if isinstance(value, Mapping): root[key] = self.update(root.get(key, {}), value) else: root[key] = value return root def update_from_file(self, path: str): """Update config from file contents""" try: with open(path) as file: try: self.update(self.__config, yaml.safe_load(file)) LOGGER.debug("Loaded %s", path) self.loaded_file.append(path) except yaml.YAMLError as exc: raise ImproperlyConfigured from exc except PermissionError as exc: LOGGER.warning('Permission denied while reading %s', path) def update_from_dict(self, update: dict): """Update config from dict""" self.__config.update(update) @contextmanager def default(self, value: Any): """Contextmanage that sets default""" self.__context_default = value yield self.__context_default = None @contextmanager # pylint: disable=invalid-name def cd(self, sub: str): """Contextmanager that descends into sub-dict. Can be chained.""" self.__sub_dicts.append(sub) yield self.__sub_dicts.pop() def get(self, key: str, default=None) -> Any: """Get value from loaded config file""" if default is None: default = self.__context_default config_copy = self.raw for sub in self.__sub_dicts: config_copy = config_copy.get(sub, None) return config_copy.get(key, default) @property def raw(self) -> dict: """Get raw config dictionary""" return self.__config # pylint: disable=invalid-name def y(self, path: str, default=None, sep='.') -> Any: """Access attribute by using yaml path""" if default is None: default = self.__context_default # Walk sub_dicts before parsing path root = self.raw for sub in self.__sub_dicts: root = root.get(sub, None) # Walk each component of the path for comp in path.split(sep): if comp in root: root = root.get(comp) else: return default return root CONFIG = ConfigLoader() # pylint: disable=unused-argument def signal_handler(sender, **kwargs): """Add all loaded config files to autoreload watcher""" for path in CONFIG.loaded_file: sender.watch_file(path) autoreload_started.connect(signal_handler)