Source code for kedro.config.config

# Copyright 2020 QuantumBlack Visual Analytics Limited
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
# NONINFRINGEMENT. IN NO EVENT WILL THE LICENSOR OR OTHER CONTRIBUTORS
# BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
# The QuantumBlack Visual Analytics Limited ("QuantumBlack") name and logo
# (either separately or in combination, "QuantumBlack Trademarks") are
# trademarks of QuantumBlack. The License does not grant you any right or
# license to the QuantumBlack Trademarks. You may not use the QuantumBlack
# Trademarks or any confusingly similar mark as a trademark for your product,
# or use the QuantumBlack Trademarks in any other manner that might cause
# confusion in the marketplace, including but not limited to in advertising,
# on websites, or on software.
#
# See the License for the specific language governing permissions and
# limitations under the License.
"""This module provides ``kedro.config`` with the functionality to load one
or more configuration files from specified paths.
"""
import logging
from glob import iglob
from pathlib import Path
from typing import AbstractSet, Any, Dict, Iterable, List, Set, Union
from warnings import warn

SUPPORTED_EXTENSIONS = [
    ".yml",
    ".yaml",
    ".json",
    ".ini",
    ".pickle",
    ".properties",
    ".xml",
]


class MissingConfigException(Exception):
    """Raised when no configuration files can be found within a config path"""

    pass


[docs]class ConfigLoader: """Recursively scan the directories specified in ``conf_paths`` for configuration files with a ``yaml``, ``yml``, ``json``, ``ini``, ``pickle``, ``xml`` or ``properties`` extension, load them, and return them in the form of a config dictionary. When the same top-level key appears in any 2 config files located in the same ``conf_path`` (sub)directory, a ``ValueError`` is raised. When the same key appears in any 2 config files located in different ``conf_path`` directories, the last processed config path takes precedence and overrides this key. For example, if your ``conf_path`` looks like this: :: . `-- conf |-- README.md |-- base | |-- catalog.yml | |-- logging.yml | `-- experiment1 | `-- parameters.yml `-- local |-- catalog.yml |-- db.ini |-- experiment1 | |-- parameters.yml | `-- model_parameters.yml `-- experiment2 `-- parameters.yml You can access the different configurations as follows: :: >>> import logging.config >>> from kedro.config import ConfigLoader >>> >>> conf_paths = ['conf/base', 'conf/local'] >>> conf_loader = ConfigLoader(conf_paths) >>> >>> conf_logging = conf_loader.get('logging*') >>> logging.config.dictConfig(conf_logging) # set logging conf >>> >>> conf_catalog = conf_loader.get('catalog*', 'catalog*/**') >>> conf_params = conf_loader.get('**/parameters.yml') """
[docs] def __init__(self, conf_paths: Union[str, Iterable[str]]): """Instantiate a ConfigLoader. Args: conf_paths: Non-empty path or list of paths to configuration directories. Raises: ValueError: If ``conf_paths`` is empty. """ if not conf_paths: raise ValueError( "`conf_paths` must contain at least one path to " "load configuration files from." ) if isinstance(conf_paths, str): conf_paths = [conf_paths] self.conf_paths = _remove_duplicates(conf_paths) self.logger = logging.getLogger(__name__)
[docs] def get(self, *patterns: str) -> Dict[str, Any]: """Recursively scan for configuration files, load and merge them, and return them in the form of a config dictionary. Args: patterns: Glob patterns to match. Files, which names match any of the specified patterns, will be processed. Raises: ValueError: If 2 or more configuration files inside the same config path (or its subdirectories) contain the same top-level key. MissingConfigException: If no configuration files exist within a specified config path. Returns: Dict[str, Any]: A Python dictionary with the combined configuration from all configuration files. **Note:** any keys that start with `_` will be ignored. """ if not patterns: raise ValueError( "`patterns` must contain at least one glob " "pattern to match config filenames against." ) config = {} # type: Dict[str, Any] processed_files = set() # type: Set[Path] for conf_path in self.conf_paths: if not Path(conf_path).is_dir(): raise ValueError( "Given configuration path either does not exist " "or is not a valid directory: {0}".format(conf_path) ) config_files = _path_lookup(Path(conf_path), patterns) seen_files = set(config_files) & processed_files if seen_files: self.logger.warning( "Config file(s): %s already processed, skipping loading...", ",".join(str(seen) for seen in sorted(seen_files)), ) config_files = [cf for cf in config_files if cf not in seen_files] new_conf = _load_config(config_files) common_keys = config.keys() & new_conf.keys() if common_keys: sorted_keys = ", ".join(sorted(common_keys)) msg = ( "Config from path `%s` will override the following " "existing top-level config keys: %s" ) self.logger.info(msg, conf_path, sorted_keys) config.update(new_conf) processed_files |= set(config_files) if not processed_files: raise MissingConfigException( "No files found in {} matching the glob " "pattern(s): {}".format(str(self.conf_paths), str(list(patterns))) ) return config
def _load_config(config_files: List[Path]) -> Dict[str, Any]: """Recursively load all configuration files, which satisfy a given list of glob patterns from a specific path. Args: config_files: Configuration files sorted in the order of precedence. Raises: ValueError: If 2 or more configuration files contain the same key(s). Returns: Resulting configuration dictionary. """ # for performance reasons import anyconfig # pylint: disable=import-outside-toplevel config = {} keys_by_filepath = {} # type: Dict[Path, AbstractSet[str]] def _check_dups(file1: Path, conf: Dict[str, Any]) -> None: dups = set() for file2, keys in keys_by_filepath.items(): common = ", ".join(sorted(conf.keys() & keys)) if common: if len(common) > 100: common = common[:100] + "..." dups.add("{}: {}".format(str(file2), common)) if dups: msg = "Duplicate keys found in {0} and:\n- {1}".format( file1, "\n- ".join(dups) ) raise ValueError(msg) for config_file in config_files: cfg = { k: v for k, v in anyconfig.load(config_file).items() if not k.startswith("_") } _check_dups(config_file, cfg) keys_by_filepath[config_file] = cfg.keys() config.update(cfg) return config def _path_lookup(conf_path: Path, patterns: Iterable[str]) -> List[Path]: """Return a sorted list of all configuration files from ``conf_path`` or its subdirectories, which satisfy a given list of glob patterns. Args: conf_path: Path to configuration directory. patterns: List of glob patterns to match the filenames against. Returns: Sorted list of ``Path`` objects representing configuration files. """ config_files = set() conf_path = conf_path.resolve() for pattern in patterns: # `Path.glob()` ignores the files if pattern ends with "**", # therefore iglob is used instead for each in iglob(str(conf_path / pattern), recursive=True): path = Path(each).resolve() if path.is_file() and path.suffix in SUPPORTED_EXTENSIONS: config_files.add(path) return sorted(config_files) def _remove_duplicates(items: Iterable[str]): """Remove duplicates while preserving the order.""" unique_items = [] # type: List[str] for item in items: if item not in unique_items: unique_items.append(item) else: warn( "Duplicate environment detected! " "Skipping re-loading from configuration path: {}".format(item) ) return unique_items