Thanks to visit codestin.com
Credit goes to github.com

Skip to content

gh-134082: Modernize docstrings in string.Formatter #134083

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 6 commits into from
May 16, 2025
Merged

gh-134082: Modernize docstrings in string.Formatter #134083

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9ef4e56
use docstring for `string.Formatter`
picnixz May 12, 2025
9aa1a87
clarify docstring
picnixz May 16, 2025
b3815b5
fix punctuation
picnixz May 16, 2025
3a3de36
Update Lib/string/__init__.py
picnixz May 16, 2025
b2a33a7
GH UI...
picnixz May 16, 2025
ffc59ef
Update Lib/string/__init__.py
picnixz May 16, 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
36 changes: 15 additions & 21 deletions Lib/string/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,22 +264,18 @@ def _vformat(self, format_string, args, kwargs, used_args, recursion_depth,

return ''.join(result), auto_arg_index


def get_value(self, key, args, kwargs):
if isinstance(key, int):
return args[key]
else:
return kwargs[key]


def check_unused_args(self, used_args, args, kwargs):
pass


def format_field(self, value, format_spec):
return format(value, format_spec)


def convert_field(self, value, conversion):
# do any conversion on the resulting object
if conversion is None:
Expand All @@ -292,34 +288,32 @@ def convert_field(self, value, conversion):
return ascii(value)
raise ValueError("Unknown conversion specifier {0!s}".format(conversion))


# returns an iterable that contains tuples of the form:
# (literal_text, field_name, format_spec, conversion)
# literal_text can be zero length
# field_name can be None, in which case there's no
# object to format and output
# if field_name is not None, it is looked up, formatted
# with format_spec and conversion and then used
def parse(self, format_string):
return _string.formatter_parser(format_string)
"""
Return an iterable that contains tuples of the form
(literal_text, field_name, format_spec, conversion).


# given a field_name, find the object it references.
# field_name: the field being looked up, e.g. "0.name"
# or "lookup[3]"
# used_args: a set of which args have been used
# args, kwargs: as passed in to vformat
*field_name* can be None, in which case there's no object
to format and output; otherwise, it is looked up and
formatted with *format_spec* and *conversion*.
"""
return _string.formatter_parser(format_string)

def get_field(self, field_name, args, kwargs):
first, rest = _string.formatter_field_name_split(field_name)
"""Find the object referenced by a given field name.

The field name *field_name* can be for instance "0.name"
or "lookup[3]". The *args* and *kwargs* arguments are
passed to get_value().
"""
first, rest = _string.formatter_field_name_split(field_name)
obj = self.get_value(first, args, kwargs)

# loop through the rest of the field_name, doing
# getattr or getitem as needed
for is_attr, i in rest:
if is_attr:
obj = getattr(obj, i)
else:
obj = obj[i]

return obj, first
Loading