djangofloor.conf.providers

Providers of Django settings

Settings that are merged to provide the final Django settings come from different kinds of sources (Python modules or files, ini files, …).

class djangofloor.conf.providers.ConfigFieldsProvider

Provides a list of djangofloor.conf.fields.ConfigField. Used for retrieving settings from a config file.

get_config_fields()

Return a list of config fields

name = None

class djangofloor.conf.providers.ConfigProvider

Base class of config provider.

get_extra_settings()

Return all settings internally defined.

Returns:an iterable of (setting_name, value)

get_value(config_field)

Get the internal value if the config field is present in its internal values. Otherwise returns the current value of the config field.

has_value(config_field)

Return True if a config_field is present in the file

is_valid()

Return True if the provider is valid (for example, the corresponding file is missing).

name = None

set_value(config_field, include_doc=False)

Get the value of the config_field and set its internal value

to_str()

Convert all its internal values to a string

class djangofloor.conf.providers.DictProvider(values)

Use a plain Python dict as a setting provider

get_extra_settings()

Return all uppercase keys of the internal dict as valid filenames

get_value(config_field)

get a value from the internal dict if present

has_value(config_field)

check if the value is present in the internal dict

is_valid()

always True

name = 'dict'

set_value(config_field, include_doc=False)

modify the internal dict for storing the value

to_str()

display the internal dict

class djangofloor.conf.providers.IniConfigProvider(config_file=None)

Read a config file using the .ini syntax.

get_extra_settings()

No extra setting can be defined in a config file

get_value(config_field: djangofloor.conf.fields.ConfigField)

get option from the config file

has_value(config_field: djangofloor.conf.fields.ConfigField)

return True if the option is defined in the config file

is_valid()

Return True if the config file exists

name = '.ini file'

set_value(config_field: djangofloor.conf.fields.ConfigField, include_doc: bool = False)

update the internal config file

to_str()

Display the config file

class djangofloor.conf.providers.PythonConfigFieldsProvider(value=None)

Provide a list of djangofloor.conf.fields.ConfigField from an attribute in a Python module.

get_config_fields()

Return the list that is defined in the module by the attribute name

name = 'Python attribute'

class djangofloor.conf.providers.PythonFileProvider(module_filename)

Load a Python module from the filename

name = 'Python file'

class djangofloor.conf.providers.PythonModuleProvider(module_name=None)

Load a Python module from its dotted name

get_extra_settings()

Return all values that look like a Django setting (i.e. uppercase variables)

get_value(config_field)

Get the value of a variable defined in the Python module.

has_value(config_field)

True if the corresponding variable is defined in the module

is_valid()

Return True if the module can be imported

name = 'Python module'

set_value(config_field, include_doc=False)

Set the value of the config field in an internal dict

to_str()

Display values as if set in a Python module