zim.config.manager.ConfigManagerINIConfigFile

class documentation

class ConfigManagerINIConfigFile(INIConfigFile): (source)

View In Hierarchy

Like INIConfigFile but with autosave when the dict changes

Method	`__init__`	No summary
Method	`on_changed`	Undocumented
Method	`on_file_changed`	Undocumented

Inherited from INIConfigFile:

Method	`dump`	Serialize the config to a "ini-style" config file. @returns: a list of lines with text in "ini-style" formatting
Method	`parse`	No summary
Method	`read`	Read data from file
Method	`write`	Write data and set `modified` to `False`
Instance Variable	`file`	Undocumented

Inherited from SectionedConfigDict (via INIConfigFile):

Method	`__getitem__`	Undocumented
Method	`__setitem__`	Undocumented

Inherited from ControlledDict (via INIConfigFile, SectionedConfigDict):

Method	`__delitem__`	Undocumented
Method	`changed`	Undocumented
Method	`do_changed`	Undocumented
Method	`on_child_changed`	Undocumented
Method	`set_modified`	Set the modified state. Used to reset modified to `False` after the configuration has been saved to file. @param modified: `True` or `False`
Method	`update`	Undocumented
Class Variable	`__signals__`	Undocumented
Property	`modified`	`True` when the values were modified, used to e.g. track when a config needs to be written back to file
Instance Variable	`_modified`	Undocumented

Inherited from SignalEmitter (via INIConfigFile, SectionedConfigDict, ControlledDict):

Method	`__new__`	Undocumented
Method	`block_signals`	Returns a context manager for blocking one or more signals
Method	`connect`	Register a handler for a specific object.
Method	`connect_after`	Like `connect()` but handler will be called after default handler
Method	`disconnect`	Undocumented
Method	`emit`	Undocumented
Method	`emit_return_first`	Emits a signal and stops emission on the first handler that returns a not-None value.
Method	`emit_return_iter`	Returns an generator that calls one handler on each iteration and yields the return values. This allows aggregating return values.
Method	`_connect`	Undocumented
Method	`_setup_signal`	Undocumented
Method	`_teardown_signal`	Undocumented

Inherited from ConnectorMixin (via INIConfigFile, SectionedConfigDict, ControlledDict):

Method	`connectto`	Connect to signals of another object E.g.:
Method	`connectto_all`	Convenience method to combine multiple calls to `connectto()`.
Method	`disconnect_all`	Disconnect all signals that have been connected with `connectto` and friends. Typically called when you want to destroy this object.
Method	`disconnect_from`	Disc all signals that have been connected with `connectto` and friends to a specific object.
Method	`_disconnect_from`	Undocumented
Instance Variable	`_connected_signals`	Undocumented

def __init__(self, file): (source)

overrides zim.config.dicts.INIConfigFile.__init__

Constructor

Parameters
file	a `File` or `ConfigFile` object for reading and writing the config.
monitor	if `True` will listen to the `changed` signal of the file object and update the dict accordingly. Leave `False` for objects with a short life span.

@SignalHandler
def on_changed(self, *a): (source)

Undocumented

@SignalHandler
def on_file_changed(self, *a): (source)

overrides zim.config.dicts.INIConfigFile.on_file_changed

Undocumented