From 05c0774f335aa50d1cf12bd929c223171cae85e8 Mon Sep 17 00:00:00 2001 From: Eric Smith Date: Thu, 25 Feb 2010 14:18:57 +0000 Subject: [PATCH] Merged revisions 78440 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r78440 | eric.smith | 2010-02-25 09:14:35 -0500 (Thu, 25 Feb 2010) | 1 line Issue #5965: Add documentation for parts of format specification language. ........ --- Doc/library/string.rst | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/Doc/library/string.rst b/Doc/library/string.rst index 1bdad616bd8..0de7ff78904 100644 --- a/Doc/library/string.rst +++ b/Doc/library/string.rst @@ -296,8 +296,9 @@ specification is to be interpreted. Most built-in types implement the following options for format specifications, although some of the formatting options are only supported by the numeric types. -A general convention is that an empty format string (``""``) produces the same -result as if you had called :func:`str` on the value. +A general convention is that an empty format string (``""``) produces +the same result as if you had called :func:`str` on the value. A +non-empty format string typically modifies the result. The general form of a *standard format specifier* is: @@ -308,7 +309,7 @@ The general form of a *standard format specifier* is: sign: "+" | "-" | " " width: `integer` precision: `integer` - type: "b" | "c" | "d" | "e" | "E" | "f" | "F" | "g" | "G" | "n" | "o" | "x" | "X" | "%" + type: "b" | "c" | "d" | "e" | "E" | "f" | "F" | "g" | "G" | "n" | "o" | "s" | "x" | "X" | "%" The *fill* character can be any character other than '}' (which signifies the end of the field). The presence of a fill character is signaled by the *next* @@ -380,6 +381,17 @@ used from the field content. The *precision* is not allowed for integer values. Finally, the *type* determines how the data should be presented. +The available string presentation types are: + + +---------+----------------------------------------------------------+ + | Type | Meaning | + +=========+==========================================================+ + | ``'s'`` | String format. This is the default type for strings and | + | | may be omitted. | + +---------+----------------------------------------------------------+ + | None | The same as ``'s'``. | + +---------+----------------------------------------------------------+ + The available integer presentation types are: +---------+----------------------------------------------------------+ @@ -407,6 +419,11 @@ The available integer presentation types are: | None | The same as ``'d'``. | +---------+----------------------------------------------------------+ +In addition to the above presentation types, integers can be formatted +with the floating point presentation types listed below (except +``'n'`` and None). When doing so, :func:`float` is used to convert the +integer to a floating point number before formatting. + The available presentation types for floating point and decimal values are: +---------+----------------------------------------------------------+