Gaudi Framework, version v23r3

Home   Generated: Thu Jun 28 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.
Sequence of levels: warn - warning - info - error

Definition at line 91 of file xmlModule.py.


Constructor & Destructor Documentation

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

Definition at line 95 of file xmlModule.py.

00096                                                        :
00097         self.errors = []
00098         self.warns = []
00099         self.info = []
00100         self.warnings = []
00101         self.level = level
00102 
00103         if not reportOutput:
00104             self.reportOutput = False
00105         else:
00106             self.reportOutput = open(reportOutput, 'w')
00107 
00108         logConf = os.path.normpath(os.path.dirname(os.path.realpath(__file__)) + '/log.conf')
00109         if not logging.getLogger('envLogger').handlers and os.path.exists(logConf):
00110             logging.config.fileConfig(logConf)
00111         self.logger = logging.getLogger('envLogger')


Member Function Documentation

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

Definition at line 112 of file xmlModule.py.

00113                                                                                          :
00114         error = [message, varName, action, varValue, procedure]
00115         if self.level < 4:
00116             if not self.reportOutput:
00117                 print 'Error: ' + error[0]
00118             else:
00119                 self.reportOutput.write('Error: ' + error[0] + '\n')
00120         self.errors.append(error)
00121         self.logger.error(message)

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

Definition at line 142 of file xmlModule.py.

00143                                                                                         :
00144         error = [message, varName, action, varValue, procedure]
00145         if self.level < 3:
00146             if not self.reportOutput:
00147                 print 'Info: ' + error[0]
00148             else:
00149                 self.reportOutput.write('Info: ' + error[0] + '\n')
00150         self.warnings.append(error)
00151         self.logger.info(message)

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

Definition at line 122 of file xmlModule.py.

00123                                                                                         :
00124         error = [message, varName, action, varValue, procedure]
00125         if self.level < 1:
00126             if not self.reportOutput:
00127                 print 'Warn: ' + error[0]
00128             else:
00129                 self.reportOutput.write('Warn: ' + error[0] + '\n')
00130         self.warns.append(error)
00131         self.logger.warn(message)

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

Definition at line 132 of file xmlModule.py.

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

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

Definition at line 152 of file xmlModule.py.

00153                    :
00154         self.errors = []
00155         self.warns = []
00156         self.info = []
00157         self.warnings = []

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

Definition at line 158 of file xmlModule.py.

00159                        :
00160         if self.reportOutput:
00161             self.reportOutput.close()

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

Definition at line 168 of file xmlModule.py.

00169                         :
00170         return self.errors[key]

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

Definition at line 162 of file xmlModule.py.

00163                        :
00164         return len(self.errors)

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

Definition at line 165 of file xmlModule.py.

00166                          :
00167         return len(self.warns) + len(self.warnings)

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

Definition at line 171 of file xmlModule.py.

00172                        :
00173         return self.warns[key]
00174 


Member Data Documentation

Definition at line 95 of file xmlModule.py.

Definition at line 95 of file xmlModule.py.

Definition at line 95 of file xmlModule.py.

Definition at line 95 of file xmlModule.py.

Definition at line 95 of file xmlModule.py.

Definition at line 95 of file xmlModule.py.

Definition at line 95 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 Thu Jun 28 2012 12:30:18 for Gaudi Framework, version v23r3 by Doxygen version 1.7.2 written by Dimitri van Heesch, © 1997-2004