mirror of https://github.com/python/cpython.git
ConfigParser:
- don't allow setting options to non-string values; raise TypeError when the value is set, instead of raising an arbitrary exception later (such as when string interpolation is performed) - add tests, documentation (closes SF bug #810843)
This commit is contained in:
parent
bc12b01d83
commit
abc086fb0d
|
@ -238,7 +238,9 @@ option in the given \var{section}.
|
|||
|
||||
\begin{methoddesc}{set}{section, option, value}
|
||||
If the given section exists, set the given option to the specified value;
|
||||
otherwise raise \exception{NoSectionError}.
|
||||
otherwise raise \exception{NoSectionError}. \var{value} must be a
|
||||
string (\class{str} or \class{unicode}); if not, \exception{TypeError}
|
||||
is raised.
|
||||
\versionadded{1.6}
|
||||
\end{methoddesc}
|
||||
|
||||
|
|
|
@ -343,6 +343,8 @@ def has_option(self, section, option):
|
|||
|
||||
def set(self, section, option, value):
|
||||
"""Set an option."""
|
||||
if not isinstance(value, basestring):
|
||||
raise TypeError("option values must be strings")
|
||||
if not section or section == DEFAULTSECT:
|
||||
sectdict = self._defaults
|
||||
else:
|
||||
|
|
|
@ -211,6 +211,37 @@ def test_write(self):
|
|||
"\n"
|
||||
)
|
||||
|
||||
def test_set_string_types(self):
|
||||
cf = self.fromstring("[sect]\n"
|
||||
"option1=foo\n")
|
||||
# Check that we don't get an exception when setting values in
|
||||
# an existing section using strings:
|
||||
class mystr(str):
|
||||
pass
|
||||
cf.set("sect", "option1", "splat")
|
||||
cf.set("sect", "option1", mystr("splat"))
|
||||
cf.set("sect", "option2", "splat")
|
||||
cf.set("sect", "option2", mystr("splat"))
|
||||
try:
|
||||
unicode
|
||||
except NameError:
|
||||
pass
|
||||
else:
|
||||
cf.set("sect", "option1", unicode("splat"))
|
||||
cf.set("sect", "option2", unicode("splat"))
|
||||
|
||||
def test_set_nonstring_types(self):
|
||||
cf = self.fromstring("[sect]\n"
|
||||
"option1=foo\n")
|
||||
# Check that we get a TypeError when setting non-string values
|
||||
# in an existing section:
|
||||
self.assertRaises(TypeError, cf.set, "sect", "option1", 1)
|
||||
self.assertRaises(TypeError, cf.set, "sect", "option1", 1.0)
|
||||
self.assertRaises(TypeError, cf.set, "sect", "option1", object())
|
||||
self.assertRaises(TypeError, cf.set, "sect", "option2", 1)
|
||||
self.assertRaises(TypeError, cf.set, "sect", "option2", 1.0)
|
||||
self.assertRaises(TypeError, cf.set, "sect", "option2", object())
|
||||
|
||||
# shared by subclasses
|
||||
def get_interpolation_config(self):
|
||||
return self.fromstring(
|
||||
|
|
Loading…
Reference in New Issue