summaryrefslogtreecommitdiffstats
path: root/Doc/library/string.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/library/string.rst')
-rw-r--r--Doc/library/string.rst38
1 files changed, 25 insertions, 13 deletions
diff --git a/Doc/library/string.rst b/Doc/library/string.rst
index b2d0bba..d45eb36 100644
--- a/Doc/library/string.rst
+++ b/Doc/library/string.rst
@@ -11,6 +11,10 @@
:ref:`string-methods`
+**Source code:** :source:`Lib/string.py`
+
+--------------
+
String constants
----------------
@@ -340,9 +344,18 @@ following:
| | positive numbers, and a minus sign on negative numbers. |
+---------+----------------------------------------------------------+
-The ``'#'`` option is only valid for integers, and only for binary, octal, or
-hexadecimal output. If present, it specifies that the output will be prefixed
-by ``'0b'``, ``'0o'``, or ``'0x'``, respectively.
+
+The ``'#'`` option causes the "alternate form" to be used for the
+conversion. The alternate form is defined differently for different
+types. This option is only valid for integer, float, complex and
+Decimal types. For integers, when binary, octal, or hexadecimal output
+is used, this option adds the prefix respective ``'0b'``, ``'0o'``, or
+``'0x'`` to the output value. For floats, complex and Decimal the
+alternate form causes the result of the conversion to always contain a
+decimal-point character, even if no digits follow it. Normally, a
+decimal-point character appears in the result of these conversions
+only if a digit follows it. In addition, for ``'g'`` and ``'G'``
+conversions, trailing zeros are not removed from the result.
The ``','`` option signals the use of a comma for a thousands separator.
For a locale aware separator, use the ``'n'`` integer presentation type
@@ -705,6 +718,14 @@ to parse template strings. To do this, you can override these class attributes:
appropriate). The default value is the regular expression
``[_a-z][_a-z0-9]*``.
+* *flags* -- The regular expression flags that will be applied when compiling
+ the regular expression used for recognizing substitutions. The default value
+ is ``re.IGNORECASE``. Note that ``re.VERBOSE`` will always be added to the
+ flags, so custom *idpattern*\ s must follow conventions for verbose regular
+ expressions.
+
+ .. versionadded:: 3.2
+
Alternatively, you can provide the entire regular expression pattern by
overriding the class attribute *pattern*. If you do this, the value must be a
regular expression object with four named capturing groups. The capturing
@@ -727,7 +748,7 @@ rule:
Helper functions
----------------
-.. function:: capwords(s[, sep])
+.. function:: capwords(s, sep=None)
Split the argument into words using :meth:`str.split`, capitalize each word
using :meth:`str.capitalize`, and join the capitalized words using
@@ -736,12 +757,3 @@ Helper functions
and leading and trailing whitespace are removed, otherwise *sep* is used to
split and join the words.
-
-.. function:: maketrans(frm, to)
-
- Return a translation table suitable for passing to :meth:`bytes.translate`,
- that will map each character in *from* into the character at the same
- position in *to*; *from* and *to* must have the same length.
-
- .. deprecated:: 3.1
- Use the :meth:`bytes.maketrans` static method instead.