A handler class which writes logging records, appropriately formatted, to a stream. Note that this class does not close the stream, as sys.stdout or sys.stderr may be used.
There are no implemented interfaces.
There are no attributes in this class.
acquire()
Acquire the I/O thread lock.
addFilter(filter)
Add the specified filter to this handler.
close()
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()
Acquire a thread lock for serializing access to the underlying I/O.
emit(record)
Emit a record.
If a formatter is specified, it is used to format the record. The record is then written to the stream with a trailing newline [N.B. this may be removed depending on feedback]. If exception information is present, it is formatted using traceback.print_exception and appended to the stream.
filter(record)
Determine if a record is loggable by consulting all the filters.
The default is to allow the record to be logged; any filter can veto this and the record is then dropped. Returns a zero value if a record is to be dropped, else non-zero.
flush()
Flushes the stream.
format(record)
Format the specified record.
If a formatter is set, use it. Otherwise, use the default formatter for the module.
handle(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(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()
Release the I/O thread lock.
removeFilter(filter)
Remove the specified filter from this handler.
setFormatter(fmt)
Set the formatter for this handler.
setLevel(level)
Set the logging level of this handler.