traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

logging.Formatter docs: Add missing `validate` parameter, clarify `style` parameter (GH-15222)

This commit is contained in:
David Röthlisberger 2019-09-09 12:29:54 +01:00 committed by Vinay Sajip
parent 9d607061c9
commit 4f0f9f066e
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Doc/library/logging.rst
View File

@ -528,7 +528,7 @@ The useful mapping keys in a :class:`LogRecord` are given in the section on
:ref:`logrecord-attributes`.
.. class:: Formatter(fmt=None, datefmt=None, style='%')
.. class:: Formatter(fmt=None, datefmt=None, style='%', validate=True)
Returns a new instance of the :class:`Formatter` class. The instance is
initialized with a format string for the message as a whole, as well as a
@ -538,8 +538,11 @@ The useful mapping keys in a :class:`LogRecord` are given in the section on
The *style* parameter can be one of '%', '{' or '$' and determines how
the format string will be merged with its data: using one of %-formatting,
:meth:`str.format` or :class:`string.Template`. See :ref:`formatting-styles`
for more information on using {- and $-formatting for log messages.
:meth:`str.format` or :class:`string.Template`. This only applies to the
format string *fmt* (e.g. ``'%(message)s'`` or ``{message}``), not to the
actual log messages passed to ``Logger.debug`` etc; see
:ref:`formatting-styles` for more information on using {- and $-formatting
for log messages.
.. versionchanged:: 3.2
The *style* parameter was added.