Package mrv :: Module conf

Module conf

Contains implementation of the configuration system allowing to flexibly control the programs behaviour.

read and write sections with key=value pairs from and to INI style file-like objects !

Wrappers for these file-like objects allow virtually any source for the operation

configuration inheritance

allow precise control over the inheritance behaviour and inheritance defaults

final results of the inheritance operation will be cached into the ConfigManager

Environment Variables can serve as final instance to override values using the DictConfigINIFile

Creation and Maintenance of individual configuration files as controlled by submodules of the application

These configuration go to a default location, or to the given file-like object

embed more complex data to be read by specialised classes using URLs

its safe and easy to write back possibly altered values even if complex inheritance schemes are applied

Classes

[hide private]

Exceptions

ConfigParsingError
Indicates that the parsing failed

ConfigParsingPropertyError
Indicates that the property-parsing encountered a problem

INI File Converters

DictToINIFile
Wraps a dictionary into an objects returning an INI file when read

Configuration Access

ConfigAccessor
Provides full access to the Configuration

ConfigManager
Cache Configurations for fast access and provide a convenient interface

Extended File Classes

ExtendedFileInterface
Define additional methods required by the Configuration System :warning: Additionally, readline and write must be supported - its not mentioned here for reasons of speed :note: override the methods with implementation

ConfigFile
file object implementation of the ExtendedFileInterface

DictConfigINIFile
dict file object implementation of ExtendedFileInterface

ConfigStringIO
cStringIO object implementation of ExtendedFileInterface

Utility Classes

_FixedConfigParser
The RawConfigParser stores options lowercase - but we do not want that and keep the case - for this we just need to override a method

ConfigChain
A chain of config nodes

BasicSet
Set with ability to return the key which matches the requested one

_PropertyHolderBase
Simple Base defining how to deal with properties :note: to use this interface, the subclass must have a 'name' field

Key
Key with an associated values and an optional set of propterties

Section
Class defininig an indivual section of a configuration file including all its keys and section properties

PropertySection
Define a section containing keys that make up properties of somethingI

ConfigNode
Represents node in the configuration chain

Configuration Diffing Classes

DiffData
Struct keeping data about added, removed and/or changed data Subclasses should override some private methods to automatically utilize some basic functionality

DiffKey
Implements DiffData on Key level

DiffSection
Implements DiffData on section level

ConfigDiffer
Compares two configuration objects and allows retrieval of differences

Functions

[hide private]

Utility Classes

_checkString(string, re)
Check the given string with given re for correctness :param re: must match the whole string for success :return: the passed in and stripped string :raise ValueError:

source code

_excmsgprefix(msg)
Put msg in front of current exception and reraise :warning: use only within except blocks

source code

Variables

[hide private]

log = logging.getLogger("mrv.conf")

__package__ = 'mrv'