summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2015-04-18 12:14:10 (GMT)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2015-04-18 12:14:10 (GMT)
commit2d965c255543695494463427a484389b11e6b730 (patch)
treec87b0069b230036e7bc615524982a60302bc2be0 /Doc/library
parent6a69466f6173adcebb1c6bb54c0e43b92d26eff7 (diff)
downloadcpython-2d965c255543695494463427a484389b11e6b730.zip
cpython-2d965c255543695494463427a484389b11e6b730.tar.gz
cpython-2d965c255543695494463427a484389b11e6b730.tar.bz2
Issue #23536: Clarified scope of fileConfig()'s API.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/logging.config.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index 180569b..fd6a477 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -615,6 +615,18 @@ 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]``.
+.. 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]