]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Updated Formatter documentation.
authorVinay Sajip <vinay_sajip@yahoo.co.uk>
Fri, 8 Apr 2011 00:30:51 +0000 (01:30 +0100)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>
Fri, 8 Apr 2011 00:30:51 +0000 (01:30 +0100)
Doc/library/logging.rst

index e02556b8d6716750ef61ffbb78db144876825e77..b94951df1727b6876cf235196d87d895b52a6a5e 100644 (file)
@@ -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 <context-info>`.
 
-
 .. class:: LoggerAdapter(logger, extra)
 
    Returns an instance of :class:`LoggerAdapter` initialized with an