gh-127011: Add __str__ and __repr__ to ConfigParser

- Implement __str__ method showing formatted configuration content
- Implement __repr__ method with constructor parameters and state summary
- Add comprehensive tests for both methods
- Update ACKS and add NEWS entry

Author: Agent-Hellboy

Lib/configparser.py

@@ -670,6 +670,7 @@ def __init__(self, defaults=None, dict_type=_default_dict,
                 self._optcre = re.compile(self._OPT_TMPL.format(delim=d),
                                           re.VERBOSE)
         self._comments = _CommentSpec(comment_prefixes or (), inline_comment_prefixes or ())
+        self._loaded_sources = []
         self._strict = strict
         self._allow_no_value = allow_no_value
         self._empty_lines_in_values = empty_lines_in_values
@@ -757,6 +758,7 @@ def read(self, filenames, encoding=None):
             if isinstance(filename, os.PathLike):
                 filename = os.fspath(filename)
             read_ok.append(filename)
+            self._loaded_sources.append(read_ok)
         return read_ok
 
     def read_file(self, f, source=None):
@@ -773,6 +775,7 @@ def read_file(self, f, source=None):
             except AttributeError:
                 source = '<???>'
         self._read(f, source)
+        self._loaded_sources.append(source)
 
     def read_string(self, string, source='<string>'):
         """Read configuration from a given string."""
@@ -809,6 +812,7 @@ def read_dict(self, dictionary, source='<dict>'):
                     raise DuplicateOptionError(section, key, source)
                 elements_added.add((section, key))
                 self.set(section, key, value)
+        self._loaded_sources.append(source)
 
     def get(self, section, option, *, raw=False, vars=None, fallback=_UNSET):
         """Get an option value for a given section.
@@ -1048,6 +1052,38 @@ def __iter__(self):
         # XXX does it break when underlying container state changed?
         return itertools.chain((self.default_section,), self._sections.keys())
 
+    def __str__(self):
+        config_dict = {
+            section: dict(self.items(section, raw=True))
+            for section in self.sections()
+        }
+        return f"<ConfigParser: {config_dict}>"
+
+    def __repr__(self):
+        params = {
+            "defaults": self._defaults if self._defaults else None,
+            "dict_type": type(self._dict).__name__,
+            "allow_no_value": self._allow_no_value,
+            "delimiters": self._delimiters,
+            "strict": self._strict,
+            "default_section": self.default_section,
+            "interpolation": type(self._interpolation).__name__,
+        }
+        params = {k: v for k, v in params.items() if v is not None}
+        sections_count = len(self._sections)
+        state = {
+            "loaded_sources": self._loaded_sources,
+            "sections_count": sections_count,
+            "sections": list(self._sections)[:5],  # limit to 5 section names for readability
+        }
+
+        if sections_count > 5:
+            state["sections_truncated"] = f"...and {sections_count - 5} more"
+
+        return (f"<{self.__class__.__name__}("
+                f"params={params}, "
+                f"state={state})>")
+
     def _read(self, fp, fpname):
         """Parse a sectioned configuration file.
 
@@ -1068,6 +1104,7 @@ def _read(self, fp, fpname):
         try:
             ParsingError._raise_all(self._read_inner(fp, fpname))
         finally:
+            self._loaded_sources.append(fpname)
             self._join_multiline_values()
 
     def _read_inner(self, fp, fpname):
@@ -1218,11 +1255,14 @@ def _convert_to_boolean(self, value):
 
     def _validate_key_contents(self, key):
         """Raises an InvalidWriteError for any keys containing
-        delimiters or that match the section header pattern"""
+        delimiters or that begins with the section header pattern"""
         if re.match(self.SECTCRE, key):
-            raise InvalidWriteError("Cannot write keys matching section pattern")
-        if any(delim in key for delim in self._delimiters):
-            raise InvalidWriteError("Cannot write key that contains delimiters")
+            raise InvalidWriteError(
+                f"Cannot write key {key}; begins with section pattern")
+        for delim in self._delimiters:
+            if delim in key:
+                raise InvalidWriteError(
+                    f"Cannot write key {key}; contains delimiter {delim}")
 
     def _validate_value_types(self, *, section="", option="", value=""):
         """Raises a TypeError for illegal non-string values.

Lib/test/test_configparser.py

@@ -980,18 +980,62 @@ def test_set_nonstring_types(self):
         self.assertRaises(TypeError, cf.set, "sect", 123, "invalid opt name!")
         self.assertRaises(TypeError, cf.add_section, 123)
 
+    def test_str(self):
+        self.maxDiff = None
+        cf = self.config_class(allow_no_value=True, delimiters=('=',), strict=True)
+        cf.add_section("sect1")
+        cf.add_section("sect2")
+        cf.set("sect1", "option1", "foo")
+        cf.set("sect2", "option2", "bar")
+
+        expected_str = (
+            "<ConfigParser: {'sect1': {'option1': 'foo'}, 'sect2': {'option2': 'bar'}}>"
+        )
+        self.assertEqual(str(cf), expected_str)
+
+    def test_repr(self):
+        self.maxDiff = None
+        cf = self.config_class(allow_no_value=True, delimiters=('=',), strict=True)
+        cf.add_section("sect1")
+        cf.add_section("sect2")
+        cf.add_section("sect3")
+        cf.add_section("sect4")
+        cf.add_section("sect5")
+        cf.add_section("sect6")
+        cf.set("sect1", "option1", "foo")
+        cf.set("sect2", "option2", "bar")
+        cf.read_string("")  # to trigger the loading of sources
+
+        dict_type = type(cf._dict).__name__
+        params = {
+            'dict_type': dict_type,
+            'allow_no_value': True,
+            'delimiters': ('=',),
+            'strict': True,
+            'default_section': 'DEFAULT',
+            'interpolation': 'BasicInterpolation',
+        }
+        state = {
+            'loaded_sources': ['<string>'],
+            'sections_count': 6,
+            'sections': ['sect1', 'sect2', 'sect3', 'sect4', 'sect5'],
+            'sections_truncated': '...and 1 more',
+        }
+        expected = f"<{type(cf).__name__}({params=}, {state=})>"
+        self.assertEqual(repr(cf), expected)
+
     def test_add_section_default(self):
         cf = self.newconfig()
         self.assertRaises(ValueError, cf.add_section, self.default_section)
 
     def test_defaults_keyword(self):
         """bpo-23835 fix for ConfigParser"""
-        cf = self.newconfig(defaults={1: 2.4})
-        self.assertEqual(cf[self.default_section]['1'], '2.4')
-        self.assertAlmostEqual(cf[self.default_section].getfloat('1'), 2.4)
-        cf = self.newconfig(defaults={"A": 5.2})
-        self.assertEqual(cf[self.default_section]['a'], '5.2')
-        self.assertAlmostEqual(cf[self.default_section].getfloat('a'), 5.2)
+        cf = self.newconfig(defaults={1: 2.5})
+        self.assertEqual(cf[self.default_section]['1'], '2.5')
+        self.assertAlmostEqual(cf[self.default_section].getfloat('1'), 2.5)
+        cf = self.newconfig(defaults={"A": 5.25})
+        self.assertEqual(cf[self.default_section]['a'], '5.25')
+        self.assertAlmostEqual(cf[self.default_section].getfloat('a'), 5.25)
 
 
 class ConfigParserTestCaseNoInterpolation(BasicTestCase, unittest.TestCase):

Misc/ACKS

@@ -43,6 +43,7 @@ Ray Allen
 Billy G. Allie
 Jamiel Almeida
 Kevin Altis
+Nazım Can Altınova
 Samy Lahfa
 Skyler Leigh Amador
 Joe Amenta
@@ -478,6 +479,7 @@ Dean Draayer
 Fred L. Drake, Jr.
 Mehdi Drissi
 Derk Drukker
+Weilin Du
 John DuBois
 Paul Dubois
 Jacques Ducasse
@@ -658,6 +660,7 @@ Michael Goderbauer
 Karan Goel
 Jeroen Van Goey
 Christoph Gohlke
+Daniel Golding
 Tim Golden
 Yonatan Goldschmidt
 Mark Gollahon
@@ -930,6 +933,7 @@ Bob Kahn
 Kurt B. Kaiser
 Tamito Kajiyama
 Jan Kaliszewski
+Ajay Kamdar
 Peter van Kampen
 Jan Kanis
 Rafe Kaplan
@@ -942,6 +946,7 @@ Anton Kasyanov
 Lou Kates
 Makoto Kato
 Irit Katriel
+Kattni
 Hiroaki Kawai
 Dmitry Kazakov
 Brian Kearns
@@ -1052,6 +1057,7 @@ Alexander Lakeev
 David Lam
 Thomas Lamb
 Valerie Lambert
+Kliment Lamonov
 Peter Lamut
 Jean-Baptiste "Jiba" Lamy
 Ronan Lamy
@@ -1365,6 +1371,7 @@ Milan Oberkirch
 Pascal Oberndoerfer
 Géry Ogam
 Seonkyo Ok
+Andrea Oliveri
 Jeffrey Ollie
 Adam Olsen
 Bryan Olson
@@ -1478,6 +1485,7 @@ Jean-François Piéronne
 Oleg Plakhotnyuk
 Anatoliy Platonov
 Marcel Plch
+Stefan Pochmann
 Kirill Podoprigora
 Remi Pointel
 Jon Poler
@@ -1602,6 +1610,7 @@ Joel Rosdahl
 Erik Rose
 Mark Roseman
 Josh Rosenberg
+Prince Roshan
 Jim Roskind
 Brian Rosner
 Ignacio Rossi
@@ -1737,6 +1746,7 @@ Joel Shprentz
 Yue Shuaijie
 Jaysinh Shukla
 Terrel Shumway
+Richard Si
 Eric Siegerman
 Reilly Tucker Siemens
 Paul Sijben
@@ -1867,6 +1877,7 @@ Neil Tallim
 Geoff Talvola
 Anish Tambe
 Musashi Tamura
+Long Tan
 William Tanksley
 Christian Tanzer
 Steven Taschuk
@@ -1892,6 +1903,7 @@ Nicolas M. Thiéry
 James Thomas
 Reuben Thomas
 Robin Thomas
+Douglas Thor
 Brian Thorne
 Christopher Thorne
 Stephen Thorne
@@ -1945,6 +1957,7 @@ Adnan Umer
 Utkarsh Upadhyay
 Roger Upole
 Daniel Urban
+Alexander Enrique Urieles Nieto
 Matthias Urlichs
 Michael Urman
 Hector Urtubia
@@ -1980,6 +1993,7 @@ Olivier Vielpeau
 Kannan Vijayan
 Kurt Vile
 Norman Vine
+Tom Viner
 Pauli Virtanen
 Frank Visser
 Long Vo

Misc/NEWS.d/next/Library/2025-04-25-18-29-10.gh-issue-127011.Ipem5z.rst

@@ -0,0 +1,2 @@
+Implement :meth:`~object.__str__` and :meth:`~object.__repr__`
+for :class:`configparser.RawConfigParser` objects.

Modules/clinic/mymodule.c.h

@@ -0,0 +1,17 @@
+/*[clinic input]
+module mymodule
+[clinic start generated code]*/
+/*[clinic end generated code: output=da39a3ee5e6b4b0d input=225490d2c42d68bb]*/
+
+/*[clinic input]
+mymodule.myfunc
+    x: int
+    y: object = NULL
+    /
+Compute something useful with x and y.
+
+[clinic start generated code]*/
+
+static PyObject *
+mymodule_myfunc_impl(PyObject *module, int x, PyObject *y)
+/*[clinic end generated code: output=4ccaef16ad3bade4 input=19b92a026ab251ef]*/