(original) (raw)

Index: Lib/ConfigParser.py =================================================================== --- Lib/ConfigParser.py (revision 74793) +++ Lib/ConfigParser.py (working copy) @@ -221,10 +221,15 @@ class RawConfigParser: - def __init__(self, defaults=None, dict_type=_default_dict): + def __init__(self, defaults=None, dict_type=_default_dict, + allow_no_value=False): self._dict = dict_type self._sections = self._dict() self._defaults = self._dict() + if allow_no_value: + self._optcre = self.OPTCRE_NV + else: + self._optcre = self.OPTCRE if defaults: for key, value in defaults.items(): self._defaults[self.optionxform(key)] = value @@ -372,7 +377,7 @@ return (option in self._sections[section] or option in self._defaults) - def set(self, section, option, value): + def set(self, section, option, value=None): """Set an option.""" if not section or section == DEFAULTSECT: sectdict = self._defaults @@ -394,8 +399,11 @@ fp.write("[%s]\n" % section) for (key, value) in self._sections[section].items(): if key != "__name__": - fp.write("%s = %s\n" % - (key, str(value).replace('\n', '\n\t'))) + if value is None: + fp.write("%s\n" % (key)) + else: + fp.write("%s = %s\n" % + (key, str(value).replace('\n', '\n\t'))) fp.write("\n") def remove_option(self, section, option): @@ -436,6 +444,15 @@ # by any # space/tab r'(?P.*)$' # everything up to eol ) + OPTCRE_NV = re.compile( + r'(?P[^:=\s][^:=]*)' # very permissive! + r'\s*(?:' # any number of space/tab, + r'(?P[:=])\s*' # optionally followed by + # separator (either : or + # =), followed by any # + # space/tab + r'(?P.*))?$' # everything up to eol + ) def _read(self, fp, fpname): """Parse a sectioned setup file. @@ -488,16 +505,19 @@ raise MissingSectionHeaderError(fpname, lineno, line) # an option line? else: - mo = self.OPTCRE.match(line) + mo = self._optcre.match(line) if mo: optname, vi, optval = mo.group('option', 'vi', 'value') - if vi in ('=', ':') and ';' in optval: - # ';' is a comment delimiter only if it follows - # a spacing character - pos = optval.find(';') - if pos != -1 and optval[pos-1].isspace(): - optval = optval[:pos] - optval = optval.strip() + # This check is fine because the OPTCRE cannot + # match if it would set optval to None + if optval is not None: + if vi in ('=', ':') and ';' in optval: + # ';' is a comment delimiter only if it follows + # a spacing character + pos = optval.find(';') + if pos != -1 and optval[pos-1].isspace(): + optval = optval[:pos] + optval = optval.strip() # allow empty values if optval == '""': optval = '' @@ -545,7 +565,7 @@ except KeyError: raise NoOptionError(option, section) - if raw: + if raw or value is None: return value else: return self._interpolate(section, option, value, d) @@ -588,7 +608,7 @@ depth = MAX_INTERPOLATION_DEPTH while depth: # Loop through this until it's done depth -= 1 - if "%(" in value: + if value is not None and "%(" in value: value = self._KEYCRE.sub(self._interpolation_replace, value) try: value = value % vars @@ -597,7 +617,7 @@ option, section, rawval, e.args[0]) else: break - if "%(" in value: + if value is not None and "%(" in value: raise InterpolationDepthError(option, section, rawval) return value @@ -659,10 +679,16 @@ option, section, "'%%' must be followed by '%%' or '(', found: %r" % (rest,)) - def set(self, section, option, value): + def set(self, section, option, value=None): """Set an option. Extend ConfigParser.set: check for string values.""" - if not isinstance(value, basestring): - raise TypeError("option values must be strings") + # The only legal non-string value if we allow valueless + # options is None, so we need to check if the value is a + # string if: + # - we do not allow valueless options, or + # - we allow valueless options but the value is not None + if self._optcre is self.OPTCRE or value is not None: + if not isinstance(value, basestring): + raise TypeError("option values must be strings") # check for bad percent signs: # first, replace all "good" interpolations tmp_value = value.replace('%%', '') Index: Lib/test/test_cfgparser.py =================================================================== --- Lib/test/test_cfgparser.py (revision 74793) +++ Lib/test/test_cfgparser.py (working copy) @@ -26,11 +26,14 @@ def itervalues(self): return iter(self.values()) class TestCaseBase(unittest.TestCase): + allow_no_value = False + def newconfig(self, defaults=None): if defaults is None: - self.cf = self.config_class() + self.cf = self.config_class(allow_no_value=self.allow_no_value) else: - self.cf = self.config_class(defaults) + self.cf = self.config_class(defaults, + allow_no_value=self.allow_no_value) return self.cf def fromstring(self, string, defaults=None): @@ -40,7 +43,7 @@ return cf def test_basic(self): - cf = self.fromstring( + config_string = ( "[Foo Bar]\n" "foo=bar\n" "[Spacey Bar]\n" @@ -60,17 +63,28 @@ "key with spaces : value\n" "another with spaces = splat!\n" ) + if self.allow_no_value: + config_string += ( + "[NoValue]\n" + "option-without-value\n" + ) + + cf = self.fromstring(config_string) L = cf.sections() L.sort() + E = [r'Commented Bar', + r'Foo Bar', + r'Internationalized Stuff', + r'Long Line', + r'Section\with$weird%characters[' '\t', + r'Spaces', + r'Spacey Bar', + ] + if self.allow_no_value: + E.append(r'NoValue') + E.sort() eq = self.assertEqual - eq(L, [r'Commented Bar', - r'Foo Bar', - r'Internationalized Stuff', - r'Long Line', - r'Section\with$weird%characters[' '\t', - r'Spaces', - r'Spacey Bar', - ]) + eq(L, E) # The use of spaces in the section names serves as a # regression test for SourceForge bug #583248: @@ -80,6 +94,8 @@ eq(cf.get('Commented Bar', 'foo'), 'bar') eq(cf.get('Spaces', 'key with spaces'), 'value') eq(cf.get('Spaces', 'another with spaces'), 'splat!') + if self.allow_no_value: + eq(cf.get('NoValue', 'option-without-value'), None) self.assertFalse('__name__' in cf.options("Foo Bar"), '__name__ "option" should not be exposed by the API!') @@ -152,8 +168,6 @@ self.parse_error(ConfigParser.ParsingError, "[Foo]\n extra-spaces= splat\n") self.parse_error(ConfigParser.ParsingError, - "[Foo]\noption-without-value\n") - self.parse_error(ConfigParser.ParsingError, "[Foo]\n:value-without-option-name\n") self.parse_error(ConfigParser.ParsingError, "[Foo]\n=value-without-option-name\n") @@ -219,18 +233,24 @@ cf.add_section, "Foo") def test_write(self): - cf = self.fromstring( + config_string = ( "[Long Line]\n" "foo: this line is much, much longer than my editor\n" " likes it.\n" "[DEFAULT]\n" "foo: another very\n" - " long line" + " long line\n" ) + if self.allow_no_value: + config_string += ( + "[Valueless]\n" + "option-without-value\n" + ) + + cf = self.fromstring(config_string) output = StringIO.StringIO() cf.write(output) - self.assertEqual( - output.getvalue(), + expect_string = ( "[DEFAULT]\n" "foo = another very\n" "\tlong line\n" @@ -240,6 +260,13 @@ "\tlikes it.\n" "\n" ) + if self.allow_no_value: + expect_string += ( + "[Valueless]\n" + "option-without-value\n" + "\n" + ) + self.assertEqual(output.getvalue(), expect_string) def test_set_string_types(self): cf = self.fromstring("[sect]\n" @@ -458,6 +485,9 @@ cf = self.newconfig() self.assertRaises(ValueError, cf.add_section, "DEFAULT") +class SafeConfigParserTestCaseNoValue(SafeConfigParserTestCase): + allow_no_value = True + class SortedTestCase(RawConfigParserTestCase): def newconfig(self, defaults=None): self.cf = self.config_class(defaults=defaults, dict_type=SortedDict) @@ -487,7 +517,8 @@ ConfigParserTestCase, RawConfigParserTestCase, SafeConfigParserTestCase, - SortedTestCase + SortedTestCase, + SafeConfigParserTestCaseNoValue ) if __name__ == "__main__":