Skip to content

gh-89867: string.Formatter auto numbering doc updates #129617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 30, 2025
Merged

gh-89867: string.Formatter auto numbering doc updates #129617

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6312b39
init
dg-pb Feb 3, 2025
1b10b8c
edit
dg-pb Feb 3, 2025
f8cca7e
edit2
dg-pb Feb 3, 2025
1f64c6b
edit3
dg-pb Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions Doc/library/string.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,16 +131,18 @@ implementation as the built-in :meth:`~str.format` method.
(which can happen if two replacement fields occur consecutively), then
*literal_text* will be a zero-length string. If there is no replacement
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)

Given *field_name* as returned by :meth:`parse` (see above), convert it to
an object to be formatted. Returns a tuple (obj, used_key). The default
version takes strings of the form defined in :pep:`3101`, such as
"0[name]" or "label.title". *args* and *kwargs* are as passed in to
:meth:`vformat`. The return value *used_key* has the same meaning as the
*key* parameter to :meth:`get_value`.
Given *field_name*, convert it to an object to be formatted.
Auto-numbering of *field_name* returned from :meth:`parse` is done by
:meth:`vformat` before calling this method. Returns a tuple (obj, used_key).
The default version takes strings of the form defined in :pep:`3101`,
such as "0[name]" or "label.title". *args* and *kwargs* are as passed in to
: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)

Expand Down
Loading