https://github.com/python/cpython/commit/22e4a40d9089dde2f1578c4b320f27b20e2e125b
commit: 22e4a40d9089dde2f1578c4b320f27b20e2e125b
branch: main
author: Bénédikt Tran <[email protected]>
committer: picnixz <[email protected]>
date: 2025-05-18T10:10:54+02:00
summary:
gh-134082: modernize `string.Formatter` class docstring (#134125)
fixup Formatter class docstring
files:
M Lib/string/__init__.py
diff --git a/Lib/string/__init__.py b/Lib/string/__init__.py
index b7782e042b94eb..b788d7136f1ae3 100644
--- a/Lib/string/__init__.py
+++ b/Lib/string/__init__.py
@@ -191,16 +191,14 @@ def get_identifiers(self):
########################################################################
-# the Formatter class
-# see PEP 3101 for details and purpose of this class
-
-# The hard parts are reused from the C implementation. They're exposed as "_"
-# prefixed methods of str.
-
+# The Formatter class (PEP 3101).
+#
# The overall parser is implemented in _string.formatter_parser.
-# The field name parser is implemented in _string.formatter_field_name_split
+# The field name parser is implemented in _string.formatter_field_name_split.
class Formatter:
+ """See PEP 3101 for details and purpose of this class."""
+
def format(self, format_string, /, *args, **kwargs):
return self.vformat(format_string, args, kwargs)
@@ -293,7 +291,6 @@ def parse(self, format_string):
Return an iterable that contains tuples of the form
(literal_text, field_name, format_spec, conversion).
-
*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*.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
