252
180
This error indicates that a line is badly written.
253
181
It is neither a valid ``key = value`` line,
254
182
nor a valid section marker line.
185
Traceback (most recent call last):
257
189
class DuplicateError(ConfigObjError):
259
191
The keyword or section specified already exists.
193
>>> raise DuplicateError
194
Traceback (most recent call last):
262
198
class ConfigspecError(ConfigObjError):
264
200
An error occured whilst parsing a configspec.
202
>>> raise ConfigspecError
203
Traceback (most recent call last):
267
207
class InterpolationError(ConfigObjError):
268
208
"""Base class for the two interpolation errors."""
270
class InterpolationLoopError(InterpolationError):
210
class InterpolationDepthError(InterpolationError):
271
211
"""Maximum interpolation depth exceeded in string interpolation."""
273
213
def __init__(self, option):
215
>>> raise InterpolationDepthError('yoda')
216
Traceback (most recent call last):
217
InterpolationDepthError: max interpolation depth exceeded in value "yoda".
274
219
InterpolationError.__init__(
276
'interpolation loop detected in value "%s".' % option)
221
'max interpolation depth exceeded in value "%s".' % option)
278
223
class RepeatSectionError(ConfigObjError):
280
225
This error indicates additional sections in a section with a
281
226
``__many__`` (repeated) section.
228
>>> raise RepeatSectionError
229
Traceback (most recent call last):
284
233
class MissingInterpolationOption(InterpolationError):
285
234
"""A value specified for interpolation was missing."""
287
236
def __init__(self, option):
238
>>> raise MissingInterpolationOption('yoda')
239
Traceback (most recent call last):
240
MissingInterpolationOption: missing option "yoda" in interpolation.
288
242
InterpolationError.__init__(
290
244
'missing option "%s" in interpolation.' % option)
292
class UnreprError(ConfigObjError):
293
"""An error parsing in unrepr mode."""
296
class InterpolationEngine(object):
298
A helper class to help perform string interpolation.
300
This class is an abstract base class; its descendants perform
304
# compiled regexp to use in self.interpolate()
305
_KEYCRE = re.compile(r"%\(([^)]*)\)s")
307
def __init__(self, section):
308
# the Section instance that "owns" this engine
309
self.section = section
311
def interpolate(self, key, value):
312
def recursive_interpolate(key, value, section, backtrail):
313
"""The function that does the actual work.
315
``value``: the string we're trying to interpolate.
316
``section``: the section in which that string was found
317
``backtrail``: a dict to keep track of where we've been,
318
to detect and prevent infinite recursion loops
320
This is similar to a depth-first-search algorithm.
322
# Have we been here already?
323
if backtrail.has_key((key, section.name)):
324
# Yes - infinite loop detected
325
raise InterpolationLoopError(key)
326
# Place a marker on our backtrail so we won't come back here again
327
backtrail[(key, section.name)] = 1
329
# Now start the actual work
330
match = self._KEYCRE.search(value)
332
# The actual parsing of the match is implementation-dependent,
333
# so delegate to our helper function
334
k, v, s = self._parse_match(match)
336
# That's the signal that no further interpolation is needed
339
# Further interpolation may be needed to obtain final value
340
replacement = recursive_interpolate(k, v, s, backtrail)
341
# Replace the matched string with its final value
342
start, end = match.span()
343
value = ''.join((value[:start], replacement, value[end:]))
344
new_search_start = start + len(replacement)
345
# Pick up the next interpolation key, if any, for next time
346
# through the while loop
347
match = self._KEYCRE.search(value, new_search_start)
349
# Now safe to come back here again; remove marker from backtrail
350
del backtrail[(key, section.name)]
354
# Back in interpolate(), all we have to do is kick off the recursive
355
# function with appropriate starting values
356
value = recursive_interpolate(key, value, self.section, {})
359
def _fetch(self, key):
360
"""Helper function to fetch values from owning section.
362
Returns a 2-tuple: the value, and the section where it was found.
364
# switch off interpolation before we try and fetch anything !
365
save_interp = self.section.main.interpolation
366
self.section.main.interpolation = False
368
# Start at section that "owns" this InterpolationEngine
369
current_section = self.section
371
# try the current section first
372
val = current_section.get(key)
376
val = current_section.get('DEFAULT', {}).get(key)
379
# move up to parent and try again
380
# top-level's parent is itself
381
if current_section.parent is current_section:
382
# reached top level, time to give up
384
current_section = current_section.parent
386
# restore interpolation to previous value before returning
387
self.section.main.interpolation = save_interp
389
raise MissingInterpolationOption(key)
390
return val, current_section
392
def _parse_match(self, match):
393
"""Implementation-dependent helper function.
395
Will be passed a match object corresponding to the interpolation
396
key we just found (e.g., "%(foo)s" or "$foo"). Should look up that
397
key in the appropriate config file section (using the ``_fetch()``
398
helper function) and return a 3-tuple: (key, value, section)
400
``key`` is the name of the key we're looking for
401
``value`` is the value found for that key
402
``section`` is a reference to the section where it was found
404
``key`` and ``section`` should be None if no further
405
interpolation should be performed on the resulting value
406
(e.g., if we interpolated "$$" and returned "$").
408
raise NotImplementedError
411
class ConfigParserInterpolation(InterpolationEngine):
412
"""Behaves like ConfigParser."""
413
_KEYCRE = re.compile(r"%\(([^)]*)\)s")
415
def _parse_match(self, match):
417
value, section = self._fetch(key)
418
return key, value, section
421
class TemplateInterpolation(InterpolationEngine):
422
"""Behaves like string.Template."""
424
_KEYCRE = re.compile(r"""
426
(?P<escaped>\$) | # Two $ signs
427
(?P<named>[_a-z][_a-z0-9]*) | # $name format
428
{(?P<braced>[^}]*)} # ${name} format
430
""", re.IGNORECASE | re.VERBOSE)
432
def _parse_match(self, match):
433
# Valid name (in or out of braces): fetch value from section
434
key = match.group('named') or match.group('braced')
436
value, section = self._fetch(key)
437
return key, value, section
438
# Escaped delimiter (e.g., $$): return single delimiter
439
if match.group('escaped') is not None:
440
# Return None for key and section to indicate it's time to stop
441
return None, self._delimiter, None
442
# Anything else: ignore completely, just return it unchanged
443
return None, match.group(), None
445
interpolation_engines = {
446
'configparser': ConfigParserInterpolation,
447
'template': TemplateInterpolation,
450
246
class Section(dict):
452
248
A dictionary-like object that represents a section in a config file.
454
It does string interpolation if the 'interpolation' attribute
250
It does string interpolation if the 'interpolate' attribute
455
251
of the 'main' object is set to True.
457
Interpolation is tried first from this object, then from the 'DEFAULT'
458
section of this object, next from the parent and its 'DEFAULT' section,
459
and so on until the main object is reached.
253
Interpolation is tried first from the 'DEFAULT' section of this object,
254
next from the 'DEFAULT' section of the parent, lastly the main object.
461
256
A Section will behave like an ordered dictionary - following the
462
257
order of the ``scalars`` and ``sections`` attributes.
1514
1382
'Parse error in value at line %s.',
1515
1383
ParseError, infile, cur_index)
1521
value = unrepr(value)
1522
except Exception, e:
1523
if type(e) == UnknownType:
1524
msg = 'Unknown name or type in value at line %s.'
1526
msg = 'Parse error in value at line %s.'
1527
self._handle_error(msg, UnreprError, infile,
1534
value = unrepr(value)
1535
except Exception, e:
1536
if isinstance(e, UnknownType):
1537
msg = 'Unknown name or type in value at line %s.'
1539
msg = 'Parse error in value at line %s.'
1540
self._handle_error(msg, UnreprError, infile,
1544
# extract comment and lists
1546
(value, comment) = self._handle_value(value)
1549
'Parse error in value at line %s.',
1550
ParseError, infile, cur_index)
1386
# extract comment and lists
1388
(value, comment) = self._handle_value(value)
1391
'Parse error in value at line %s.',
1392
ParseError, infile, cur_index)
1395
## print >> sys.stderr, sline
1553
1396
key = self._unquote(key)
1554
if this_section.has_key(key):
1397
if key in this_section:
1555
1398
self._handle_error(
1556
1399
'Duplicate keyword name at line %s.',
1557
1400
DuplicateError, infile, cur_index)
1560
# we set unrepr because if we have got this far we will never
1561
# be creating a new section
1562
this_section.__setitem__(key, value, unrepr=True)
1403
## print >> sys.stderr, this_section.name
1404
this_section[key] = value
1563
1405
this_section.inline_comments[key] = comment
1564
1406
this_section.comments[key] = comment_list
1407
## print >> sys.stderr, key, this_section[key]
1408
## if this_section.name is not None:
1409
## print >> sys.stderr, this_section
1410
## print >> sys.stderr, this_section.parent
1411
## print >> sys.stderr, this_section.parent[this_section.name]
1414
# it neither matched as a keyword
1415
# or a section marker
1417
'Invalid line at line "%s".',
1418
ParseError, infile, cur_index)
1567
1419
if self.indent_type is None:
1568
1420
# no indentation used, set the type accordingly
1569
1421
self.indent_type = ''
1571
if self._terminated:
1572
comment_list.append('')
1573
1422
# preserve the final comment
1574
1423
if not self and not self.initial_comment:
1575
1424
self.initial_comment = comment_list
1576
elif not reset_comment:
1577
1426
self.final_comment = comment_list
1578
self.list_values = temp_list_values
1580
1428
def _match_depth(self, sect, depth):
2024
2003
You can then use the ``flatten_errors`` function to turn your nested
2025
2004
results dictionary into a flattened list of failures - useful for
2026
2005
displaying meaningful error messages.
2008
... from validate import Validator
2009
... except ImportError:
2010
... print >> sys.stderr, 'Cannot import the Validator object, skipping the related tests'
2027
... '''.split('\\n')
2028
... configspec = '''
2029
... test1= integer(30,50)
2032
... test4=float(6.0)
2034
... test1=integer(30,50)
2037
... test4=float(6.0)
2039
... test1=integer(30,50)
2042
... test4=float(6.0)
2043
... '''.split('\\n')
2044
... val = Validator()
2045
... c1 = ConfigObj(config, configspec=configspec)
2046
... test = c1.validate(val)
2057
... 'sub section': {
2066
>>> val.check(c1.configspec['test4'], c1['test4'])
2067
Traceback (most recent call last):
2068
VdtValueTooSmallError: the value "5.0" is too small.
2070
>>> val_test_config = '''
2075
... key2 = 1.1, 3.0, 17, 6.8
2078
... key2 = True'''.split('\\n')
2079
>>> val_test_configspec = '''
2084
... key2 = float_list(4)
2086
... key = option(option1, option2)
2087
... key2 = boolean'''.split('\\n')
2088
>>> val_test = ConfigObj(val_test_config, configspec=val_test_configspec)
2089
>>> val_test.validate(val)
2091
>>> val_test['key'] = 'text not a digit'
2092
>>> val_res = val_test.validate(val)
2093
>>> val_res == {'key2': True, 'section': True, 'key': False}
2095
>>> configspec = '''
2096
... test1=integer(30,50, default=40)
2097
... test2=string(default="hello")
2098
... test3=integer(default=3)
2099
... test4=float(6.0, default=6.0)
2101
... test1=integer(30,50, default=40)
2102
... test2=string(default="hello")
2103
... test3=integer(default=3)
2104
... test4=float(6.0, default=6.0)
2106
... test1=integer(30,50, default=40)
2107
... test2=string(default="hello")
2108
... test3=integer(default=3)
2109
... test4=float(6.0, default=6.0)
2110
... '''.split('\\n')
2111
>>> default_test = ConfigObj(['test1=30'], configspec=configspec)
2113
{'test1': '30', 'section': {'sub section': {}}}
2114
>>> default_test.validate(val)
2116
>>> default_test == {
2118
... 'test2': 'hello',
2123
... 'test2': 'hello',
2126
... 'sub section': {
2129
... 'test2': 'hello',
2136
Now testing with repeated sections : BIG TEST
2138
>>> repeated_1 = '''
2140
... [[__many__]] # spec for a dog
2141
... fleas = boolean(default=True)
2142
... tail = option(long, short, default=long)
2143
... name = string(default=rover)
2144
... [[[__many__]]] # spec for a puppy
2145
... name = string(default="son of rover")
2146
... age = float(default=0.0)
2148
... [[__many__]] # spec for a cat
2149
... fleas = boolean(default=True)
2150
... tail = option(long, short, default=short)
2151
... name = string(default=pussy)
2152
... [[[__many__]]] # spec for a kitten
2153
... name = string(default="son of pussy")
2154
... age = float(default=0.0)
2155
... '''.split('\\n')
2156
>>> repeated_2 = '''
2159
... # blank dogs with puppies
2160
... # should be filled in by the configspec
2175
... # blank cats with kittens
2176
... # should be filled in by the configspec
2189
... '''.split('\\n')
2190
>>> repeated_3 = '''
2201
... '''.split('\\n')
2202
>>> repeated_4 = '''
2205
... name = string(default=Michael)
2206
... age = float(default=0.0)
2207
... sex = option(m, f, default=m)
2208
... '''.split('\\n')
2209
>>> repeated_5 = '''
2212
... fleas = boolean(default=True)
2213
... tail = option(long, short, default=short)
2214
... name = string(default=pussy)
2215
... [[[description]]]
2216
... height = float(default=3.3)
2217
... weight = float(default=6)
2219
... fur = option(black, grey, brown, "tortoise shell", default=black)
2220
... condition = integer(0,10, default=5)
2221
... '''.split('\\n')
2222
>>> from validate import Validator
2223
>>> val= Validator()
2224
>>> repeater = ConfigObj(repeated_2, configspec=repeated_1)
2225
>>> repeater.validate(val)
2232
... 'name': 'rover',
2233
... 'puppy1': {'name': 'son of rover', 'age': 0.0},
2234
... 'puppy2': {'name': 'son of rover', 'age': 0.0},
2235
... 'puppy3': {'name': 'son of rover', 'age': 0.0},
2240
... 'name': 'rover',
2241
... 'puppy1': {'name': 'son of rover', 'age': 0.0},
2242
... 'puppy2': {'name': 'son of rover', 'age': 0.0},
2243
... 'puppy3': {'name': 'son of rover', 'age': 0.0},
2248
... 'name': 'rover',
2249
... 'puppy1': {'name': 'son of rover', 'age': 0.0},
2250
... 'puppy2': {'name': 'son of rover', 'age': 0.0},
2251
... 'puppy3': {'name': 'son of rover', 'age': 0.0},
2257
... 'tail': 'short',
2258
... 'name': 'pussy',
2259
... 'kitten1': {'name': 'son of pussy', 'age': 0.0},
2260
... 'kitten2': {'name': 'son of pussy', 'age': 0.0},
2261
... 'kitten3': {'name': 'son of pussy', 'age': 0.0},
2265
... 'tail': 'short',
2266
... 'name': 'pussy',
2267
... 'kitten1': {'name': 'son of pussy', 'age': 0.0},
2268
... 'kitten2': {'name': 'son of pussy', 'age': 0.0},
2269
... 'kitten3': {'name': 'son of pussy', 'age': 0.0},
2273
... 'tail': 'short',
2274
... 'name': 'pussy',
2275
... 'kitten1': {'name': 'son of pussy', 'age': 0.0},
2276
... 'kitten2': {'name': 'son of pussy', 'age': 0.0},
2277
... 'kitten3': {'name': 'son of pussy', 'age': 0.0},
2282
>>> repeater = ConfigObj(repeated_3, configspec=repeated_1)
2283
>>> repeater.validate(val)
2287
... 'cat1': {'fleas': True, 'tail': 'short', 'name': 'pussy'},
2288
... 'cat2': {'fleas': True, 'tail': 'short', 'name': 'pussy'},
2289
... 'cat3': {'fleas': True, 'tail': 'short', 'name': 'pussy'},
2292
... 'dog1': {'fleas': True, 'tail': 'long', 'name': 'rover'},
2293
... 'dog2': {'fleas': True, 'tail': 'long', 'name': 'rover'},
2294
... 'dog3': {'fleas': True, 'tail': 'long', 'name': 'rover'},
2298
>>> repeater = ConfigObj(configspec=repeated_4)
2299
>>> repeater['Michael'] = {}
2300
>>> repeater.validate(val)
2303
... 'Michael': {'age': 0.0, 'name': 'Michael', 'sex': 'm'},
2306
>>> repeater = ConfigObj(repeated_3, configspec=repeated_5)
2308
... 'dogs': {'dog1': {}, 'dog2': {}, 'dog3': {}},
2309
... 'cats': {'cat1': {}, 'cat2': {}, 'cat3': {}},
2312
>>> repeater.validate(val)
2315
... 'dogs': {'dog1': {}, 'dog2': {}, 'dog3': {}},
2319
... 'tail': 'short',
2320
... 'name': 'pussy',
2321
... 'description': {
2323
... 'height': 3.2999999999999998,
2324
... 'coat': {'fur': 'black', 'condition': 5},
2329
... 'tail': 'short',
2330
... 'name': 'pussy',
2331
... 'description': {
2333
... 'height': 3.2999999999999998,
2334
... 'coat': {'fur': 'black', 'condition': 5},
2339
... 'tail': 'short',
2340
... 'name': 'pussy',
2341
... 'description': {
2343
... 'height': 3.2999999999999998,
2344
... 'coat': {'fur': 'black', 'condition': 5},
2351
Test that interpolation is preserved for validated string values.
2352
Also check that interpolation works in configspecs.
2354
>>> t['DEFAULT'] = {}
2355
>>> t['DEFAULT']['test'] = 'a'
2356
>>> t['test'] = '%(test)s'
2360
>>> t.configspec = {'test': 'string'}
2363
>>> t.interpolation = False
2365
{'test': '%(test)s', 'DEFAULT': {'test': 'a'}}
2367
... 'interpolated string = string(default="fuzzy-%(man)s")',
2371
>>> c = ConfigObj(configspec=specs)
2374
>>> c['interpolated string']
2377
FIXME: Above tests will fail if we couldn't import Validator (the ones
2378
that don't raise errors will produce different output and still fail as
2028
2381
if section is None:
2029
2382
if self.configspec is None:
2279
"""*A programming language is a medium of expression.* - Paul Graham"""
2652
# FIXME: test error code for badly built multiline values
2653
# FIXME: test handling of StringIO
2654
# FIXME: test interpolation with writing
2658
Dummy function to hold some of the doctests.
2695
... 'keys11': 'val1',
2696
... 'keys13': 'val3',
2697
... 'keys12': 'val2',
2700
... 'section 2 sub 1': {
2703
... 'keys21': 'val1',
2704
... 'keys22': 'val2',
2705
... 'keys23': 'val3',
2710
... 'a' = b # !"$%^&*(),::;'@~#= 33
2711
... "b" = b #= 6, 33
2712
... ''' .split('\\n')
2713
>>> t2 = ConfigObj(t)
2714
>>> assert t2 == {'a': 'b', 'b': 'b'}
2715
>>> t2.inline_comments['b'] = ''
2717
>>> assert t2.write() == ['','b = b', '']
2719
# Test ``list_values=False`` stuff
2721
... key1 = no quotes
2722
... key2 = 'single quotes'
2723
... key3 = "double quotes"
2724
... key4 = "list", 'with', several, "quotes"
2726
>>> cfg = ConfigObj(c.splitlines(), list_values=False)
2727
>>> cfg == {'key1': 'no quotes', 'key2': "'single quotes'",
2728
... 'key3': '"double quotes"',
2729
... 'key4': '"list", \\'with\\', several, "quotes"'
2732
>>> cfg = ConfigObj(list_values=False)
2733
>>> cfg['key1'] = 'Multiline\\nValue'
2734
>>> cfg['key2'] = '''"Value" with 'quotes' !'''
2736
["key1 = '''Multiline\\nValue'''", 'key2 = "Value" with \\'quotes\\' !']
2737
>>> cfg.list_values = True
2738
>>> cfg.write() == ["key1 = '''Multiline\\nValue'''",
2739
... 'key2 = \\'\\'\\'"Value" with \\'quotes\\' !\\'\\'\\'']
2742
Test flatten_errors:
2744
>>> from validate import Validator, VdtValueTooSmallError
2760
... '''.split('\\n')
2761
>>> configspec = '''
2762
... test1= integer(30,50)
2765
... test4=float(6.0)
2767
... test1=integer(30,50)
2770
... test4=float(6.0)
2772
... test1=integer(30,50)
2775
... test4=float(6.0)
2776
... '''.split('\\n')
2777
>>> val = Validator()
2778
>>> c1 = ConfigObj(config, configspec=configspec)
2779
>>> res = c1.validate(val)
2780
>>> flatten_errors(c1, res) == [([], 'test4', False), (['section',
2781
... 'sub section'], 'test4', False), (['section'], 'test4', False)]
2783
>>> res = c1.validate(val, preserve_errors=True)
2784
>>> check = flatten_errors(c1, res)
2788
(['section', 'sub section'], 'test4')
2790
(['section'], 'test4')
2791
>>> for entry in check:
2792
... isinstance(entry[2], VdtValueTooSmallError)
2793
... print str(entry[2])
2795
the value "5.0" is too small.
2797
the value "5.0" is too small.
2799
the value "5.0" is too small.
2801
Test unicode handling, BOM, write witha file like object and line endings :
2803
... # initial comment
2804
... # inital comment 2
2806
... test1 = some value
2808
... test2 = another value # inline comment
2809
... # section comment
2810
... [section] # inline comment
2811
... test = test # another inline comment
2815
... # final comment2
2817
>>> u = u_base.encode('utf_8').splitlines(True)
2818
>>> u[0] = BOM_UTF8 + u[0]
2819
>>> uc = ConfigObj(u)
2820
>>> uc.encoding = None
2823
>>> uc == {'test1': 'some value', 'test2': 'another value',
2824
... 'section': {'test': 'test', 'test2': 'test2'}}
2826
>>> uc = ConfigObj(u, encoding='utf_8', default_encoding='latin-1')
2829
>>> isinstance(uc['test1'], unicode)
2835
>>> uc['latin1'] = "This costs lot's of "
2836
>>> a_list = uc.write()
2839
>>> isinstance(a_list[0], str)
2841
>>> a_list[0].startswith(BOM_UTF8)
2843
>>> u = u_base.replace('\\n', '\\r\\n').encode('utf_8').splitlines(True)
2844
>>> uc = ConfigObj(u)
2847
>>> uc.newlines = '\\r'
2848
>>> from cStringIO import StringIO
2849
>>> file_like = StringIO()
2850
>>> uc.write(file_like)
2851
>>> file_like.seek(0)
2852
>>> uc2 = ConfigObj(file_like)
2855
>>> uc2.filename is None
2857
>>> uc2.newlines == '\\r'
2861
if __name__ == '__main__':
2862
# run the code tests in doctest format
2865
key1= val # comment 1
2866
key2= val # comment 2
2869
key1= val # comment 5
2870
key2= val # comment 6
2873
key1= val # comment 9
2874
key2= val # comment 10
2876
[[lev2ba]] # comment 12
2877
key1= val # comment 13
2879
[[lev2bb]] # comment 15
2880
key1= val # comment 16
2882
[lev1c] # comment 18
2884
[[lev2c]] # comment 20
2886
[[[lev3c]]] # comment 22
2887
key1 = val # comment 23"""
2893
["section 1"] # comment
2902
[['section 2 sub 1']]
2907
name1 = """ a single line value """ # comment
2908
name2 = \''' another single line value \''' # comment
2909
name3 = """ a single line value """
2910
name4 = \''' another single line value \'''
2927
\''' # I guess this is a comment too
2931
m = sys.modules.get('__main__')
2932
globs = m.__dict__.copy()
2933
a = ConfigObj(testconfig1.split('\n'), raise_errors=True)
2934
b = ConfigObj(testconfig2.split('\n'), raise_errors=True)
2935
i = ConfigObj(testconfig6.split('\n'), raise_errors=True)
2937
'INTP_VER': INTP_VER,
2942
doctest.testmod(m, globs=globs)
2953
Better support for configuration from multiple files, including tracking
2954
*where* the original file came from and writing changes to the correct
2958
Make ``newline`` an option (as well as an attribute) ?
2960
``UTF16`` encoded files, when returned as a list of lines, will have the
2961
BOM at the start of every line. Should this be removed from all but the
2964
Option to set warning type for unicode decode ? (Defaults to strict).
2966
A method to optionally remove uniform indentation from multiline values.
2967
(do as an example of using ``walk`` - along with string-escape)
2969
Should the results dictionary from validate be an ordered dictionary if
2970
`odict <http://www.voidspace.org.uk/python/odict.html>`_ is available ?
2972
Implement a better ``__repr__`` ? (``ConfigObj({})``)
2974
Implement some of the sequence methods (which include slicing) from the
2977
INCOMPATIBLE CHANGES
2978
====================
2980
(I have removed a lot of needless complications - this list is probably not
2981
conclusive, many option/attribute/method names have changed)
2985
The only valid divider is '='
2987
We've removed line continuations with '\'
2989
No recursive lists in values
2993
No distinction between flatfiles and non flatfiles
2995
Change in list syntax - use commas to indicate list, not parentheses
2996
(square brackets and parentheses are no longer recognised as lists)
2998
';' is no longer valid for comments and no multiline comments
3002
We don't allow empty values - have to use '' or ""
3004
In ConfigObj 3 - setting a non-flatfile member to ``None`` would
3005
initialise it as an empty section.
3007
The escape entities '&mjf-lf;' and '&mjf-quot;' have gone
3008
replaced by triple quote, multiple line values.
3010
The ``newline``, ``force_return``, and ``default`` options have gone
3012
The ``encoding`` and ``backup_encoding`` methods have gone - replaced
3013
with the ``encode`` and ``decode`` methods.
3015
``fileerror`` and ``createempty`` options have become ``file_error`` and
3018
Partial configspecs (for specifying the order members should be written
3019
out and which should be present) have gone. The configspec is no longer
3020
used to specify order for the ``write`` method.
3022
Exceeding the maximum depth of recursion in string interpolation now
3023
raises an error ``InterpolationDepthError``.
3025
Specifying a value for interpolation which doesn't exist now raises an
3026
error ``MissingInterpolationOption`` (instead of merely being ignored).
3028
The ``writein`` method has been removed.
3030
The comments attribute is now a list (``inline_comments`` equates to the
3031
old comments attribute)
3036
``validate`` doesn't report *extra* values or sections.
3038
You can't have a keyword with the same name as a section (in the same
3039
section). They are both dictionary keys - so they would overlap.
3041
ConfigObj doesn't quote and unquote values if ``list_values=False``.
3042
This means that leading or trailing whitespace in values will be lost when
3043
writing. (Unless you manually quote).
3045
Interpolation checks first the 'DEFAULT' subsection of the current
3046
section, next it checks the 'DEFAULT' section of the parent section,
3047
last it checks the 'DEFAULT' section of the main section.
3049
Logically a 'DEFAULT' section should apply to all subsections of the *same
3050
parent* - this means that checking the 'DEFAULT' subsection in the
3051
*current section* is not necessarily logical ?
3053
In order to simplify unicode support (which is possibly of limited value
3054
in a config file) I have removed automatic support and added the
3055
``encode`` and ``decode methods, which can be used to transform keys and
3056
entries. Because the regex looks for specific values on inital parsing
3057
(i.e. the quotes and the equals signs) it can only read ascii compatible
3058
encodings. For unicode use ``UTF8``, which is ASCII compatible.
3060
Does it matter that we don't support the ':' divider, which is supported
3061
by ``ConfigParser`` ?
3063
The regular expression correctly removes the value -
3064
``"'hello', 'goodbye'"`` and then unquote just removes the front and
3065
back quotes (called from ``_handle_value``). What should we do ??
3066
(*ought* to raise exception because it's an invalid value if lists are
3067
off *sigh*. This is not what you want if you want to do your own list
3068
processing - would be *better* in this case not to unquote.)
3070
String interpolation and validation don't play well together. When
3071
validation changes type it sets the value. This will correctly fetch the
3072
value using interpolation - but then overwrite the interpolation reference.
3073
If the value is unchanged by validation (it's a string) - but other types
3080
List values allow you to specify multiple values for a keyword. This
3081
maps to a list as the resulting Python object when parsed.
3083
The syntax for lists is easy. A list is a comma separated set of values.
3084
If these values contain quotes, the hash mark, or commas, then the values
3085
can be surrounded by quotes. e.g. : ::
3087
keyword = value1, 'value 2', "value 3"
3089
If a value needs to be a list, but only has one member, then you indicate
3090
this with a trailing comma. e.g. : ::
3092
keyword = "single value",
3094
If a value needs to be a list, but it has no members, then you indicate
3095
this with a single comma. e.g. : ::
3097
keyword = , # an empty list
3099
Using triple quotes it will be possible for single values to contain
3100
newlines and *both* single quotes and double quotes. Triple quotes aren't
3101
allowed in list values. This means that the members of list values can't
3102
contain carriage returns (or line feeds :-) or both quote values.
3110
Removed ``BOM_UTF8`` from ``__all__``.
3112
The ``BOM`` attribute has become a boolean. (Defaults to ``False``.) It is
3113
*only* ``True`` for the ``UTF16`` encoding.
3115
File like objects no longer need a ``seek`` attribute.
3117
ConfigObj no longer keeps a reference to file like objects. Instead the
3118
``write`` method takes a file like object as an optional argument. (Which
3119
will be used in preference of the ``filename`` attribute if htat exists as
3122
Full unicode support added. New options/attributes ``encoding``,
3123
``default_encoding``.
3125
utf16 files decoded to unicode.
3127
If ``BOM`` is ``True``, but no encoding specified, then the utf8 BOM is
3128
written out at the start of the file. (It will normally only be ``True`` if
3129
the utf8 BOM was found when the file was read.)
3131
File paths are *not* converted to absolute paths, relative paths will
3132
remain relative as the ``filename`` attribute.
3134
Fixed bug where ``final_comment`` wasn't returned if ``write`` is returning
3140
Added ``True``, ``False``, and ``enumerate`` if they are not defined.
3141
(``True`` and ``False`` are needed for *early* versions of Python 2.2,
3142
``enumerate`` is needed for all versions ofPython 2.2)
3144
Deprecated ``istrue``, replaced it with ``as_bool``.
3146
Added ``as_int`` and ``as_float``.
3148
utf8 and utf16 BOM handled in an endian agnostic way.
3153
Validation no longer done on the 'DEFAULT' section (only in the root
3154
level). This allows interpolation in configspecs.
3156
Change in validation syntax implemented in validate 0.2.1
3163
Added ``merge``, a recursive update.
3165
Added ``preserve_errors`` to ``validate`` and the ``flatten_errors``
3168
Thanks to Matthew Brett for suggestions and helping me iron out bugs.
3170
Fixed bug where a config file is *all* comment, the comment will now be
3171
``initial_comment`` rather than ``final_comment``.
3176
Fixed bug in ``create_empty``. Thanks to Paul Jimenez for the report.
3181
Fixed bug in ``Section.walk`` when transforming names as well as values.
3183
Added the ``istrue`` method. (Fetches the boolean equivalent of a string
3186
Fixed ``list_values=False`` - they are now only quoted/unquoted if they
3187
are multiline values.
3189
List values are written as ``item, item`` rather than ``item,item``.
3196
Fixed typo in ``write`` method. (Testing for the wrong value when resetting
3204
Fixed bug in ``setdefault`` - creating a new section *wouldn't* return
3205
a reference to the new section.
3210
Removed ``PositionError``.
3212
Allowed quotes around keys as documented.
3214
Fixed bug with commas in comments. (matched as a list value)
3221
Fixed bug in initialising ConfigObj from a ConfigObj.
3223
Changed the mailing list address.
3230
Fixed bug in ``Section.__delitem__`` oops.
3235
Interpolation is switched off before writing out files.
3237
Fixed bug in handling ``StringIO`` instances. (Thanks to report from
3238
"Gustavo Niemeyer" <gustavo@niemeyer.net>)
3240
Moved the doctests from the ``__init__`` method to a separate function.
3241
(For the sake of IDE calltips).
3248
String values unchanged by validation *aren't* reset. This preserves
3249
interpolation in string values.
3254
None from a default is turned to '' if stringify is off - because setting
3255
a value to None raises an error.
3264
Actually added the RepeatSectionError class ;-)
3269
If ``stringify`` is off - list values are preserved by the ``validate``
3277
Fixed ``simpleVal``.
3279
Added ``RepeatSectionError`` error if you have additional sections in a
3280
section with a ``__many__`` (repeated) section.
3284
Reworked the ConfigObj._parse, _handle_error and _multiline methods:
3285
mutated the self._infile, self._index and self._maxline attributes into
3286
local variables and method parameters
3288
Reshaped the ConfigObj._multiline method to better reflect its semantics
3290
Changed the "default_test" test in ConfigObj.validate to check the fix for
3291
the bug in validate.Validator.check
3298
Updated comments at top
3305
Implemented repeated sections.
3309
Added test for interpreter version: raises RuntimeError if earlier than
3317
Implemented default values in configspecs.
3321
Fixed naked except: clause in validate that was silencing the fact
3322
that Python2.2 does not have dict.pop
3329
Bug fix causing error if file didn't exist.
3336
Adjusted doctests for Python 2.2.3 compatibility
3343
Added the inline_comments attribute
3345
We now preserve and rewrite all comments in the config file
3347
configspec is now a section attribute
3349
The validate method changes values in place
3351
Added InterpolationError
3353
The errors now have line number, line, and message attributes. This
3354
simplifies error handling
3363
Fixed bug in Section.pop (now doesn't raise KeyError if a default value
3366
Replaced ``basestring`` with ``types.StringTypes``
3368
Removed the ``writein`` method
3377
Indentation in config file is not significant anymore, subsections are
3378
designated by repeating square brackets
3380
Adapted all tests and docs to the new format
3394
Reformatted final docstring in ReST format, indented it for easier folding
3396
Code tests converted to doctest format, and scattered them around
3397
in various docstrings
3399
Walk method rewritten using scalars and sections attributes
3406
Changed Validator and SimpleVal "test" methods to "check"
3413
Changed Section.sequence to Section.scalars and Section.sections
3415
Added Section.configspec
3417
Sections in the root section now have no extra indentation
3419
Comments now better supported in Section and preserved by ConfigObj
3421
Comments also written out
3423
Implemented initial_comment and final_comment
3425
A scalar value after a section will now raise an error
3430
Fixed a couple of bugs
3432
Can now pass a tuple instead of a list
3434
Simplified dict and walk methods
3436
Added __str__ to Section
3448
The stringify option implemented. On by default.
3453
Renamed private attributes with a single underscore prefix.
3455
Changes to interpolation - exceeding recursion depth, or specifying a
3456
missing value, now raise errors.
3458
Changes for Python 2.2 compatibility. (changed boolean tests - removed
3459
``is True`` and ``is False``)
3461
Added test for duplicate section and member (and fixed bug)
3475
Now properly handles values including comments and lists.
3477
Better error handling.
3479
String interpolation.
3481
Some options implemented.
3483
You can pass a Section a dictionary to initialise it.
3485
Setting a Section member to a dictionary will create a Section instance.
3492
Experimental reader.
3494
A reasonably elegant implementation - a basic reader in 160 lines of code.
3496
*A programming language is a medium of expression.* - Paul Graham
added
removed
bzrlib/util/configobj/configobj.py
