Inheritance diagram for betterConfigParser.BetterConfigParser:

Public Member Functions
def	__init__ (self)

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

def	exists (self, section, option)

def	getAlignments (self)

def	getCompares (self)

def	getGeneral (self)

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

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

def	optionxform (self, optionstr)

def	set (self, section, option, value=None)

def	write (self, fp)

Static Public Attributes
	OPTCRE_VALIDATION

Private Member Functions
def	__updateDict (self, dictionary, section)

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.

     def __init__(self):
         ConfigParser.ConfigParser.__init__(self,dict_type=AdaptedDict)
         self._optcre = self.OPTCRE_VALIDATION
 

Member Function Documentation

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

private

Definition at line 74 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 as section:
             msg = ("%s in configuration files. This section is mandatory."
                    %(str(section).replace(":", "", 1)))
             raise AllInOneError(msg)
         return result
 

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

References FileExportPlugin.FileExportPlugin.options, cmsswPreprocessor.CmsswPreprocessor.options, DOTExport.DotProducer.options, eventsfwlite.Events.options, confdb.HLTProcess.options, production_tasks.Task.options, VisualizationOptions.options(), fireworks::OptionNode.options(), and edmIntegrityCheck.IntegrityCheck.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`.
         """
 
         try:
             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)
         except ConfigParser.NoSectionError:
             pass
 

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

Definition at line 64 of file betterConfigParser.py.

References PixelDCSObject< T >.items, betterConfigParser.AdaptedDict.items(), betterConfigParser.BetterConfigParser.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
         

def betterConfigParser.BetterConfigParser.getAlignments ( self )

Definition at line 122 of file betterConfigParser.py.

References DDCutTubsFromPoints.sections.

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

def betterConfigParser.BetterConfigParser.getCompares ( self )

Definition at line 130 of file betterConfigParser.py.

     def getCompares( self ):
         compares = {}
         for section in self.sections():
             if "compare:" in section:
                 self.checkInput(section,
                                 knownSimpleOptions = ["levels", "dbOutput","moduleList","modulesToPlot","useDefaultRange","plotOnlyGlobal","plotPng","makeProfilePlots",
                                                       "dx_min","dx_max","dy_min","dy_max","dz_min","dz_max","dr_min","dr_max","rdphi_min","rdphi_max",
                                                       "dalpha_min","dalpha_max","dbeta_min","dbeta_max","dgamma_min","dgamma_max",
                                                       "jobmode", "3DSubdetector1", "3Dubdetector2", "3DTranslationalScaleFactor", "jobid"])
                 levels = self.get( section, "levels" )
                 dbOutput = self.get( section, "dbOutput" )
                 compares[section.split(":")[1]] = ( levels, dbOutput )
         return compares
 

def betterConfigParser.BetterConfigParser.getGeneral ( self )

Definition at line 144 of file betterConfigParser.py.

     def getGeneral( self ):
         defaults = {
             "jobmode":"interactive",
             "datadir":os.getcwd(),
             "logdir":os.getcwd(),
             "eosdir": "",
             }
         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")
         if not self.has_option(internal_section, "scriptsdir"):
             self.set(internal_section, "scriptsdir", None)
             #replaceByMap will fail if this is not replaced (which it is in validateAlignments.py)
 
         general["workdir"] = self.get(internal_section, "workdir")
         general["scriptsdir"] = self.get(internal_section, "scriptsdir")
         for folder in "workdir", "datadir", "logdir", "eosdir":
             general[folder] = os.path.expandvars(general[folder])
 
         return general
     

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

Definition at line 89 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 as 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 as 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)
         try:
             result = self.__updateDict( result, section )
         except AllInOneError:   #section doesn't exist
             if demandPars:      #then there's at least one mandatory parameter, which means the section needs to be there
                 raise           #otherwise all the parameters are optional, so it's ok
         return result
 

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

Definition at line 205 of file betterConfigParser.py.

References Vispa.Main.SplitterTab.SplitterToolBar._sections, and html.HtmlReport._sections.

Referenced by betterConfigParser.BetterConfigParser.exists(), python.rootplot.core.Options.kwarg_list(), and betterConfigParser.BetterConfigParser.write().

     def items(self, section, raw=False, vars=None):
         if section == "validation":
             if raw or vars:
                 raise NotImplementedError("'raw' and 'vars' do not work for betterConfigParser.items()!")
             items = self._sections["validation"].items()
             return items
         else:
             return ConfigParser.ConfigParser.items(self, section, raw, vars)
 

def betterConfigParser.BetterConfigParser.optionxform	(	self,
		optionstr
	)

Definition at line 61 of file betterConfigParser.py.

     def optionxform(self, optionstr):
         return optionstr
     

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

Definition at line 198 of file betterConfigParser.py.

Referenced by betterConfigParser.BetterConfigParser.getGeneral().

     def set(self, section, option, value=None):
         try:
             ConfigParser.ConfigParser.set(self, section, option, value)
         except ConfigParser.NoSectionError:
             self.add_section(section)
             ConfigParser.ConfigParser.set(self, section, option, value)
 

def betterConfigParser.BetterConfigParser.write	(	self,
		fp
	)

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

Definition at line 214 of file betterConfigParser.py.

References Vispa.Main.SplitterTab.SplitterToolBar._sections, html.HtmlReport._sections, betterConfigParser.BetterConfigParser.items(), join(), python.rootplot.root2matplotlib.replace(), and harvestTrackValidationPlots.str.

Referenced by pkg.AbstractPkg.generate(), and querying.connection.write_and_commit().

     def write(self, fp):
         """Write an .ini-format representation of the configuration state."""
         for section in self._sections:
             fp.write("[%s]\n" % section)
             for (key, value) in self._sections[section].items():
                 if key == "__name__" or not isinstance(value, (str, unicode)):
                     continue
                 if value is not None:
                     key = " = ".join((key, str(value).replace('\n', '\n\t')))
                 fp.write("%s\n" % (key))
             fp.write("\n")
 
 

Member Data Documentation

betterConfigParser.BetterConfigParser._optcre

private

Definition at line 59 of file betterConfigParser.py.

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

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation