From c46102c98a6866a76a448e504b25a2814a234dd8 Mon Sep 17 00:00:00 2001 From: Vinay Sajip Date: Fri, 8 Apr 2011 01:30:51 +0100 Subject: [PATCH] Updated Formatter documentation. --- Doc/library/logging.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst index e02556b8d67..b94951df172 100644 --- a/Doc/library/logging.rst +++ b/Doc/library/logging.rst @@ -405,7 +405,7 @@ The useful mapping keys in a :class:`LogRecord` are given in the section on :ref:`logrecord-attributes`. -.. class:: Formatter(fmt=None, datefmt=None) +.. class:: Formatter(fmt=None, datefmt=None, style='%') 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 @@ -413,6 +413,14 @@ The useful mapping keys in a :class:`LogRecord` are given in the section on specified, ``'%(message)s'`` is used. If no *datefmt* is specified, the ISO8601 date format is used. + 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`. + + .. versionchanged:: 3.2 + The *style* parameter was added. + + .. method:: format(record) The record's attribute dictionary is used as the operand to a string @@ -691,7 +699,6 @@ LoggerAdapter Objects information into logging calls. For a usage example , see the section on :ref:`adding contextual information to your logging output `. - .. class:: LoggerAdapter(logger, extra) Returns an instance of :class:`LoggerAdapter` initialized with an