Trees       Indices       Help   
kernel
Module EDVerbose :: Class EDVerbose
[hide private]
[frames] | no frames]

Class EDVerbose

source code

object --+
         |
        EDVerbose

This class is meant to be used statically for all logging purposes in the EDNA framework.

All methods are thread safe.

Instance Methods [hide private]

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]
 
setTestOn()
turn on the test mode: all assertions become verbose (->screen)		 source code
 
setTestOff()
turn off the test mode: all assertions become silent (->screen)		 source code
 
setVerboseOn()
This method turns on verbose logging to standard output (stdout)		 source code
 
setVerboseOff()
This method turns off verbose logging to standard output (stdout)		 source code
 
setVerboseDebugOn()
This method turns on debug messages to standard output and log file		 source code
 
setVerboseDebugOff()
This method turns off debug messages to standard output and log file		 source code
 
isVerboseDebug()
This method returns the current status of debugging		 source code
 
log(_strMessage='')
This method writes a message only to the log file.		 source code
 
screen(_strMessage='')
This method writes a message to standard output and to the log file.		 source code
 
DEBUG(_strDebugMessage='')
This method writes a debug message to standard output and to the log file if debugging is enabled.		 source code
 
unitTest(_strMessage='')
This method is meant to be used by the testing framework.		 source code
 
ERROR(_strMessage='')
This method writes a message to standard error and the log file with the prefix [ERROR].		 source code
 
error(_strMessage='')
This method writes a message to standard error and the log file with the prefix [ERROR].		 source code
 
WARNING(_strMessage='')
This method writes a warning message to standard output and the log file with the prefix [Warning].		 source code
 
warning(_strMessage='')
This method writes a warning message to standard output and the log file with the prefix [Warning].		 source code
 
ASSERT(_strMessage)
This method writes an assert message to standard output and the log file with the prefix [ASSERT].		 source code
 
writeErrorTrace(_strPrefix=' ')
This method writes an error trace to standard output and the log file.		 source code
 
setLogFileName(_strLogFileName)
This method can be used for customising the file name of the log file.		 source code
 
setLogFileOff()
This method truns off output to the log file.		 source code
Class Variables [hide private]
  __edLogging = EDLogging("EDVerbose")
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

isVerboseDebug()
Static Method

source code 

This method returns the current status of debugging

Returns:
if debug output to standard output and log file is enabled.

log(_strMessage='')
Static Method

source code 

This method writes a message only to the log file.

Parameters:
  • _strMessage (python string) - The string to be written to the log file

screen(_strMessage='')
Static Method

source code 

This method writes a message to standard output and to the log file.

Parameters:
  • _strMessage (python string) - The string to be written to the log file

DEBUG(_strDebugMessage='')
Static Method

source code 

This method writes a debug message to standard output and to the log file if debugging is enabled. The message will be written with the prefix [DEBUG]

Parameters:
  • _strDebugMessage (python string) - The debug message to be written to standard output and log file

unitTest(_strMessage='')
Static Method

source code 

This method is meant to be used by the testing framework. The message will be written to standard output and the log file with the prefix [UnitTest]

Parameters:
  • _strMessage (python string) - The message to be written to standard output and log file

ERROR(_strMessage='')
Static Method

source code 

This method writes a message to standard error and the log file with the prefix [ERROR].

Parameters:
  • _strMessage (python string) - The error message to be written to standard output and log file

error(_strMessage='')
Static Method

source code 

This method writes a message to standard error and the log file with the prefix [ERROR].

Parameters:
  • _strMessage (python string) - The error message to be written to standard output and log file

WARNING(_strMessage='')
Static Method

source code 

This method writes a warning message to standard output and the log file with the prefix [Warning].

Parameters:
  • _strMessage (python string) - The error message to be written to standard output and log file

warning(_strMessage='')
Static Method

source code 

This method writes a warning message to standard output and the log file with the prefix [Warning].

Parameters:
  • _strMessage (python string) - The error message to be written to standard output and log file

ASSERT(_strMessage)
Static Method

source code 

This method writes an assert message to standard output and the log file with the prefix [ASSERT].

Parameters:
  • _strMessage (python string) - The error message to be written to standard output and log file

writeErrorTrace(_strPrefix=' ')
Static Method

source code 

This method writes an error trace to standard output and the log file. The error trace has the same formatting as normal Python error traces.

Parameters:
  • _strPrefix (python string) - A prefix which can be customized, e.g. the testing framework uses ' [UnitTest]'

setLogFileName(_strLogFileName)
Static Method

source code 

This method can be used for customising the file name of the log file.

Parameters:
  • _strLogFileName (python string) - A file name for the log file.

   Trees       Indices       Help   
kernel
Generated by Epydoc 3.0.1 on Fri Jun 20 03:53:31 2014 http://epydoc.sourceforge.net