summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2009-01-15 22:48:13 (GMT)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2009-01-15 22:48:13 (GMT)
commitb5902e6054c037851b73273a7eb14eb89b47353d (patch)
treef2482edf95718dea8171196909fddfc47cacc716 /Doc
parent4f69b7e33be14ecec2ecb43a63d23662a9be81e1 (diff)
downloadcpython-b5902e6054c037851b73273a7eb14eb89b47353d.zip
cpython-b5902e6054c037851b73273a7eb14eb89b47353d.tar.gz
cpython-b5902e6054c037851b73273a7eb14eb89b47353d.tar.bz2
Made minor changes/corrections in markup. Added a couple of section headings.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/logging.rst50
1 files changed, 29 insertions, 21 deletions
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index 5a700c7..1ea76f1 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -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.