Gaudi Framework, version v23r7

Home   Generated: Wed Mar 20 2013
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
EnvConfig.xmlModule.Report Class Reference

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 129 of file xmlModule.py.

Constructor & Destructor Documentation

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

Definition at line 133 of file xmlModule.py.

134  def __init__(self, level = 1, reportOutput = False):
135  self.errors = []
136  self.warns = []
137  self.info = []
138  self.warnings = []
139  self.level = level
140 
141  if not reportOutput:
142  self.reportOutput = None
143  else:
144  self.reportOutput = open(reportOutput, 'w')
145 
146  logConf = os.path.normpath(os.path.dirname(os.path.realpath(__file__)) + '/log.conf')
147  if not logging.getLogger('envLogger').handlers and os.path.exists(logConf):
148  logging.config.fileConfig(logConf)
149  self.logger = logging.getLogger('envLogger')

Member Function Documentation

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

Definition at line 150 of file xmlModule.py.

151  def addError(self, message, varName = '', action = '', varValue = '', procedure = ''):
152  error = [message, varName, action, varValue, procedure]
153  if self.level < 4:
154  if not self.reportOutput:
155  print 'Error: ' + error[0]
156  else:
157  self.reportOutput.write('Error: ' + error[0] + '\n')
158  self.errors.append(error)
159  self.logger.error(message)
def EnvConfig.xmlModule.Report.addInfo (   self,
  message,
  varName = '',
  action = '',
  varValue = '',
  procedure = '' 
)

Definition at line 180 of file xmlModule.py.

181  def addInfo(self, message, varName = '', action = '', varValue = '', procedure = ''):
182  error = [message, varName, action, varValue, procedure]
183  if self.level < 3:
184  if not self.reportOutput:
185  print 'Info: ' + error[0]
186  else:
187  self.reportOutput.write('Info: ' + error[0] + '\n')
188  self.warnings.append(error)
189  self.logger.info(message)
def EnvConfig.xmlModule.Report.addWarn (   self,
  message,
  varName = '',
  action = '',
  varValue = '',
  procedure = '' 
)

Definition at line 160 of file xmlModule.py.

161  def addWarn(self, message, varName = '', action = '', varValue = '', procedure = ''):
162  error = [message, varName, action, varValue, procedure]
163  if self.level < 1:
164  if not self.reportOutput:
165  print 'Warn: ' + error[0]
166  else:
167  self.reportOutput.write('Warn: ' + error[0] + '\n')
168  self.warns.append(error)
169  self.logger.warn(message)
def EnvConfig.xmlModule.Report.addWarning (   self,
  message,
  varName = '',
  action = '',
  varValue = '',
  procedure = '' 
)

Definition at line 170 of file xmlModule.py.

171  def addWarning(self, message, varName = '', action = '', varValue = '', procedure = ''):
172  error = [message, varName, action, varValue, procedure]
173  if self.level < 2:
174  if not self.reportOutput:
175  print 'Warning: ' + error[0]
176  else:
177  self.reportOutput.write('Warning: ' + error[0] + '\n')
178  self.warnings.append(error)
179  self.logger.warning(message)
def EnvConfig.xmlModule.Report.clear (   self)

Definition at line 190 of file xmlModule.py.

191  def clear(self):
192  self.errors = []
193  self.warns = []
194  self.info = []
195  self.warnings = []
def EnvConfig.xmlModule.Report.closeFile (   self)

Definition at line 196 of file xmlModule.py.

197  def closeFile(self):
198  if self.reportOutput:
199  self.reportOutput.close()
def EnvConfig.xmlModule.Report.error (   self,
  key 
)

Definition at line 206 of file xmlModule.py.

207  def error(self, key):
208  return self.errors[key]
def EnvConfig.xmlModule.Report.numErrors (   self)

Definition at line 200 of file xmlModule.py.

201  def numErrors(self):
202  return len(self.errors)
def EnvConfig.xmlModule.Report.numWarnings (   self)

Definition at line 203 of file xmlModule.py.

204  def numWarnings(self):
205  return len(self.warns) + len(self.warnings)
def EnvConfig.xmlModule.Report.warn (   self,
  key 
)

Definition at line 209 of file xmlModule.py.

210  def warn(self, key):
211  return self.warns[key]
212 

Member Data Documentation

EnvConfig.xmlModule.Report.errors

Definition at line 134 of file xmlModule.py.

EnvConfig.xmlModule.Report.info

Definition at line 136 of file xmlModule.py.

EnvConfig.xmlModule.Report.level

Definition at line 138 of file xmlModule.py.

EnvConfig.xmlModule.Report.logger

Definition at line 148 of file xmlModule.py.

EnvConfig.xmlModule.Report.reportOutput

Definition at line 141 of file xmlModule.py.

EnvConfig.xmlModule.Report.warnings

Definition at line 137 of file xmlModule.py.

EnvConfig.xmlModule.Report.warns

Definition at line 135 of file xmlModule.py.


The documentation for this class was generated from the following file:
Generated at Wed Mar 20 2013 17:59:48 for Gaudi Framework, version v23r7 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004