mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[doc] Add some notices to logging configuration documentation. (GH-101373)

This commit is contained in:
Vinay Sajip 2023-01-27 14:50:09 +00:00 committed by GitHub
parent 737d367b1f
commit d083df39fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Doc/library/logging.config.rst
View File

@ -525,6 +525,11 @@ returned by the call::
my.package.customFormatterFactory(bar='baz', spam=99.9, answer=42) 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 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 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 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 the returned formatter will have attribute ``foo`` set to ``'bar'`` and
attribute ``baz`` set to ``'bozz'``. 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: .. _logging-config-dict-externalobj: