[Python-checkins] cpython (3.4): Issue #23536: Clarified scope of fileConfig()'s API.

[vinay.sajip]

https://hg.python.org/cpython/rev/968c086bf6cc
changeset:   95706:968c086bf6cc
branch:      3.4
parent:      95687:2d8e4047c270
user:        Vinay Sajip <vinay_sajip at yahoo.co.uk>
date:        Sat Apr 18 13:14:10 2015 +0100
summary:
  Issue #23536: Clarified scope of fileConfig()'s API.

files:
  Doc/library/logging.config.rst |  12 ++++++++++++
  1 files changed, 12 insertions(+), 0 deletions(-)


diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -615,6 +615,18 @@
 specified in a section called ``[formatter_form01]``. The root logger
 configuration must be specified in a section called ``[logger_root]``.
 
+.. note::
+
+   The :func:`fileConfig` API is older than the :func:`dictConfig` API and does
+   not provide functionality to cover certain aspects of logging. For example,
+   you cannot configure :class:`~logging.Filter` objects, which provide for
+   filtering of messages beyond simple integer levels, using :func:`fileConfig`.
+   If you need to have instances of :class:`~logging.Filter` in your logging
+   configuration, you will need to use :func:`dictConfig`. Note that future
+   enhancements to configuration functionality will be added to
+   :func:`dictConfig`, so it's worth considering transitioning to this newer
+   API when it's convenient to do so.
+
 Examples of these sections in the file are given below. ::
 
    [loggers]

-- 
Repository URL: https://hg.python.org/cpython