Skip to content

[3.10] gh-84095: Fill documentation gap regarding user-defined objects. (GH-… (GH-96576) #96576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vsajip merged 2 commits into from
Sep 5, 2022
Merged

[3.10] gh-84095: Fill documentation gap regarding user-defined objects. (GH-… (GH-96576) #96576

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24b3d02
gh-84095: Fill documentation gap regarding user-defined objects. (GH-…
vsajip Sep 5, 2022
6a2e357
Undo error introduced during merge.
vsajip Sep 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion Doc/library/logging.config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,6 +524,25 @@ 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
mnemonic that the corresponding value is a callable.

You can also specify a special key ``'.'`` whose value is a dictionary is a
mapping of attribute names to values. If found, the specified attributes will
be set on the user-defined object before it is returned. Thus, with the
following configuration::

{
'()' : 'my.package.customFormatterFactory',
'bar' : 'baz',
'spam' : 99.9,
'answer' : 42,
'.' {
'foo': 'bar',
'baz': 'bozz'
}
}

the returned formatter will have attribute ``foo`` set to ``'bar'`` and
attribute ``baz`` set to ``'bozz'``.


.. _logging-config-dict-externalobj:

Expand Down Expand Up @@ -823,7 +842,7 @@ Sections which specify formatter configuration are typified by the following.
[formatter_form01]
format=F1 %(asctime)s %(levelname)s %(message)s
datefmt=
style='%'
style=%
validate=True
class=logging.Formatter

Expand Down