Reference Manual

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages

Inheritance diagram for betterConfigParser.BetterConfigParser:

Public Member Functions
def	__init__

def	checkInput

def	exists

def	getAlignments

def	getCompares

def	getGeneral

def	getResultingSection

def	getSep

def	optionxform

Private Member Functions
def	__updateDict

Private Attributes
	_sep

Detailed Description

Definition at line 43 of file betterConfigParser.py.

Constructor & Destructor Documentation

def betterConfigParser.BetterConfigParser.__init__ ( self )

Definition at line 44 of file betterConfigParser.py.

 
     def __init__(self):
         ConfigParser.ConfigParser.__init__(self,dict_type=AdaptedDict)
         dummyDict = AdaptedDict()
         self._sep = dummyDict.getSep()
         del dummyDict

betterConfigParser.AdaptedDict

Definition: betterConfigParser.py:7

betterConfigParser.BetterConfigParser.__init__

def __init__

Definition: betterConfigParser.py:44

betterConfigParser.BetterConfigParser._sep

_sep

Definition: betterConfigParser.py:47

Member Function Documentation

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

private

Definition at line 66 of file betterConfigParser.py.

Referenced by betterConfigParser.BetterConfigParser.getResultingSection().

 
     def __updateDict( self, dictionary, section ):
         result = dictionary
         try:
             for option in self.options( section ):
                 result[option] = self.get( section, option )
             if "local"+section.title() in self.sections():
                 for option in self.options( "local"+section.title() ):
                     result[option] = self.get( "local"+section.title(),
                                                    option )
         except ConfigParser.NoSectionError, section:
             msg = ("%s in configuration files. This section is mandatory."
                    %(str(section).replace(":", "", 1)))
             raise AllInOneError(msg)
         return result

linker.replace

def replace

Definition: linker.py:10

betterConfigParser.BetterConfigParser.__updateDict

def __updateDict

Definition: betterConfigParser.py:66

TkAlExceptions.AllInOneError

Definition: TkAlExceptions.py:1

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 149 of file betterConfigParser.py.

References FileExportPlugin.FileExportPlugin.options, ModelTools.ModelBuilderBase.options, PhysicsModel.PhysicsModel.options, DOTExport.DotProducer.options, CascadeMinimizer.options(), LimitAlgo.options(), fireworks::OptionNode.options(), and confdb.HLTProcess.options.

Referenced by betterConfigParser.BetterConfigParser.getCompares(), and betterConfigParser.BetterConfigParser.getGeneral().

 
                    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`.
         """
 
         for option in self.options( section ):
             if option in knownSimpleOptions:
                 continue
             elif option.split()[0] in knownKeywords:
                 continue
             elif option in ignoreOptions:
                 print ("Ignoring option '%s' in section '[%s]'."
                        %(option, section))
             else:
                 msg = ("Invalid or unknown parameter '%s' in section '%s'!"
                        %(option, section))
                 raise AllInOneError(msg)
 

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

Definition at line 56 of file betterConfigParser.py.

References ora::RecordSpecImpl.items, PixelDCSObject< class >.items, DictTypes.SortedKeysDict.items(), EcalContainer< EcalTrigTowerDetId, Item >.items(), EcalContainer< EcalScDetId, Item >.items(), EcalContainer< EEDetId, Item >.items(), EcalContainer< EBDetId, Item >.items(), EcalContainer< DetId, T >.items(), EcalContainer< ESDetId, Item >.items(), ora::Selection.items(), cacheutils::ValuesCache.items, AlignmentSurfaceDeformations.items(), HDQMInspector::DetIdItemList.items, edm::ErrorObj.items(), FWTableViewManager.items(), python.seqvaluedict.seqdict.items(), argparse.HelpFormatter._Section.items, python.rootplot.argparse.HelpFormatter._Section.items, and svgfig.SVG.items().

 
     def exists( self, section, option):
         try:
             items = self.items(section) 
         except ConfigParser.NoSectionError:
             return False
         for item in items:
             if item[0] == option:
                 return True
         return False

betterConfigParser.BetterConfigParser.exists

def exists

Definition: betterConfigParser.py:56

def betterConfigParser.BetterConfigParser.getAlignments ( self )

Definition at line 110 of file betterConfigParser.py.

 
     def getAlignments( self ):
         alignments = []
         for section in self.sections():
             if "alignment:" in section:
                 alignments.append( Alignment( section.split( "alignment:" )[1],
                                               self ) )
         return alignments

betterConfigParser.BetterConfigParser.getAlignments

def getAlignments

Definition: betterConfigParser.py:110

def betterConfigParser.BetterConfigParser.getCompares ( self )

Definition at line 118 of file betterConfigParser.py.

 
     def getCompares( self ):
         compares = {}
         for section in self.sections():
             if "compare:" in section:
                 self.checkInput(section,
                                 knownSimpleOptions = ["levels", "dbOutput",
                                                       "jobmode"])
                 levels = self.get( section, "levels" )
                 dbOutput = self.get( section, "dbOutput" )
                 compares[section.split(":")[1]] = ( levels, dbOutput )
         return compares

betterConfigParser.BetterConfigParser.getCompares

def getCompares

Definition: betterConfigParser.py:118

betterConfigParser.BetterConfigParser.checkInput

def checkInput

Definition: betterConfigParser.py:149

def betterConfigParser.BetterConfigParser.getGeneral ( self )

Definition at line 130 of file betterConfigParser.py.

 
     def getGeneral( self ):
         defaults = {
             "jobmode":"interactive",
             "datadir":os.getcwd(),
             "logdir":os.getcwd(),
             "eosdir": "",
             "email":"true"
             }
         self.checkInput("general", knownSimpleOptions = defaults.keys())
         general = self.getResultingSection( "general", defaultDict = defaults )
         internal_section = "internals"
         if not self.has_section(internal_section):
             self.add_section(internal_section)
         if not self.has_option(internal_section, "workdir"):
             self.set(internal_section, "workdir", "/tmp/$USER")
         general["workdir"] = self.get(internal_section, "workdir")
         return general

betterConfigParser.BetterConfigParser.getResultingSection

def getResultingSection

Definition: betterConfigParser.py:81

betterConfigParser.BetterConfigParser.getGeneral

def getGeneral

Definition: betterConfigParser.py:130

betterConfigParser.BetterConfigParser.checkInput

def checkInput

Definition: betterConfigParser.py:149

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

Definition at line 81 of file betterConfigParser.py.

Referenced by betterConfigParser.BetterConfigParser.getGeneral().

 
     def getResultingSection( self, section, defaultDict = {}, demandPars = [] ):
         result = copy.deepcopy(defaultDict)
         for option in demandPars:
             try:
                 result[option] = self.get( section, option )
             except ConfigParser.NoOptionError, globalSectionError:
                 globalSection = str( globalSectionError ).split( "'" )[-2]
                 splittedSectionName = section.split( ":" )
                 if len( splittedSectionName ) > 1:
                     localSection = ("local"+section.split( ":" )[0].title()+":"
                                     +section.split(":")[1])
                 else:
                     localSection = ("local"+section.split( ":" )[0].title())
                 if self.has_section( localSection ):
                     try:
                         result[option] = self.get( localSection, option )
                     except ConfigParser.NoOptionError, option:
                         msg = ("%s. This option is mandatory."
                                %(str(option).replace(":", "", 1).replace(
                                     "section",
                                     "section '"+globalSection+"' or", 1)))
                         raise AllInOneError(msg)
                 else:
                     msg = ("%s. This option is mandatory."
                            %(str(globalSectionError).replace(":", "", 1)))
                     raise AllInOneError(msg)
         result = self.__updateDict( result, section )
         return result

indexGen.title

title

Definition: indexGen.py:48

betterConfigParser.BetterConfigParser.getResultingSection

def getResultingSection

Definition: betterConfigParser.py:81

linker.replace

def replace

Definition: linker.py:10

betterConfigParser.BetterConfigParser.__updateDict

def __updateDict

Definition: betterConfigParser.py:66

TkAlExceptions.AllInOneError

Definition: TkAlExceptions.py:1

split

double split

Definition: MVATrainer.cc:139

def betterConfigParser.BetterConfigParser.getSep ( self )

Definition at line 50 of file betterConfigParser.py.

References betterConfigParser.BetterConfigParser._sep.

 
     def getSep(self):
         return self._sep

betterConfigParser.BetterConfigParser._sep

_sep

Definition: betterConfigParser.py:47

betterConfigParser.BetterConfigParser.getSep

def getSep

Definition: betterConfigParser.py:50

def betterConfigParser.BetterConfigParser.optionxform	(	self,
		optionstr
	)

Definition at line 53 of file betterConfigParser.py.

 
     def optionxform(self, optionstr):
         return optionstr

betterConfigParser.BetterConfigParser.optionxform

def optionxform

Definition: betterConfigParser.py:53

Member Data Documentation

betterConfigParser.BetterConfigParser._sep

private

Definition at line 47 of file betterConfigParser.py.

Referenced by betterConfigParser.BetterConfigParser.getSep().

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation