gaupol.ConfigurationStore

Source: gaupol/config.py

Anchestors: gaupol.attrdict.AttributeDictionary, aeidon.observable.Observable, builtins.object

class gaupol.ConfigurationStore

Reading, writing and storing configurations.

ConfigurationStore.path

Path to user’s local configuration file

Methods

ConfigurationStore.__init__()

Initialize a ConfigurationStore instance.

ConfigurationStore.connect_notify(sections, option, obj, *args)

Connect option‘s notify signal to obj‘s callback method.

ConfigurationStore.disconnect_notify(sections, option, obj)

Disconnect option‘s notify signal from obj‘s callback method.

ConfigurationStore.query_default(sections, option)

Return default value of configuration option.

Raise LookupError if section or option not found.

ConfigurationStore.read_from_file()

Read values of configuration options from file.

Raise IOError if reading file fails. Raise UnicodeError if decoding file fails. Fail silently if path is not set.

ConfigurationStore.register_extension(name, defaults, enums=None)

Add section and options for extension.

name should be preferrably the module name of the extension and it will appear in the section name as extensions::name. defaults should be a dictionary of default values for options. enums should be a dictionary of aeidon.Enumeration instances corresponding to enumeration items that appear in options.

ConfigurationStore.restore_defaults()

Set all configuration options to their default values.

ConfigurationStore.write_to_file()

Write values of configuration options to file.

Raise IOError or OSError if unable to create configuration directory or unable to write configuration file. Fail silently if path is not set.