bzrlib.config.IniFileStore : API documentation

A config Store using ConfigObj for storage.

Instance Variables	transport	The transport object where the config file is located.
	file_name	The config file basename in the transport directory.
	_config_obj	Private member to hold the ConfigObj instance used to serialize/deserialize the config file.

Method	__init__	A config Store using ConfigObj for storage.
Method	is_loaded	Returns True if the Store has been loaded.
Method	unload	Unloads the Store.
Method	load	Load the store from the associated file.
Method	save	Saves the Store to persistent storage.
Method	external_url	Undocumented
Method	get_sections	Get the configobj section in the file order.
Method	get_mutable_section	Returns the specified mutable section.
Method	_load_from_string	Create a config store from a string.

Inherited from Store:

Method

__repr__

Undocumented

def __init__(self, transport, file_name):

overridden in bzrlib.config.BranchStore, bzrlib.config.LockableIniFileStore

A config Store using ConfigObj for storage.

Parameters	transport	The transport object where the config file is located.
	file_name	The config file basename in the transport directory.

def is_loaded(self):

overrides bzrlib.config.Store.is_loaded

Returns True if the Store has been loaded.

This is used to implement lazy loading and ensure the persistent storage is queried only when needed.

def unload(self):

overrides bzrlib.config.Store.unload

Unloads the Store.

This should make is_loaded() return False. This is used when the caller knows that the persistent storage has changed or may have change since the last load.

def _load_from_string(self, bytes):

overrides bzrlib.config.Store._load_from_string

Create a config store from a string.

Parameters bytes A string representing the file content.

def save(self):

overrides bzrlib.config.Store.save

overridden in bzrlib.config.BranchStore, bzrlib.config.LockableIniFileStore

Saves the Store to persistent storage.

def get_sections(self):

overrides bzrlib.config.Store.get_sections

Get the configobj section in the file order.

Returns An iterable of (name, dict).

def get_mutable_section(self, section_name=None):

overrides bzrlib.config.Store.get_mutable_section

Returns the specified mutable section.

Parameters section_name The section identifier

b.c.IniFileStore(Store) : class documentation