EnvConfig::xmlModule::XMLFile Class Reference

List of all members.

Public Member Functions
def	__init__
def	variable
def	resetWriter
def	writeToFile
def	writeVar
Public Attributes
	xmlResult
	declaredVars
	logger
	doc

---

Detailed Description

Takes care of XML file operations such as reading and writing.

Definition at line 12 of file xmlModule.py.

---

Constructor & Destructor Documentation

def EnvConfig::xmlModule::XMLFile::__init__

(

self )

Definition at line 15 of file xmlModule.py.

                      :
        self.xmlResult = '<?xml version="1.0" encoding="UTF-8"?><env:config xmlns:env="EnvSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="EnvSchema ./EnvSchema.xsd ">\n'
        self.declaredVars = []
        logConf = os.path.normpath(os.path.dirname(os.path.realpath(__file__)) + '/log.conf')
        if not logging.getLogger('envLogger').handlers and os.path.exists(logConf):
            logging.config.fileConfig(logConf)
        self.logger = logging.getLogger('envLogger')

---

Member Function Documentation

def EnvConfig::xmlModule::XMLFile::resetWriter

(

self )

resets the buffer of writer

Definition at line 60 of file xmlModule.py.

                         :
        '''resets the buffer of writer'''
        self.xmlResult = '<?xml version="1.0" encoding="UTF-8"?><env:config xmlns:env="EnvSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="EnvSchema ./EnvSchema.xsd ">\n'
        self.declaredVars = []

def EnvConfig::xmlModule::XMLFile::variable	(		self,
			path,
			namespace = 'EnvSchema',
			name = ''
	)

Returns list containing name of variable, action and value

If no name given, returns list of lists of all variables and locals(instead of action 'local' is filled).

Definition at line 24 of file xmlModule.py.

                                                            :
        '''Returns list containing name of variable, action and value

        If no name given, returns list of lists of all variables and locals(instead of action 'local' is filled).
        '''
        if not os.path.isfile(path):
            raise IOError('No such file.')
        '''Get file'''
        self.doc = minidom.parse(path)
        if namespace == '':
            namespace = None

        '''Get all variables'''
        nodes = self.doc.getElementsByTagNameNS(namespace, "config")[0].childNodes
        variables = []
        nodeNum = 0
        for node in nodes:
            '''if it is an element node'''
            if node.nodeType == 1:
                nodeNum += 1
                if name != '':
                    if node.getAttribute('variable') != name:
                        continue

                if node.localName == 'declare':
                    variables.append([node.getAttribute('variable'), 'declare', node.getAttribute('type'), node.getAttribute('local'), nodeNum])
                else:
                    if len(node.childNodes) > 0:
                        value = node.childNodes[0].data
                    else:
                        value = ''
                    variables.append([node.getAttribute('variable'), node.localName, value, '' , nodeNum])

        return variables

def EnvConfig::xmlModule::XMLFile::writeToFile	(		self,
			outputFile = ''
	)

Finishes the XML input and writes XML to file.

Definition at line 65 of file xmlModule.py.

                                          :
        '''Finishes the XML input and writes XML to file.'''
        if(outputFile == ''):
            raise IOError("No output file given")
        self.xmlResult += '</env:config>'

        doc = minidom.parseString(self.xmlResult)
        with open(outputFile, "w") as f:
            f.write( doc.toxml() )

        f.close()
        return outputFile

def EnvConfig::xmlModule::XMLFile::writeVar	(		self,
			varName,
			action,
			value,
			type = 'list',
			local = 'false'
	)

Writes a action to a file. Declare undeclared elements (not local List is default type).

Definition at line 78 of file xmlModule.py.

                                                                          :
        '''Writes a action to a file. Declare undeclared elements (not local List is default type).'''
        if action == 'declare':
            self.xmlResult += '<env:declare variable="'+varName+'" type="'+ type.lower() +'" local="'+(str(local)).lower()+'" />\n'
            self.declaredVars.append(varName)
            return

        if varName not in self.declaredVars:
            self.xmlResult += '<env:declare variable="'+varName+'" type="'+ type +'" local="'+(str(local)).lower()+'" />\n'
            self.declaredVars.append(varName)
        self.xmlResult += '<env:'+action+' variable="'+ varName +'">'+value+'</env:'+action+'>\n'

---

Member Data Documentation

EnvConfig::xmlModule::XMLFile::declaredVars

Definition at line 15 of file xmlModule.py.

EnvConfig::xmlModule::XMLFile::doc

Definition at line 27 of file xmlModule.py.

EnvConfig::xmlModule::XMLFile::logger

Definition at line 15 of file xmlModule.py.

EnvConfig::xmlModule::XMLFile::xmlResult

Definition at line 15 of file xmlModule.py.

---

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

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