gh-127011: Add __str__ and __repr__ to ConfigParser

Lib/configparser.py

@@ -682,6 +682,7 @@ def __init__(self, defaults=None, dict_type=_default_dict,
         if defaults:
             self._read_defaults(defaults)
         self._allow_unnamed_section = allow_unnamed_section
+        self._loaded_files = []
 
     def defaults(self):
         return self._defaults
@@ -750,6 +751,7 @@ def read(self, filenames, encoding=None):
             if isinstance(filename, os.PathLike):
                 filename = os.fspath(filename)
             read_ok.append(filename)
+        self._loaded_files.extend(read_ok)
         return read_ok
 
     def read_file(self, f, source=None):
@@ -1040,6 +1042,35 @@ 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: {key: value for key, value in self.items(section, raw=True)}
+            for section in self.sections()
+        }
+        return str(config_dict)
+
+
+    def __repr__(self):
+        init_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__,
+        }
+        init_params = {k: v for k, v in init_params.items() if v is not None}
+
+        state_summary = {
+            "loaded_files": self._loaded_files if hasattr(self, '_loaded_files') else "(no files loaded)",
+            "sections": len(self._sections),
+        }
+
+        return (f"<{self.__class__.__name__}("
+                f"params={init_params}, "
+                f"state={state_summary})>")
+
     def _read(self, fp, fpname):
         """Parse a sectioned configuration file.
 

Lib/test/test_configparser.py

@@ -980,6 +980,28 @@ 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_and_repr(self):
+        self.maxDiff = None
+        cf = self.config_class(allow_no_value=True, delimiters=('=',), strict=True)
+
+        cf.add_section("sect")
+        cf.set("sect", "option1", "foo")
+        cf.set("sect", "option2", "bar")
+
+        expected_str = "{'sect': {'option1': 'foo', 'option2': 'bar'}}"
+        self.assertEqual(str(cf), expected_str)
+
+        dict_type = type(cf._dict).__name__
+
+        expected_repr = (
+            f"<{cf.__class__.__name__}("
+            f"params={{'dict_type': '{dict_type}', 'allow_no_value': True, "
+            "'delimiters': ('=',), 'strict': True, 'default_section': 'DEFAULT', "
+            "'interpolation': 'BasicInterpolation'}, "
+            "state={'loaded_files': [], 'sections': 1})>"
+        )
+        self.assertEqual(repr(cf), expected_repr)
+
     def test_add_section_default(self):
         cf = self.newconfig()
         self.assertRaises(ValueError, cf.add_section, self.default_section)

Misc/NEWS.d/next/Library/2024-11-23-13-34-55.gh-issue-127011.dT88uF.rst

@@ -0,0 +1 @@
+The ``__str__`` and ``__repr__`` methods have been added to the :class:`configparser.RawConfigParser`