config_resolver provides a
Config class, which looks up common locations
for config files and loads them if found. It provides a framework independed
way of handling configuration files. Additional care has been taken to allow
the end-user of the application to override this lookup process.
Config(group_name, app_name, search_path=None, filename='app.ini', require_load=False, version=None, **kwargs)¶
- group_name – an application group (f. ex.: your company name)
- app_name – an application identifier (f.ex.: the application module name)
- search_path – if specified, set the config search path to the
given value. The path can use OS specific separators (f.ex.:
;on windows) to specify multiple folders. These folders will be searched in the specified order. The config files will be loaded incrementally. This means that the each subsequent config file will extend/override existing values. This means that the last file will take precedence.
- filename – if specified, this can be used to override the configuration filename.
- require_load – If this is set to
True, creation of the config instance will raise an
OSErrorif not a single file could be loaded.
- version – If specified (f.ex.:
version='2.0'), this will create a versioned config instance. A versioned instance may raise a
IncompatibleVersionexception if the major version differs from the one found in the config file. If left to the default, no version checking is performed. Version numbers are parsed using
filenamecan be read. Will return a 2-tuple containing a boolean if the file can be read, and a string containing an error/warning message.
If the status is “True”, then the message should be considered a warning. Otherwise it should be considered an error.
get(section, option, **kwargs)¶
In addition to
option, this call takes an optional
defaultvalue. This behaviour works in addition to the
configparser.ConfigParserdefault mechanism. Note that a default value from
The reason this additional functionality is added, is because the defaults of
configparser.ConfigParserare not dependent on sections. If you specify a default for the option
test, then this value will be returned for both
section2.test. Using the default on the
getcall gives you more fine-grained control over this.
Also note, that if a default value was used, it will be logged with level
- section – The config file section.
- option – The option name.
- kwargs – These keyword args are passed through to
Returns a list of paths specified by the XDG_CONFIG_DIRS environment variable or the appropriate default.
The list is sorted by precedence, with the most important item coming last (required by the existing config_resolver logic).
Returns the value specified in the XDG_CONFIG_HOME environment variable or the appropriate default.
Searches for an appropriate config file. If found, loads the file into the current instance. This method can also be used to reload a configuration. Note that you may want to set
Trueto clear the configuration before loading in that case. Without doing that, values will remain available even if they have been removed from the config files.
- reload – if set to
True, the existing values are cleared before reloading.
- require_load – If set to
Truethis will raise a
IOErrorif no config file has been found to load.
- reload – if set to
ConfigResolverBase(defaults=None, dict_type=<class 'collections.OrderedDict'>, allow_no_value=False)¶
A default “base” object simplifying Python 2 and Python 3 compatibility.
This exception is raised if a config file is loaded which has a different major version number than expected by the application.
This exception is raised if the application expects a version number to be present in the config file but does not find one.
PrefixFilter(prefix, separator=' ')¶
A logging filter which prefixes each message with a given text.
- prefix – The log prefix.
- separator – A string to put between the prefix and the original log message.
SecuredConfig(group_name, app_name, search_path=None, filename='app.ini', require_load=False, version=None, **kwargs)¶
A subclass of
Configwhich will refuse to load config files which are read able by other users than the owner.