betterConfigParser.BetterConfigParser Class Reference

Inheritance diagram for betterConfigParser.BetterConfigParser:

Public Member Functions
def	__init__
def	checkInput
def	exists
def	getAlignments
def	getCompares
def	getGeneral
def	getResultingSection
def	items
def	optionxform
def	set
def	write

Static Public Attributes
tuple	OPTCRE_VALIDATION

Private Member Functions
def	__updateDict

Private Attributes
	_optcre

Detailed Description

Definition at line 56 of file betterConfigParser.py.

Constructor & Destructor Documentation

def betterConfigParser.BetterConfigParser.__init__

(

self

)

Definition at line 57 of file betterConfigParser.py.

Member Function Documentation

def betterConfigParser.BetterConfigParser.__updateDict (   self,   dictionary,   section  )

private

Definition at line 74 of file betterConfigParser.py.

def betterConfigParser.BetterConfigParser.checkInput	(		self,
			section,
			knownSimpleOptions = [],
			knownKeywords = [],
			ignoreOptions = []
	)

Method which checks, if the given options in `section` are in the
list of `knownSimpleOptions` or match an item of `knownKeywords`.
This is basically a check for typos and wrong parameters.

Arguments:
- `section`: Section of a configuration file
- `knownSimpleOptions`: List of allowed simple options in `section`.
- `knownKeywords`: List of allowed keywords in `section`.

Definition at line 166 of file betterConfigParser.py.

def betterConfigParser.BetterConfigParser.exists	(		self,
			section,
			option
	)

Definition at line 64 of file betterConfigParser.py.

def betterConfigParser.BetterConfigParser.getAlignments

(

self

)

Definition at line 122 of file betterConfigParser.py.

def betterConfigParser.BetterConfigParser.getCompares

(

self

)

Definition at line 130 of file betterConfigParser.py.

def betterConfigParser.BetterConfigParser.getGeneral

(

self

)

Definition at line 144 of file betterConfigParser.py.

def betterConfigParser.BetterConfigParser.getResultingSection	(		self,
			section,
			defaultDict = {},
			demandPars = []
	)

Definition at line 89 of file betterConfigParser.py.

def betterConfigParser.BetterConfigParser.items	(		self,
			section,
			raw = False,
			vars = None
	)

Definition at line 201 of file betterConfigParser.py.

def betterConfigParser.BetterConfigParser.optionxform	(		self,
			optionstr
	)

Definition at line 61 of file betterConfigParser.py.

def betterConfigParser.BetterConfigParser.set	(		self,
			section,
			option,
			value = None
	)

Definition at line 194 of file betterConfigParser.py.

def betterConfigParser.BetterConfigParser.write	(		self,
			fp
	)

Write an .ini-format representation of the configuration state.

Definition at line 210 of file betterConfigParser.py.

Member Data Documentation

betterConfigParser.BetterConfigParser._optcre

private

Definition at line 59 of file betterConfigParser.py.

tuple betterConfigParser.BetterConfigParser.OPTCRE_VALIDATION

static

Initial value:

= re.compile(
        r'(?P<option>'
        r'(?P<preexisting>preexisting)?'
        r'[^:=\s][^:=]*)'                     # very permissive!
        r'\s*(?(preexisting)|'                # IF preexisting does not exist:
        r'(?P<vi>[:=])\s*'                    #   any number of space/tab,
                                              #   followed by separator
                                              #   (either : or =), followed
                                              #   by any # space/tab
        r'(?P<value>.*))$'                    #   everything up to eol
        )

Definition at line 226 of file betterConfigParser.py.