Added check for delimiters in cfgparser keys to _validate_value_types

python · jaraco · Feb 23, 2025 · Jan 16, 2025 · Jan 22, 2025 · Jan 22, 2025
commit 454f026b93543b92e15e7bc64387c26fd208be19
@@ -163,7 +163,7 @@
            "MultilineContinuationError", "UnnamedSectionDisabledError",
            "ConfigParser", "RawConfigParser",
            "Interpolation", "BasicInterpolation",  "ExtendedInterpolation",
-           "SectionProxy", "ConverterMapping",
+           "SectionProxy", "ConverterMapping", "InvalidKeyError",
            "DEFAULTSECT", "MAX_INTERPOLATION_DEPTH", "UNNAMED_SECTION")
 
 _default_dict = dict
@@ -374,6 +374,11 @@ class _UnnamedSection:
 
     def __repr__(self):
         return "<UNNAMED_SECTION>"
+
+class InvalidKeyError(Error):
+    """Raised when attempting to write a key which contains any delimiters"""
+    def __init__(self):
+        Error.__init__(self, "Cannot write key that contains a delimiter")
 
 
 UNNAMED_SECTION = _UnnamedSection()
@@ -1234,6 +1239,9 @@ def _validate_value_types(self, *, section="", option="", value=""):
         if not self._allow_no_value or value:
             if not isinstance(value, str):
                 raise TypeError("option values must be strings")
+        for delim in self._delimiters:
+            if delim in option:
+                raise InvalidKeyError()
 
     @property
     def converters(self):

@@ -2173,7 +2173,18 @@ def test_disabled_error(self):
 
         with self.assertRaises(configparser.UnnamedSectionDisabledError):
             configparser.ConfigParser().add_section(configparser.UNNAMED_SECTION)
-
+
+    def test_invalid_key(self):
+        cfg2file = configparser.ConfigParser()
+        cfg2file.add_section("section1")
+        with self.assertRaises(configparser.InvalidKeyError): 
+            cfg2file.set("section1", "one=two", "three")
+
+        with self.assertRaises(configparser.InvalidKeyError): 
+            cfg2file.set("section1", "one:two", "three")
+
+        cfg2file.set("section1", "one", "two=three")
+
 
 class MiscTestCase(unittest.TestCase):
     def test__all__(self):