logging.Handler

Package logging :: Class Handler

[show private | hide private]

Class Handler

Filterer --+
           |
          Handler

Known Subclasses:: Handler, Handler

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.

Method Summary
	`__init__(self, level)` Initializes the instance - basically setting the formatter to None and the filter list to empty.
	`acquire(self)` Acquire the I/O thread lock.
	`close(self)` Tidy up any resources used by the handler.
	`createLock(self)` Acquire a thread lock for serializing access to the underlying I/O.
	`emit(self, record)` Do whatever it takes to actually log the specified logging record.
	`flush(self)` Ensure all logging output has been flushed.
	`format(self, record)` Format the specified record.
	`handle(self, record)` Conditionally emit the specified logging record.
	`handleError(self, record)` Handle errors which occur during an emit() call.
	`release(self)` Release the I/O thread lock.
	`setFormatter(self, fmt)` Set the formatter for this handler.
	`setLevel(self, level)` Set the logging level of this handler.
Inherited from Filterer
	`addFilter(self, filter)` Add the specified filter to this handler.
	`filter(self, record)` Determine if a record is loggable by consulting all the filters.
	`removeFilter(self, filter)` Remove the specified filter from this handler.

Method Details

init(self, level=0)
(Constructor)

Initializes the instance - basically setting the formatter to None and the filter list to empty.

Overrides:: logging.Filterer.__init__

acquire(self)

Acquire the I/O thread lock.

close(self)

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.

createLock(self)

Acquire a thread lock for serializing access to the underlying I/O.

emit(self, record)

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)

Ensure all logging output has been flushed.

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

format(self, record)

Format the specified record.

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

handle(self, record)

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)

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.

release(self)

Release the I/O thread lock.

setFormatter(self, fmt)

Set the formatter for this handler.

setLevel(self, level)

Set the logging level of this handler.

Generated by Epydoc 2.1 on Fri Jun 24 12:01:22 2005

http://epydoc.sf.net