Gaudi Framework, version v23r4

Home   Generated: Mon Sep 17 2012
Public Member Functions | Public Attributes

EnvConfig::xmlModule::Report Class Reference

List of all members.

Public Member Functions

def __init__
def addError
def addWarn
def addWarning
def addInfo
def clear
def closeFile
def numErrors
def numWarnings
def error
def warn

Public Attributes

 errors
 warns
 info
 warnings
 level
 reportOutput
 logger

Detailed Description

This class is used to catch errors and warnings from XML file processing to allow better managing and testing.

Definition at line 110 of file xmlModule.py.


Constructor & Destructor Documentation

def EnvConfig::xmlModule::Report::__init__ (   self,
  level = 1,
  reportOutput = False 
)

Definition at line 114 of file xmlModule.py.

00115                                                        :
00116         self.errors = []
00117         self.warns = []
00118         self.info = []
00119         self.warnings = []
00120         self.level = level
00121 
00122         if not reportOutput:
00123             self.reportOutput = False
00124         else:
00125             self.reportOutput = open(reportOutput, 'w')
00126 
00127         logConf = os.path.normpath(os.path.dirname(os.path.realpath(__file__)) + '/log.conf')
00128         if not logging.getLogger('envLogger').handlers and os.path.exists(logConf):
00129             logging.config.fileConfig(logConf)
00130         self.logger = logging.getLogger('envLogger')


Member Function Documentation

def EnvConfig::xmlModule::Report::addError (   self,
  message,
  varName = '',
  action = '',
  varValue = '',
  procedure = '' 
)

Definition at line 131 of file xmlModule.py.

00132                                                                                          :
00133         error = [message, varName, action, varValue, procedure]
00134         if self.level < 4:
00135             if not self.reportOutput:
00136                 print 'Error: ' + error[0]
00137             else:
00138                 self.reportOutput.write('Error: ' + error[0] + '\n')
00139         self.errors.append(error)
00140         self.logger.error(message)

def EnvConfig::xmlModule::Report::addInfo (   self,
  message,
  varName = '',
  action = '',
  varValue = '',
  procedure = '' 
)

Definition at line 161 of file xmlModule.py.

00162                                                                                         :
00163         error = [message, varName, action, varValue, procedure]
00164         if self.level < 3:
00165             if not self.reportOutput:
00166                 print 'Info: ' + error[0]
00167             else:
00168                 self.reportOutput.write('Info: ' + error[0] + '\n')
00169         self.warnings.append(error)
00170         self.logger.info(message)

def EnvConfig::xmlModule::Report::addWarn (   self,
  message,
  varName = '',
  action = '',
  varValue = '',
  procedure = '' 
)

Definition at line 141 of file xmlModule.py.

00142                                                                                         :
00143         error = [message, varName, action, varValue, procedure]
00144         if self.level < 1:
00145             if not self.reportOutput:
00146                 print 'Warn: ' + error[0]
00147             else:
00148                 self.reportOutput.write('Warn: ' + error[0] + '\n')
00149         self.warns.append(error)
00150         self.logger.warn(message)

def EnvConfig::xmlModule::Report::addWarning (   self,
  message,
  varName = '',
  action = '',
  varValue = '',
  procedure = '' 
)

Definition at line 151 of file xmlModule.py.

00152                                                                                            :
00153         error = [message, varName, action, varValue, procedure]
00154         if self.level < 2:
00155             if not self.reportOutput:
00156                 print 'Warning: ' + error[0]
00157             else:
00158                 self.reportOutput.write('Warning: ' + error[0] + '\n')
00159         self.warnings.append(error)
00160         self.logger.warning(message)

def EnvConfig::xmlModule::Report::clear (   self )

Definition at line 171 of file xmlModule.py.

00172                    :
00173         self.errors = []
00174         self.warns = []
00175         self.info = []
00176         self.warnings = []

def EnvConfig::xmlModule::Report::closeFile (   self )

Definition at line 177 of file xmlModule.py.

00178                        :
00179         if self.reportOutput:
00180             self.reportOutput.close()

def EnvConfig::xmlModule::Report::error (   self,
  key 
)

Definition at line 187 of file xmlModule.py.

00188                         :
00189         return self.errors[key]

def EnvConfig::xmlModule::Report::numErrors (   self )

Definition at line 181 of file xmlModule.py.

00182                        :
00183         return len(self.errors)

def EnvConfig::xmlModule::Report::numWarnings (   self )

Definition at line 184 of file xmlModule.py.

00185                          :
00186         return len(self.warns) + len(self.warnings)

def EnvConfig::xmlModule::Report::warn (   self,
  key 
)

Definition at line 190 of file xmlModule.py.

00191                        :
00192         return self.warns[key]
00193 


Member Data Documentation

Definition at line 114 of file xmlModule.py.

Definition at line 114 of file xmlModule.py.

Definition at line 114 of file xmlModule.py.

Definition at line 114 of file xmlModule.py.

Definition at line 114 of file xmlModule.py.

Definition at line 114 of file xmlModule.py.

Definition at line 114 of file xmlModule.py.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines

Generated at Mon Sep 17 2012 13:49:53 for Gaudi Framework, version v23r4 by Doxygen version 1.7.2 written by Dimitri van Heesch, © 1997-2004