diff options
author | Vinay Sajip <vinay_sajip@yahoo.co.uk> | 2009-01-02 18:53:04 (GMT) |
---|---|---|
committer | Vinay Sajip <vinay_sajip@yahoo.co.uk> | 2009-01-02 18:53:04 (GMT) |
commit | 511048673f8635b12f683eb9fc09f42c8ab871c7 (patch) | |
tree | 14a5bfdecbb970bc4ba28f1fcb86d99f0b02ce47 | |
parent | 0132ee34acb0a0da37b99fb8005a734cdbd17264 (diff) | |
download | cpython-511048673f8635b12f683eb9fc09f42c8ab871c7.zip cpython-511048673f8635b12f683eb9fc09f42c8ab871c7.tar.gz cpython-511048673f8635b12f683eb9fc09f42c8ab871c7.tar.bz2 |
Minor documentation changes relating to NullHandler, the module used for handlers and references to ConfigParser.
-rw-r--r-- | Doc/library/logging.rst | 57 |
1 files changed, 38 insertions, 19 deletions
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst index b34e7e4..1c6127f 100644 --- a/Doc/library/logging.rst +++ b/Doc/library/logging.rst @@ -1559,8 +1559,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` @@ -1616,11 +1614,32 @@ sends logging output to a disk file. It inherits the output functionality from Outputs the record to the file. +NullHandler +^^^^^^^^^^^ + +.. versionadded:: 2.7 + +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 ^^^^^^^^^^^^^^^^^^ .. versionadded:: 2.6 +.. 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. @@ -2304,12 +2323,12 @@ in :mod:`logging` itself) and defining handlers which are declared either in .. function:: fileConfig(fname[, defaults]) - Reads the logging configuration from a ConfigParser-format file named *fname*. - This function can be called several times from an application, allowing an end - user the ability to select from various pre-canned configurations (if the - developer provides a mechanism to present the choices and load the chosen - configuration). Defaults to be passed to ConfigParser can be specified in the - *defaults* argument. + Reads the logging configuration from a :mod:`ConfigParser`\-format file named + *fname*. This function can be called several times from an application, + allowing an end user the ability to select from various pre-canned + configurations (if the developer provides a mechanism to present the choices + and load the chosen configuration). Defaults to be passed to the ConfigParser + can be specified in the *defaults* argument. .. function:: listen([port]) @@ -2340,17 +2359,17 @@ Configuration file format ^^^^^^^^^^^^^^^^^^^^^^^^^ The configuration file format understood by :func:`fileConfig` is based on -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 -``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 configuration held in a section called -``[handler_hand01]``, while a formatter called ``form01`` in the -``[formatters]`` section will have its configuration specified in a section -called ``[formatter_form01]``. The root logger configuration must be specified -in a section called ``[logger_root]``. +: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 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 +configuration held in a section called ``[handler_hand01]``, while a formatter +called ``form01`` in the ``[formatters]`` section will have its configuration +specified in a section called ``[formatter_form01]``. The root logger +configuration must be specified in a section called ``[logger_root]``. Examples of these sections in the file are given below. :: |