1berry/cpython
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

gh-89867: string.Formatter auto numbering doc updates (GH-129617)

Browse Source
This commit is contained in:
dgpb 2025-04-30 15:24:40 +03:00 committed by GitHub
parent b1f893875b
commit a4b7128301
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Doc/library/string.rst
View File

@ -131,16 +131,18 @@ implementation as the built-in :meth:`~str.format` method.
(which can happen if two replacement fields occur consecutively), then (which can happen if two replacement fields occur consecutively), then
*literal_text* will be a zero-length string. If there is no replacement *literal_text* will be a zero-length string. If there is no replacement
field, then the values of *field_name*, *format_spec* and *conversion* field, then the values of *field_name*, *format_spec* and *conversion*
will be ``None``. will be ``None``. The value of *field_name* is unmodified and
auto-numbering of non-numbered positional fields is done by :meth:`vformat`.
.. method:: get_field(field_name, args, kwargs) .. method:: get_field(field_name, args, kwargs)
Given *field_name* as returned by :meth:`parse` (see above), convert it to Given *field_name*, convert it to an object to be formatted.
an object to be formatted. Returns a tuple (obj, used_key). The default Auto-numbering of *field_name* returned from :meth:`parse` is done by
version takes strings of the form defined in :pep:`3101`, such as :meth:`vformat` before calling this method. Returns a tuple (obj, used_key).
"0[name]" or "label.title". *args* and *kwargs* are as passed in to The default version takes strings of the form defined in :pep:`3101`,
:meth:`vformat`. The return value *used_key* has the same meaning as the such as "0[name]" or "label.title". *args* and *kwargs* are as passed in to
*key* parameter to :meth:`get_value`. :meth:`vformat`. The return value *used_key* has the same meaning
as the *key* parameter to :meth:`get_value`.
.. method:: get_value(key, args, kwargs) .. method:: get_value(key, args, kwargs)