[Python-checkins] cpython (3.2): Updated Formatter documentation.

[vinay.sajip]

http://hg.python.org/cpython/rev/c760390165dc
changeset:   69194:c760390165dc
branch:      3.2
parent:      69189:225400cb6e84
user:        Vinay Sajip <vinay_sajip at yahoo.co.uk>
date:        Fri Apr 08 01:30:51 2011 +0100
summary:
  Updated Formatter documentation.

files:
  Doc/library/logging.rst |  11 +++++++++--
  1 files changed, 9 insertions(+), 2 deletions(-)


diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -405,7 +405,7 @@
 :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 @@
    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 @@
 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

-- 
Repository URL: http://hg.python.org/cpython