summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2015-04-18 12:05:19 (GMT)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2015-04-18 12:05:19 (GMT)
commit1b4aa45441bccb350887add4cbef4fd73680eef0 (patch)
tree92eb3da7d96e2866ad5c138e920704384fa63b4b /Doc
parentabb7e6504291506fee695ad56a642d0dea6370e4 (diff)
downloadcpython-1b4aa45441bccb350887add4cbef4fd73680eef0.zip
cpython-1b4aa45441bccb350887add4cbef4fd73680eef0.tar.gz
cpython-1b4aa45441bccb350887add4cbef4fd73680eef0.tar.bz2
Issue #23536: Clarified scope of fileConfig()'s API.
Diffstat (limited to 'Doc')
-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 fddb644..5460c3a 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -580,6 +580,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]