Made minor changes/corrections in markup. Added a couple of section headings.

This commit is contained in:
Vinay Sajip 2009-01-15 22:48:13 +00:00
parent 4f69b7e33b
commit b5902e6054
1 changed files with 29 additions and 21 deletions

View File

@ -524,6 +524,9 @@ decides to actually dispatch an event, the :meth:`emit` method is used to send
the message to its destination. Most user-defined subclasses of :class:`Handler`
will need to override this :meth:`emit`.
Useful Handlers
---------------
In addition to the base :class:`Handler` class, many useful subclasses are
provided:
@ -532,40 +535,42 @@ provided:
#. :class:`FileHandler` instances send error messages to disk files.
#. :class:`handlers.BaseRotatingHandler` is the base class for handlers that
#. :class:`BaseRotatingHandler` is the base class for handlers that
rotate log files at a certain point. It is not meant to be instantiated
directly. Instead, use :class:`RotatingFileHandler` or
:class:`TimedRotatingFileHandler`.
#. :class:`handlers.RotatingFileHandler` instances send error messages to disk files,
with support for maximum log file sizes and log file rotation.
#. :class:`RotatingFileHandler` instances send error messages to disk
files, with support for maximum log file sizes and log file rotation.
#. :class:`handlers.TimedRotatingFileHandler` instances send error messages to disk files
rotating the log file at certain timed intervals.
#. :class:`TimedRotatingFileHandler` instances send error messages to
disk files, rotating the log file at certain timed intervals.
#. :class:`handlers.SocketHandler` instances send error messages to TCP/IP sockets.
#. :class:`SocketHandler` instances send error messages to TCP/IP
sockets.
#. :class:`handlers.DatagramHandler` instances send error messages to UDP sockets.
#. :class:`DatagramHandler` instances send error messages to UDP
sockets.
#. :class:`handlers.SMTPHandler` instances send error messages to a designated email
address.
#. :class:`SMTPHandler` instances send error messages to a designated
email address.
#. :class:`handlers.SysLogHandler` instances send error messages to a Unix syslog daemon,
possibly on a remote machine.
#. :class:`SysLogHandler` instances send error messages to a Unix
syslog daemon, possibly on a remote machine.
#. :class:`handlers.NTEventLogHandler` instances send error messages to a Windows
NT/2000/XP event log.
#. :class:`NTEventLogHandler` instances send error messages to a
Windows NT/2000/XP event log.
#. :class:`handlers.MemoryHandler` instances send error messages to a buffer in memory,
which is flushed whenever specific criteria are met.
#. :class:`MemoryHandler` instances send error messages to a buffer
in memory, which is flushed whenever specific criteria are met.
#. :class:`handlers.HTTPHandler` instances send error messages to an HTTP server using
either ``GET`` or ``POST`` semantics.
#. :class:`HTTPHandler` instances send error messages to an HTTP
server using either ``GET`` or ``POST`` semantics.
#. :class:`handlers.WatchedFileHandler` instances watch the file they are logging to. If
the file changes, it is closed and reopened using the file name. This handler
is only useful on Unix-like systems; Windows does not support the underlying
mechanism used.
#. :class:`WatchedFileHandler` instances watch the file they are
logging to. If the file changes, it is closed and reopened using the file
name. This handler is only useful on Unix-like systems; Windows does not
support the underlying mechanism used.
#. :class:`NullHandler` instances do nothing with error messages. They are used
by library developers who want to use logging, but want to avoid the "No
@ -602,6 +607,9 @@ The basic :class:`Filter` functionality allows filtering by specific logger
name. If this feature is used, messages sent to the named logger and its
children are allowed through the filter, and all others dropped.
Module-Level Functions
----------------------
In addition to the classes described above, there are a number of module- level
functions.