Module superconfig.superconf

Classes

class SuperConfig

Expand source code

class SuperConfig:
    _parsers = []
    KEY_NOT_FOUND = object

    @staticmethod
    def setup(path_default: str, path_custom: str, env_prefix="", **kwargs):
        SuperConfig._env_prefix = "" if env_prefix is None else env_prefix
        SuperConfig._parsers = [
            get_env_parser(env_prefix),
            get_file_parser(path_custom, **kwargs),
            get_file_parser(path_default, **kwargs),
        ]

    @staticmethod
    def get(key: str, fallback: object = KEY_NOT_FOUND, dtype: ANY = ANY):
        for parser in SuperConfig._parsers:
            try:
                res = parser.get(key)
                if res is not None:
                    return dtype(res)
            except KeyError:
                pass
        if fallback == SuperConfig.KEY_NOT_FOUND:
            raise KeyError(f"Value for {key} not found.")
        return fallback

Class variables

var KEY_NOT_FOUND

The base class of the class hierarchy.

When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

Static methods

def get(key: str, fallback: object = builtins.object, dtype: ANY = superconfig.utilities.dtypes.ANY)

Expand source code

@staticmethod
def get(key: str, fallback: object = KEY_NOT_FOUND, dtype: ANY = ANY):
    for parser in SuperConfig._parsers:
        try:
            res = parser.get(key)
            if res is not None:
                return dtype(res)
        except KeyError:
            pass
    if fallback == SuperConfig.KEY_NOT_FOUND:
        raise KeyError(f"Value for {key} not found.")
    return fallback

def setup(path_default: str, path_custom: str, env_prefix='', **kwargs)

Expand source code

@staticmethod
def setup(path_default: str, path_custom: str, env_prefix="", **kwargs):
    SuperConfig._env_prefix = "" if env_prefix is None else env_prefix
    SuperConfig._parsers = [
        get_env_parser(env_prefix),
        get_file_parser(path_custom, **kwargs),
        get_file_parser(path_default, **kwargs),
    ]