diff options
Diffstat (limited to 'Lib')
-rw-r--r-- | Lib/configparser.py | 19 | ||||
-rw-r--r-- | Lib/test/test_configparser.py | 24 |
2 files changed, 42 insertions, 1 deletions
diff --git a/Lib/configparser.py b/Lib/configparser.py index 9ff52e03c2c..462af2f4abf 100644 --- a/Lib/configparser.py +++ b/Lib/configparser.py @@ -161,7 +161,7 @@ __all__ = ("NoSectionError", "DuplicateOptionError", "DuplicateSectionError", "InterpolationMissingOptionError", "InterpolationSyntaxError", "ParsingError", "MissingSectionHeaderError", "MultilineContinuationError", "UnnamedSectionDisabledError", - "ConfigParser", "RawConfigParser", + "InvalidWriteError", "ConfigParser", "RawConfigParser", "Interpolation", "BasicInterpolation", "ExtendedInterpolation", "SectionProxy", "ConverterMapping", "DEFAULTSECT", "MAX_INTERPOLATION_DEPTH", "UNNAMED_SECTION") @@ -375,6 +375,14 @@ class _UnnamedSection: def __repr__(self): return "<UNNAMED_SECTION>" +class InvalidWriteError(Error): + """Raised when attempting to write data that the parser would read back differently. + ex: writing a key which begins with the section header pattern would read back as a + new section """ + + def __init__(self, msg=''): + Error.__init__(self, msg) + UNNAMED_SECTION = _UnnamedSection() @@ -973,6 +981,7 @@ class RawConfigParser(MutableMapping): if not unnamed: fp.write("[{}]\n".format(section_name)) for key, value in section_items: + self._validate_key_contents(key) value = self._interpolation.before_write(self, section_name, key, value) if value is not None or not self._allow_no_value: @@ -1210,6 +1219,14 @@ class RawConfigParser(MutableMapping): raise ValueError('Not a boolean: %s' % value) return self.BOOLEAN_STATES[value.lower()] + def _validate_key_contents(self, key): + """Raises an InvalidWriteError for any keys containing + delimiters or that match 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") + def _validate_value_types(self, *, section="", option="", value=""): """Raises a TypeError for illegal non-string values. diff --git a/Lib/test/test_configparser.py b/Lib/test/test_configparser.py index c2c82ebe6a8..1313ec2b9e8 100644 --- a/Lib/test/test_configparser.py +++ b/Lib/test/test_configparser.py @@ -2192,6 +2192,30 @@ class SectionlessTestCase(unittest.TestCase): self.assertEqual('2', cfg[configparser.UNNAMED_SECTION]['b']) +class InvalidInputTestCase(unittest.TestCase): + """Tests for issue #65697, where configparser will write configs + it parses back differently. Ex: keys containing delimiters or + matching the section pattern""" + + def test_delimiter_in_key(self): + cfg = configparser.ConfigParser(delimiters=('=')) + cfg.add_section('section1') + cfg.set('section1', 'a=b', 'c') + output = io.StringIO() + with self.assertRaises(configparser.InvalidWriteError): + cfg.write(output) + output.close() + + def test_section_bracket_in_key(self): + cfg = configparser.ConfigParser() + cfg.add_section('section1') + cfg.set('section1', '[this parses back as a section]', 'foo') + output = io.StringIO() + with self.assertRaises(configparser.InvalidWriteError): + cfg.write(output) + output.close() + + class MiscTestCase(unittest.TestCase): def test__all__(self): support.check__all__(self, configparser, not_exported={"Error"}) |