EnvConfig::xmlModule::XMLOperations Class Reference

List of all members.

Public Member Functions
def	__init__
def	errors
def	warnings
def	check
def	merge
Public Attributes
	posActions
	separator
	report
	varNames
	realVariables
	variables
	output
	file
Private Member Functions
def	_processVars
def	_checkVariable
def	_loadVariables

---

Detailed Description

This class is for checking and merging XML files.

Variables are stored in a double dictionary with keys of names and then actions.

Definition at line 194 of file xmlModule.py.

---

Constructor & Destructor Documentation

def EnvConfig::xmlModule::XMLOperations::__init__	(		self,
			separator = ':',
			reportLevel = 0,
			reportOutput = False
	)

Definition at line 199 of file xmlModule.py.

                                  :', reportLevel = 0, reportOutput = False):
        self.posActions = ['append','prepend','set','unset', 'remove', 'remove-regexp', 'declare']
        self.separator = separator
        self.report = Report(reportLevel, reportOutput = reportOutput)

---

Member Function Documentation

def EnvConfig::xmlModule::XMLOperations::_checkVariable	(		self,
			varName,
			action,
			local,
			value,
			nodeNum
	)		[private]

Tries to add to variables dict, checks for errors during process

Definition at line 273 of file xmlModule.py.

                                                                    :
        '''Tries to add to variables dict, checks for errors during process'''

        if varName not in self.variables:
            self.variables[varName] = []
            self.variables[varName].append(action)

        # If variable is in dict, check if this is not an unset command
        elif action == 'unset':
            if 'unset' in self.variables[varName]:
                self.report.addWarn('Multiple "unset" actions found for variable: "'+varName+'".', varName, 'multiple unset','', 'checkVariable')
            if not('unset' in self.variables[varName] and len(self.variables[varName]) == 1):
                self.report.addError('Node '+str(nodeNum)+': "unset" action found for variable "'+varName+'" after previous command(s). Any previous commands are overridden.', varName, 'unset overwrite')

        # or set command
        elif action == 'set':
            if len(self.variables[varName]) == 1 and 'unset' in self.variables[varName]:
                self.report.addWarn('Node '+str(nodeNum)+': "set" action found for variable "'+varName+'" after unset. Can be merged to one set only.')
            else:
                self.report.addError('Node '+str(nodeNum)+': "set" action found for variable "'+varName+'" after previous command(s). Any previous commands are overridden.', varName, 'set overwrite')
                if 'set' in self.variables[varName]:
                    self.report.addWarn('Multiple "set" actions found for variable: "'+varName+'".', varName, 'multiple set','', 'checkVariable')

        if action not in self.variables[varName]:
            self.variables[varName].append(action)

        try:
            if action == 'remove-regexp':
                action = 'remove_regexp'
            eval('(self.realVariables[varName]).'+action+'(value)')
        except Variable.EnvironmentError as e:
            if e.code == 'undefined':
                self.report.addWarn('Referenced variable "' +e.val+ '" is not defined.')
            elif e.code == 'ref2var':
                self.report.addError('Reference to list from the middle of string.')
            elif e.code == 'redeclaration':
                self.report.addError('Redeclaration of variable "'+e.val+'".')
            else:
                self.report.addError('Unknown environment error occured.')

def EnvConfig::xmlModule::XMLOperations::_loadVariables	(		self,
			fileName
	)		[private]

loads XML file for input variables

Definition at line 314 of file xmlModule.py.

                                      :
        '''loads XML file for input variables'''
        XMLfile = XMLFile()
        variables = XMLfile.variable(fileName)
        for i, (action, (arg1, arg2, arg3))  in enumerate(variables):
            undeclared = False
            if arg1 == '':
                raise RuntimeError('Empty variable or local name is not allowed.')

            if arg1 not in self.realVariables.keys():
                if action != 'declare':
                    self.report.addInfo('Node '+str(i)+': Variable '+arg1+' is used before declaration. Treated as an unlocal list furthermore.')
                    undeclared = True
                    self.realVariables[arg1] = Variable.List(arg1, False, report=self.report)
                else:
                    self.varNames.append(arg1)
                    if arg2 == 'list':
                        self.realVariables[arg1] = Variable.List(arg1, arg3, report=self.report)
                    else:
                        self.realVariables[arg1] = Variable.Scalar(arg1, arg3, report=self.report)
                    if not undeclared:
                        continue

            if action not in self.posActions:
                self.report.addError('Node '+str(i)+': Action "'+action+'" which is not implemented found. Variable "'+arg1+'".', arg1, action, arg2)
                continue

            else:
                if action == 'declare':
                    self.report.addError('Node '+str(i)+': Variable '+arg1+' is redeclared.')
                else:
                    self._checkVariable(arg1, action, self.realVariables[arg1].local, str(arg2), i)

