betterConfigParser::BetterConfigParser Class Reference

List of all members.

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.

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

---

Member Function Documentation

def betterConfigParser::BetterConfigParser::__updateDict	(		self,
			dictionary,
			section
	)		[private]

Definition at line 66 of file betterConfigParser.py.

                                                 :
        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

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

                                    :
        """
        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.

00057                                       :
00058         try:
00059             items = self.items(section) 
00060         except ConfigParser.NoSectionError:
00061             return False
00062         for item in items:
00063             if item[0] == option:
00064                 return True
00065         return False
        

def betterConfigParser::BetterConfigParser::getAlignments

(

self

)

Definition at line 110 of file betterConfigParser.py.

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

                           :
        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

def betterConfigParser::BetterConfigParser::getGeneral

(

self

)

Definition at line 130 of file betterConfigParser.py.

00131                           :
00132         defaults = {
00133             "jobmode":"interactive",
00134             "datadir":os.getcwd(),
00135             "logdir":os.getcwd(),
00136             "eosdir": "",
00137             "email":"true"
00138             }
00139         self.checkInput("general", knownSimpleOptions = defaults.keys())
00140         general = self.getResultingSection( "general", defaultDict = defaults )
00141         internal_section = "internals"
00142         if not self.has_section(internal_section):
00143             self.add_section(internal_section)
00144         if not self.has_option(internal_section, "workdir"):
00145             self.set(internal_section, "workdir", "/tmp/$USER")
00146         general["workdir"] = self.get(internal_section, "workdir")
00147         return general
    

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

Definition at line 81 of file betterConfigParser.py.

                                                          {}, 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

def betterConfigParser::BetterConfigParser::getSep

(

self

)

Definition at line 50 of file betterConfigParser.py.

                    :
        return self._sep

def betterConfigParser::BetterConfigParser::optionxform	(		self,
			optionstr
	)

Definition at line 53 of file betterConfigParser.py.

00054                                     :
00055         return optionstr
    

---

Member Data Documentation

betterConfigParser::BetterConfigParser::_sep [private]

Definition at line 44 of file betterConfigParser.py.