Trees       Indices       Help   
Zenoss
logging :: Handler :: Class Handler
[hide private]
[frames] | no frames]

Class Handler

source code

Filterer --+
           |
          Handler
Known Subclasses:
StreamHandler

Handler instances dispatch logging events to specific destinations.

The base handler class. Acts as a placeholder which defines the Handler interface. Handlers can optionally use Formatter instances to format records as desired. By default, no formatter is specified; in this case, the 'raw' message as determined by record.message is logged.

Instance Methods [hide private]
 
__init__(self, level=0)
Initializes the instance - basically setting the formatter to None and the filter list to empty.		 source code
 
acquire(self)
Acquire the I/O thread lock.		 source code
 
close(self)
Tidy up any resources used by the handler.		 source code
 
createLock(self)
Acquire a thread lock for serializing access to the underlying I/O.		 source code
 
emit(self, record)
Do whatever it takes to actually log the specified logging record.		 source code
 
flush(self)
Ensure all logging output has been flushed.		 source code
 
format(self, record)
Format the specified record.		 source code
 
handle(self, record)
Conditionally emit the specified logging record.		 source code
 
handleError(self, record)
Handle errors which occur during an emit() call.		 source code
 
release(self)
Release the I/O thread lock.		 source code
 
setFormatter(self, fmt)
Set the formatter for this handler.		 source code
 
setLevel(self, level)
Set the logging level of this handler.		 source code

Inherited from Filterer: addFilter, filter, removeFilter

Method Details [hide private]

__init__(self, level=0)
(Constructor)

source code 
Initializes the instance - basically setting the formatter to None and the filter list to empty.
Overrides: Filterer.__init__

close(self)

source code 

Tidy up any resources used by the handler.

This version does removes the handler from an internal list of handlers which is closed when shutdown() is called. Subclasses should ensure that this gets called from overridden close() methods.

emit(self, record)

source code 

Do whatever it takes to actually log the specified logging record.

This version is intended to be implemented by subclasses and so raises a NotImplementedError.

flush(self)

source code 

Ensure all logging output has been flushed.

This version does nothing and is intended to be implemented by subclasses.

format(self, record)

source code 

Format the specified record.

If a formatter is set, use it. Otherwise, use the default formatter for the module.

handle(self, record)

source code 

Conditionally emit the specified logging record.

Emission depends on filters which may have been added to the handler. Wrap the actual emission of the record with acquisition/release of the I/O thread lock. Returns whether the filter passed the record for emission.

handleError(self, record)

source code 

Handle errors which occur during an emit() call.

This method should be called from handlers when an exception is encountered during an emit() call. If raiseExceptions is false, exceptions get silently ignored. This is what is mostly wanted for a logging system - most users will not care about errors in the logging system, they are more interested in application errors. You could, however, replace this with a custom handler if you wish. The record which was being processed is passed in to this method.

   Trees       Indices       Help   
Zenoss
Generated by Epydoc 3.0beta1 on Thu Oct 25 16:28:17 2007 http://epydoc.sourceforge.net