mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 10:50:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

Minor documentation changes relating to NullHandler, the module used for handlers and references to ConfigParser.

Browse source
This commit is contained in:
Vinay Sajip 2009-01-02 18:53:04 +00:00
parent 0132ee34ac
commit 511048673f
1 changed files with 38 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

57
Doc/library/logging.rst
View file

@ -1559,8 +1559,6 @@ subclasses. However, the :meth:`__init__` method in subclasses needs to call
StreamHandler StreamHandler
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
.. module:: logging.handlers
The :class:`StreamHandler` class, located in the core :mod:`logging` package, The :class:`StreamHandler` class, located in the core :mod:`logging` package,
sends logging output to streams such as *sys.stdout*, *sys.stderr* or any 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` 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. 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 WatchedFileHandler
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^
.. versionadded:: 2.6 .. versionadded:: 2.6
.. module:: logging.handlers
The :class:`WatchedFileHandler` class, located in the :mod:`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 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. 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]) .. function:: fileConfig(fname[, defaults])
Reads the logging configuration from a ConfigParser-format file named *fname*. Reads the logging configuration from a :mod:`ConfigParser`\-format file named
This function can be called several times from an application, allowing an end *fname*. This function can be called several times from an application,
user the ability to select from various pre-canned configurations (if the allowing an end user the ability to select from various pre-canned
developer provides a mechanism to present the choices and load the chosen configurations (if the developer provides a mechanism to present the choices
configuration). Defaults to be passed to ConfigParser can be specified in the and load the chosen configuration). Defaults to be passed to the ConfigParser
*defaults* argument. can be specified in the *defaults* argument.
.. function:: listen([port]) .. function:: listen([port])
@ -2340,17 +2359,17 @@ Configuration file format
^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^
The configuration file format understood by :func:`fileConfig` is based on The configuration file format understood by :func:`fileConfig` is based on
ConfigParser functionality. The file must contain sections called ``[loggers]``, :mod:`ConfigParser` functionality. The file must contain sections called
``[handlers]`` and ``[formatters]`` which identify by name the entities of each ``[loggers]``, ``[handlers]`` and ``[formatters]`` which identify by name the
type which are defined in the file. For each such entity, there is a separate entities of each type which are defined in the file. For each such entity,
section which identified how that entity is configured. Thus, for a logger named there is a separate section which identifies how that entity is configured.
``log01`` in the ``[loggers]`` section, the relevant configuration details are Thus, for a logger named ``log01`` in the ``[loggers]`` section, the relevant
held in a section ``[logger_log01]``. Similarly, a handler called ``hand01`` in configuration details are held in a section ``[logger_log01]``. Similarly, a
the ``[handlers]`` section will have its configuration held in a section called handler called ``hand01`` in the ``[handlers]`` section will have its
``[handler_hand01]``, while a formatter called ``form01`` in the configuration held in a section called ``[handler_hand01]``, while a formatter
``[formatters]`` section will have its configuration specified in a section called ``form01`` in the ``[formatters]`` section will have its configuration
called ``[formatter_form01]``. The root logger configuration must be specified specified in a section called ``[formatter_form01]``. The root logger
in a section called ``[logger_root]``. configuration must be specified in a section called ``[logger_root]``.
Examples of these sections in the file are given below. :: Examples of these sections in the file are given below. ::