summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2015-04-18 13:15:10 +0100
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2015-04-18 13:15:10 +0100
commit1a16a8340a00f30fa9bb060319cd6fbb80cf2435 (patch)
treeaf57bacf0bd76d8e95fa9b10ef720be564ea71c2
parent4e25913f9fa6c5f67c4591459a8eed2db4178367 (diff)
parent2d965c255543695494463427a484389b11e6b730 (diff)
downloadcpython-git-1a16a8340a00f30fa9bb060319cd6fbb80cf2435.tar.gz
Closes #23536: Clarified scope of fileConfig()'s API.
-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 180569b210..fd6a47778f 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]