def EnvConfig::xmlModule::XMLOperations::_processVars	(		self,
			variables
	)		[private]

Definition at line 257 of file xmlModule.py.

                                     :
        for action, (arg1, arg2, arg3) in variables:
            if action == 'declare':
                if arg1 in self.variables.keys():
                    if arg2.lower() != self.variables[arg1][0]:
                        raise Variable.EnvironmentError(arg1, 'redeclaration')
                    else:
                        if arg3.lower() != self.variables[arg1][1]:
                            raise Variable.EnvironmentError(arg1, 'redeclaration')
                else:
                    self.file.writeVar(arg1, 'declare', '', arg2, arg3)
                    self.variables[arg1] = [arg2.lower(), arg3.lower()]
            else:
                self.file.writeVar(arg1, action, arg2)

def EnvConfig::xmlModule::XMLOperations::check	(		self,
			xmlFile
	)

Runs a check through file

First check is made on wrong action parameter.
All valid actions are checked after and duplicated variables as well.

Definition at line 210 of file xmlModule.py.

                            :
        '''Runs a check through file

        First check is made on wrong action parameter.
        All valid actions are checked after and duplicated variables as well.
        '''
        #self.local = Variable.Local()
        self.varNames = []
        self.realVariables = {}
        self.variables = {}

        # load variables and resolve references to locals and then variables
        self._loadVariables(xmlFile)

        # report
        if (self.warnings() > 0 or self.errors() > 0):
            self.report.addInfo('Encountered '+ (str)(self.warnings()) +' warnings and ' + (str)(self.errors()) + ' errors.')
            return [self.warnings(), self.errors()]
        else:
            return True

        self.report.closeFile()

def EnvConfig::xmlModule::XMLOperations::errors

(

self )

Definition at line 204 of file xmlModule.py.

                    :
        return self.report.numErrors()

def EnvConfig::xmlModule::XMLOperations::merge	(		self,
			xmlDoc1,
			xmlDoc2,
			outputFile = '',
			reportCheck = False
	)

Merges two files together. Files are checked first during variables loading process.

Second file is processed first, then the first file and after that they are merged together.

Definition at line 234 of file xmlModule.py.

                                                                           :
        '''Merges two files together. Files are checked first during variables loading process.

        Second file is processed first, then the first file and after that they are merged together.
        '''
        self.output = outputFile
        self.file = XMLFile()
        self.variables = {}

        variables = self.file.variable(xmlDoc1)
        self._processVars(variables)
        variables = self.file.variable(xmlDoc2)
        self._processVars(variables)

        if not reportCheck:
            self.report.level = 5

        self.file.writeToFile(outputFile)

        self.report.addInfo('Files merged. Running check on the result.')
        self.check(self.output)
        self.report.closeFile()

def EnvConfig::xmlModule::XMLOperations::warnings

(

self )

Definition at line 207 of file xmlModule.py.

                      :
        return self.report.numWarnings()

---

Member Data Documentation

EnvConfig::xmlModule::XMLOperations::file

Definition at line 237 of file xmlModule.py.

EnvConfig::xmlModule::XMLOperations::output

Definition at line 237 of file xmlModule.py.

EnvConfig::xmlModule::XMLOperations::posActions

Definition at line 199 of file xmlModule.py.

EnvConfig::xmlModule::XMLOperations::realVariables

Definition at line 214 of file xmlModule.py.

EnvConfig::xmlModule::XMLOperations::report

Definition at line 199 of file xmlModule.py.

EnvConfig::xmlModule::XMLOperations::separator

Definition at line 199 of file xmlModule.py.

EnvConfig::xmlModule::XMLOperations::variables

Definition at line 214 of file xmlModule.py.

EnvConfig::xmlModule::XMLOperations::varNames

Definition at line 214 of file xmlModule.py.

---

The documentation for this class was generated from the following file:

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r4/cmake/EnvConfig/xmlModule.py