API documentation

Module contents

Support for working with different sources of configuration values.

class DefaultSettings(schema.Settings):

SECRET_KEY = schema.Value(str) DEBUG = schema.Value(types.boolean, default=False) DB_URL = schema.Value(types.sqlalchemy_url) LOCALES = schema.Value(types.list(str))

settings = DefaultSettings(

providers.DictConfig(os.environ, prefix=’MYAPP_’))

coolfig.computed_value(func)

class coolfig.DictConfig(conf_dict, prefix='')

Bases: coolfig.providers.ConfigurationProvider

Loads configuration values from the passed dictionary.

get(key)

iterprefixed(prefix)

class coolfig.Dictionary(spec)

Bases: coolfig.schema.ValueBase

class coolfig.EnvDirConfig(base_path, prefix='')

Bases: coolfig.providers.ConfigurationProvider

get(key)

iterprefixed(prefix)

coolfig.load_django_settings(provider, static_config, base=<class 'coolfig.django.BaseDjangoSettings'>, apps=None, name=None)

class coolfig.Settings(config_provider)

Bases: coolfig.schema.SettingsBase

classmethod merge(*others)

Merge the others schema into this instance.

The values will all be read from the provider of the original object.

class coolfig.Value(type, default=<object object>, key=None)

Bases: coolfig.schema.ValueBase

Submodules

coolfig.django module

class coolfig.django.BaseDjangoSettings(config_provider)

Bases: coolfig.schema.Settings

ALLOWED_HOSTS

CACHES

DATABASES

DEBUG

LANGUAGE_CODE

SECRET_KEY

STATIC_URL

TIME_ZONE

USE_I18N

USE_L10N

USE_TZ

install(name=None)

load_apps(apps=None)

coolfig.django.get_app_settings_path(app_path)

coolfig.django.load_django_settings(provider, static_config, base=<class 'coolfig.django.BaseDjangoSettings'>, apps=None, name=None)

coolfig.django.make_django_settings(static_config, base=<class 'coolfig.django.BaseDjangoSettings'>)

coolfig.providers module

class coolfig.providers.ConfigurationProvider

Bases: object

get(key)

iterprefixed(prefix)

class coolfig.providers.DictConfig(conf_dict, prefix='')

Bases: coolfig.providers.ConfigurationProvider

Loads configuration values from the passed dictionary.

get(key)

iterprefixed(prefix)

class coolfig.providers.EnvDirConfig(base_path, prefix='')

Bases: coolfig.providers.ConfigurationProvider

get(key)

iterprefixed(prefix)

class coolfig.providers.FallbackProvider(providers)

Bases: coolfig.providers.ConfigurationProvider

get(key)

iterprefixed(prefix)

coolfig.schema module

class coolfig.schema.BoundValue(cls, name, value)

Bases: object

class coolfig.schema.ComputedValue(callable, *args, **kwargs)

Bases: coolfig.schema.ValueBase

class coolfig.schema.DictValue(type, keytype=<type 'str'>, *args, **kwargs)

Bases: coolfig.schema.Value

class coolfig.schema.Dictionary(spec)

Bases: coolfig.schema.ValueBase

exception coolfig.schema.ImproperlyConfigured

Bases: exceptions.Exception

Raised when e request for a configuration value cannot be fulfilled.

class coolfig.schema.Reference(key)

Bases: object

class coolfig.schema.Settings(config_provider)

Bases: coolfig.schema.SettingsBase

classmethod merge(*others)

Merge the others schema into this instance.

The values will all be read from the provider of the original object.

class coolfig.schema.SettingsBase(config_provider)

Bases: object

as_dict()

items()

keys()

class coolfig.schema.SettingsMeta(name, bases, clsdict)

Bases: type

class coolfig.schema.StaticValue(value)

Bases: coolfig.schema.BoundValue

class coolfig.schema.Value(type, default=<object object>, key=None)

Bases: coolfig.schema.ValueBase

class coolfig.schema.ValueBase

Bases: object

coolfig.schema.bind_values(cls, clsdict)

coolfig.schema.computed_value(func)

coolfig.schema.ref

alias of coolfig.schema.Reference

coolfig.types module

Common types for settings classes.

class coolfig.types.LazyCallable(module_path, callable_path)

Bases: object

func

coolfig.types.boolean(string)

coolfig.types.dottedpath(string)

coolfig.types.list(inner_type, sep=', ')