From: Vinay Sajip Date: Mon, 5 Sep 2022 07:21:22 +0000 (+0100) Subject: [3.10] gh-84095: Fill documentation gap regarding user-defined objects. (GH-… (GH... X-Git-Tag: v3.10.7~1 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e13f49a0bc253f1b8939fd505547986183761768;p=thirdparty%2FPython%2Fcpython.git [3.10] gh-84095: Fill documentation gap regarding user-defined objects. (GH-… (GH-96576) --- diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst index a1b8dc755ba6..88a835382300 100644 --- a/Doc/library/logging.config.rst +++ b/Doc/library/logging.config.rst @@ -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: @@ -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