[Python-checkins] [doc] Add some notices to logging configuration documentation. (GH-101373)
vsajip
webhook-mailer at python.org
Fri Jan 27 09:50:16 EST 2023
https://github.com/python/cpython/commit/d083df39fa61dc27b3c22a7bc06a71e95b718fa3
commit: d083df39fa61dc27b3c22a7bc06a71e95b718fa3
branch: main
author: Vinay Sajip <vinay_sajip at yahoo.co.uk>
committer: vsajip <vinay_sajip at yahoo.co.uk>
date: 2023-01-27T14:50:09Z
summary:
[doc] Add some notices to logging configuration documentation. (GH-101373)
files:
M Doc/library/logging.config.rst
diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst
index 9b82c1f75e3f..b4d0da1421dc 100644
--- a/Doc/library/logging.config.rst
+++ b/Doc/library/logging.config.rst
@@ -525,6 +525,11 @@ returned by the call::
my.package.customFormatterFactory(bar='baz', spam=99.9, answer=42)
+.. warning:: The values for keys such as ``bar``, ``spam`` and ``answer`` in
+ the above example should not be configuration dictionaries or references such
+ as ``cfg://foo`` or ``ext://bar``, because they will not be processed by the
+ configuration machinery, but passed to the callable as-is.
+
The key ``'()'`` has been used as the special key because it is not a
valid keyword parameter name, and so will not clash with the names of
the keyword arguments used in the call. The ``'()'`` also serves as a
@@ -553,6 +558,11 @@ following configuration::
the returned formatter will have attribute ``foo`` set to ``'bar'`` and
attribute ``baz`` set to ``'bozz'``.
+.. warning:: The values for attributes such as ``foo`` and ``baz`` in
+ the above example should not be configuration dictionaries or references such
+ as ``cfg://foo`` or ``ext://bar``, because they will not be processed by the
+ configuration machinery, but set as attribute values as-is.
+
.. _logging-config-dict-externalobj:
More information about the Python-checkins
mailing list