String and Unicode objects have one unique built-in operation: the
% operator (modulo). This is also known as the string
formatting or interpolation operator. Given
format % values (where format is a string or
Unicode object), % conversion specifications in format
are replaced with zero or more elements of values. The effect
is similar to the using sprintf() in the C language. If
format is a Unicode object, or if any of the objects being
converted using the %s conversion are Unicode objects, the
result will also be a Unicode object.
If format requires a single argument, values may be a
single non-tuple object.3.4 Otherwise, values must be a tuple with
exactly the number of items specified by the format string, or a
single mapping object (for example, a dictionary).
A conversion specifier contains two or more characters and has the
following components, which must occur in this order:
The "%" character, which marks the start of the
specifier.
Mapping key (optional), consisting of a parenthesised sequence
of characters (for example, (somename)).
Conversion flags (optional), which affect the result of some
conversion types.
Minimum field width (optional). If specified as an
"*" (asterisk), the actual width is read from the
next element of the tuple in values, and the object to
convert comes after the minimum field width and optional
precision.
Precision (optional), given as a "." (dot) followed
by the precision. If specified as "*" (an
asterisk), the actual width is read from the next element of
the tuple in values, and the value to convert comes after
the precision.
Length modifier (optional).
Conversion type.
When the right argument is a dictionary (or other mapping type), then
the formats in the string must include a parenthesised mapping key into
that dictionary inserted immediately after the "%"
character. The mapping key selects the value to be formatted from the
mapping. For example:
>>> print '%(language)s has %(#)03d quote types.' % \
{'language': "Python", "#": 2}
Python has 002 quote types.
In this case no * specifiers may occur in a format (since they
require a sequential parameter list).
The conversion flag characters are:
Flag
Meaning
#
The value conversion will use the ``alternate form''
(where defined below).
0
The conversion will be zero padded for numeric values.
-
The converted value is left adjusted (overrides
the "0" conversion if both are given).
(a space) A blank should be left before a positive number
(or empty string) produced by a signed conversion.
+
A sign character ("+" or "-") will
precede the conversion (overrides a "space" flag).
A length modifier (h, l, or L) may be
present, but is ignored as it is not necessary for Python.
The conversion types are:
Conversion
Meaning
Notes
d
Signed integer decimal.
i
Signed integer decimal.
o
Unsigned octal.
(1)
u
Unsigned decimal.
x
Unsigned hexadecimal (lowercase).
(2)
X
Unsigned hexadecimal (uppercase).
(2)
e
Floating point exponential format (lowercase).
(3)
E
Floating point exponential format (uppercase).
(3)
f
Floating point decimal format.
(3)
F
Floating point decimal format.
(3)
g
Floating point format. Uses exponential format
if exponent is greater than -4 or less than precision,
decimal format otherwise.
(4)
G
Floating point format. Uses exponential format
if exponent is greater than -4 or less than precision,
decimal format otherwise.
(4)
c
Single character (accepts integer or single character
string).
r
String (converts any python object using
repr()).
(5)
s
String (converts any python object using
str()).
(6)
%
No argument is converted, results in a "%"
character in the result.
Notes:
(1)
The alternate form causes a leading zero ("0") to be
inserted between left-hand padding and the formatting of the
number if the leading character of the result is not already a
zero.
(2)
The alternate form causes a leading '0x' or '0X'
(depending on whether the "x" or "X" format
was used) to be inserted between left-hand padding and the
formatting of the number if the leading character of the result is
not already a zero.
(3)
The alternate form causes the result to always contain a decimal
point, even if no digits follow it.
The precision determines the number of digits after the decimal
point and defaults to 6.
(4)
The alternate form causes the result to always contain a decimal
point, and trailing zeroes are not removed as they would
otherwise be.
The precision determines the number of significant digits before
and after the decimal point and defaults to 6.
(5)
The %r conversion was added in Python 2.0.
The precision determines the maximal number of characters used.
(6)
If the object or format provided is a unicode string,
the resulting string will also be unicode.
The precision determines the maximal number of characters used.
Since Python strings have an explicit length, %s conversions
do not assume that '\0' is the end of the string.
For safety reasons, floating point precisions are clipped to 50;
%f conversions for numbers whose absolute value is over 1e25
are replaced by %g conversions.3.5 All other errors raise exceptions.
Additional string operations are defined in standard modules
string and
re.
These numbers are fairly arbitrary. They are intended to
avoid printing endless strings of meaningless digits without hampering
correct use and without having to know the exact precision of floating
point values on a particular machine.
