From aa672ebe49cbb58a2c8b384955af7b5c792801af Mon Sep 17 00:00:00 2001 From: Vinay Sajip Date: Fri, 2 Jan 2009 18:53:45 +0000 Subject: Minor documentation changes relating to NullHandler, the module used for handlers and references to ConfigParser. --- Doc/library/logging.rst | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst index df857b1..c0c13fa 100644 --- a/Doc/library/logging.rst +++ b/Doc/library/logging.rst @@ -1534,8 +1534,6 @@ subclasses. However, the :meth:`__init__` method in subclasses needs to call StreamHandler ^^^^^^^^^^^^^ -.. module:: logging.handlers - The :class:`StreamHandler` class, located in the core :mod:`logging` package, sends logging output to streams such as *sys.stdout*, *sys.stderr* or any file-like object (or, more precisely, any object which supports :meth:`write` @@ -1591,9 +1589,30 @@ sends logging output to a disk file. It inherits the output functionality from Outputs the record to the file. +NullHandler +^^^^^^^^^^^ + +.. versionadded:: 3.1 + +The :class:`NullHandler` class, located in the core :mod:`logging` package, +does not do any formatting or output. It is essentially a "no-op" handler +for use by library developers. + + +.. class:: NullHandler() + + Returns a new instance of the :class:`NullHandler` class. + + + .. method:: emit(record) + + This method does nothing. + WatchedFileHandler ^^^^^^^^^^^^^^^^^^ +.. module:: logging.handlers + The :class:`WatchedFileHandler` class, located in the :mod:`logging.handlers` module, is a :class:`FileHandler` which watches the file it is logging to. If the file changes, it is closed and reopened using the file name. @@ -2306,7 +2325,7 @@ based on :mod:`configparser` functionality. The file must contain sections called ``[loggers]``, ``[handlers]`` and ``[formatters]`` which identify by name the entities of each type which are defined in the file. For each such entity, there is a separate section which -identified how that entity is configured. Thus, for a logger named +identifies how that entity is configured. Thus, for a logger named ``log01`` in the ``[loggers]`` section, the relevant configuration details are held in a section ``[logger_log01]``. Similarly, a handler called ``hand01`` in the ``[handlers]`` section will have its -- cgit v0.12