149
161
'indent_type': None,
150
162
'encoding': None,
151
163
'default_encoding': None,
165
'write_empty_values': False,
173
raise ImportError('compiler module not available')
174
p = compiler.parse(s)
175
return p.getChildren()[1].getChildren()[0].getChildren()[1]
178
class UnknownType(Exception):
182
class Builder(object):
185
m = getattr(self, 'build_' + o.__class__.__name__, None)
187
raise UnknownType(o.__class__.__name__)
190
def build_List(self, o):
191
return map(self.build, o.getChildren())
193
def build_Const(self, o):
196
def build_Dict(self, o):
198
i = iter(map(self.build, o.getChildren()))
203
def build_Tuple(self, o):
204
return tuple(self.build_List(o))
206
def build_Name(self, o):
211
if o.name == 'False':
215
raise UnknownType('Undefined Name')
217
def build_Add(self, o):
218
real, imag = map(self.build_Const, o.getChildren())
222
raise UnknownType('Add')
223
if not isinstance(imag, complex) or imag.real != 0.0:
224
raise UnknownType('Add')
227
def build_Getattr(self, o):
228
parent = self.build(o.expr)
229
return getattr(parent, o.attrname)
231
def build_UnarySub(self, o):
232
return -self.build_Const(o.getChildren()[0])
234
def build_UnaryAdd(self, o):
235
return self.build_Const(o.getChildren()[0])
244
return _builder.build(getObj(s))
154
248
class ConfigObjError(SyntaxError):
156
250
This is the base class for all errors that ConfigObj raises.
157
251
It is a subclass of SyntaxError.
159
>>> raise ConfigObjError
160
Traceback (most recent call last):
163
253
def __init__(self, message='', line_number=None, line=''):
165
255
self.line_number = line_number
166
self.message = message
167
256
SyntaxError.__init__(self, message)
169
259
class NestingError(ConfigObjError):
171
261
This error indicates a level of nesting that doesn't match.
173
>>> raise NestingError
174
Traceback (most recent call last):
178
265
class ParseError(ConfigObjError):
180
267
This error indicates that a line is badly written.
181
268
It is neither a valid ``key = value`` line,
182
269
nor a valid section marker line.
185
Traceback (most recent call last):
273
class ReloadError(IOError):
275
A 'reload' operation failed.
276
This exception is a subclass of ``IOError``.
279
IOError.__init__(self, 'reload failed, filename is not set.')
189
282
class DuplicateError(ConfigObjError):
191
284
The keyword or section specified already exists.
193
>>> raise DuplicateError
194
Traceback (most recent call last):
198
288
class ConfigspecError(ConfigObjError):
200
290
An error occured whilst parsing a configspec.
202
>>> raise ConfigspecError
203
Traceback (most recent call last):
207
294
class InterpolationError(ConfigObjError):
208
295
"""Base class for the two interpolation errors."""
210
class InterpolationDepthError(InterpolationError):
298
class InterpolationLoopError(InterpolationError):
211
299
"""Maximum interpolation depth exceeded in string interpolation."""
213
301
def __init__(self, option):
215
>>> raise InterpolationDepthError('yoda')
216
Traceback (most recent call last):
217
InterpolationDepthError: max interpolation depth exceeded in value "yoda".
219
302
InterpolationError.__init__(
221
'max interpolation depth exceeded in value "%s".' % option)
304
'interpolation loop detected in value "%s".' % option)
223
307
class RepeatSectionError(ConfigObjError):
225
309
This error indicates additional sections in a section with a
226
310
``__many__`` (repeated) section.
228
>>> raise RepeatSectionError
229
Traceback (most recent call last):
233
314
class MissingInterpolationOption(InterpolationError):
234
315
"""A value specified for interpolation was missing."""
236
317
def __init__(self, option):
238
>>> raise MissingInterpolationOption('yoda')
239
Traceback (most recent call last):
240
MissingInterpolationOption: missing option "yoda" in interpolation.
242
318
InterpolationError.__init__(
244
320
'missing option "%s" in interpolation.' % option)
323
class UnreprError(ConfigObjError):
324
"""An error parsing in unrepr mode."""
328
class InterpolationEngine(object):
330
A helper class to help perform string interpolation.
332
This class is an abstract base class; its descendants perform
336
# compiled regexp to use in self.interpolate()
337
_KEYCRE = re.compile(r"%\(([^)]*)\)s")
339
def __init__(self, section):
340
# the Section instance that "owns" this engine
341
self.section = section
344
def interpolate(self, key, value):
345
def recursive_interpolate(key, value, section, backtrail):
346
"""The function that does the actual work.
348
``value``: the string we're trying to interpolate.
349
``section``: the section in which that string was found
350
``backtrail``: a dict to keep track of where we've been,
351
to detect and prevent infinite recursion loops
353
This is similar to a depth-first-search algorithm.
355
# Have we been here already?
356
if (key, section.name) in backtrail:
357
# Yes - infinite loop detected
358
raise InterpolationLoopError(key)
359
# Place a marker on our backtrail so we won't come back here again
360
backtrail[(key, section.name)] = 1
362
# Now start the actual work
363
match = self._KEYCRE.search(value)
365
# The actual parsing of the match is implementation-dependent,
366
# so delegate to our helper function
367
k, v, s = self._parse_match(match)
369
# That's the signal that no further interpolation is needed
372
# Further interpolation may be needed to obtain final value
373
replacement = recursive_interpolate(k, v, s, backtrail)
374
# Replace the matched string with its final value
375
start, end = match.span()
376
value = ''.join((value[:start], replacement, value[end:]))
377
new_search_start = start + len(replacement)
378
# Pick up the next interpolation key, if any, for next time
379
# through the while loop
380
match = self._KEYCRE.search(value, new_search_start)
382
# Now safe to come back here again; remove marker from backtrail
383
del backtrail[(key, section.name)]
387
# Back in interpolate(), all we have to do is kick off the recursive
388
# function with appropriate starting values
389
value = recursive_interpolate(key, value, self.section, {})
393
def _fetch(self, key):
394
"""Helper function to fetch values from owning section.
396
Returns a 2-tuple: the value, and the section where it was found.
398
# switch off interpolation before we try and fetch anything !
399
save_interp = self.section.main.interpolation
400
self.section.main.interpolation = False
402
# Start at section that "owns" this InterpolationEngine
403
current_section = self.section
405
# try the current section first
406
val = current_section.get(key)
410
val = current_section.get('DEFAULT', {}).get(key)
413
# move up to parent and try again
414
# top-level's parent is itself
415
if current_section.parent is current_section:
416
# reached top level, time to give up
418
current_section = current_section.parent
420
# restore interpolation to previous value before returning
421
self.section.main.interpolation = save_interp
423
raise MissingInterpolationOption(key)
424
return val, current_section
427
def _parse_match(self, match):
428
"""Implementation-dependent helper function.
430
Will be passed a match object corresponding to the interpolation
431
key we just found (e.g., "%(foo)s" or "$foo"). Should look up that
432
key in the appropriate config file section (using the ``_fetch()``
433
helper function) and return a 3-tuple: (key, value, section)
435
``key`` is the name of the key we're looking for
436
``value`` is the value found for that key
437
``section`` is a reference to the section where it was found
439
``key`` and ``section`` should be None if no further
440
interpolation should be performed on the resulting value
441
(e.g., if we interpolated "$$" and returned "$").
443
raise NotImplementedError()
447
class ConfigParserInterpolation(InterpolationEngine):
448
"""Behaves like ConfigParser."""
449
_KEYCRE = re.compile(r"%\(([^)]*)\)s")
451
def _parse_match(self, match):
453
value, section = self._fetch(key)
454
return key, value, section
458
class TemplateInterpolation(InterpolationEngine):
459
"""Behaves like string.Template."""
461
_KEYCRE = re.compile(r"""
463
(?P<escaped>\$) | # Two $ signs
464
(?P<named>[_a-z][_a-z0-9]*) | # $name format
465
{(?P<braced>[^}]*)} # ${name} format
467
""", re.IGNORECASE | re.VERBOSE)
469
def _parse_match(self, match):
470
# Valid name (in or out of braces): fetch value from section
471
key = match.group('named') or match.group('braced')
473
value, section = self._fetch(key)
474
return key, value, section
475
# Escaped delimiter (e.g., $$): return single delimiter
476
if match.group('escaped') is not None:
477
# Return None for key and section to indicate it's time to stop
478
return None, self._delimiter, None
479
# Anything else: ignore completely, just return it unchanged
480
return None, match.group(), None
483
interpolation_engines = {
484
'configparser': ConfigParserInterpolation,
485
'template': TemplateInterpolation,
489
def __newobj__(cls, *args):
491
return cls.__new__(cls, *args)
246
493
class Section(dict):
248
495
A dictionary-like object that represents a section in a config file.
250
It does string interpolation if the 'interpolate' attribute
497
It does string interpolation if the 'interpolation' attribute
251
498
of the 'main' object is set to True.
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.
500
Interpolation is tried first from this object, then from the 'DEFAULT'
501
section of this object, next from the parent and its 'DEFAULT' section,
502
and so on until the main object is reached.
256
504
A Section will behave like an ordered dictionary - following the
257
505
order of the ``scalars`` and ``sections`` attributes.
258
506
You can use this to change the order of members.
260
508
Iteration follows the order: scalars, then sections.
263
_KEYCRE = re.compile(r"%\(([^)]*)\)s|.")
512
def __setstate__(self, state):
513
dict.update(self, state[0])
514
self.__dict__.update(state[1])
516
def __reduce__(self):
517
state = (dict(self), self.__dict__)
518
return (__newobj__, (self.__class__,), state)
265
521
def __init__(self, parent, depth, main, indict=None, name=None):
279
535
# level of nesting depth of this Section
280
536
self.depth = depth
537
# purely for information
541
# we do this explicitly so that __setitem__ is used properly
542
# (rather than just passing to ``dict.__init__``)
543
for entry, value in indict.iteritems():
547
def _initialise(self):
281
548
# the sequence of scalar values in this Section
282
549
self.scalars = []
283
550
# the sequence of sections in this Section
284
551
self.sections = []
285
# purely for information
287
552
# for comments :-)
288
553
self.comments = {}
289
554
self.inline_comments = {}
556
self.configspec = None
293
558
self.defaults = []
295
# we do this explicitly so that __setitem__ is used properly
296
# (rather than just passing to ``dict.__init__``)
298
self[entry] = indict[entry]
300
def _interpolate(self, value):
301
"""Nicked from ConfigParser."""
302
depth = MAX_INTERPOL_DEPTH
303
# loop through this until it's done
306
if value.find("%(") != -1:
307
value = self._KEYCRE.sub(self._interpolation_replace, value)
559
self.default_values = {}
562
def _interpolate(self, key, value):
564
# do we already have an interpolation engine?
565
engine = self._interpolation_engine
566
except AttributeError:
567
# not yet: first time running _interpolate(), so pick the engine
568
name = self.main.interpolation
569
if name == True: # note that "if name:" would be incorrect here
570
# backwards-compatibility: interpolation=True means use default
571
name = DEFAULT_INTERPOLATION
572
name = name.lower() # so that "Template", "template", etc. all work
573
class_ = interpolation_engines.get(name, None)
575
# invalid value for self.main.interpolation
576
self.main.interpolation = False
311
raise InterpolationDepthError(value)
579
# save reference to engine so we don't have to do this again
580
engine = self._interpolation_engine = class_(self)
581
# let the engine do the actual work
582
return engine.interpolate(key, value)
314
def _interpolation_replace(self, match):
320
# switch off interpolation before we try and fetch anything !
321
self.main.interpolation = False
322
# try the 'DEFAULT' member of *this section* first
323
val = self.get('DEFAULT', {}).get(s)
324
# try the 'DEFAULT' member of the *parent section* next
326
val = self.parent.get('DEFAULT', {}).get(s)
327
# last, try the 'DEFAULT' member of the *main section*
329
val = self.main.get('DEFAULT', {}).get(s)
330
self.main.interpolation = True
332
raise MissingInterpolationOption(s)
335
585
def __getitem__(self, key):
336
586
"""Fetch the item and do string interpolation."""
337
587
val = dict.__getitem__(self, key)
338
if self.main.interpolation and isinstance(val, StringTypes):
339
return self._interpolate(val)
588
if self.main.interpolation and isinstance(val, basestring):
589
return self._interpolate(key, val)
342
def __setitem__(self, key, value):
593
def __setitem__(self, key, value, unrepr=False):
344
595
Correctly set a value.
346
597
Making dictionary values Section instances.
347
598
(We have to special case 'Section' instances - which are also dicts)
349
600
Keys must be strings.
350
601
Values need only be strings (or lists of strings) if
351
602
``main.stringify`` is set.
604
``unrepr`` must be set when setting a value to a dictionary, without
605
creating a new sub-section.
353
if not isinstance(key, StringTypes):
354
raise ValueError, 'The key "%s" is not a string.' % key
607
if not isinstance(key, basestring):
608
raise ValueError('The key "%s" is not a string.' % key)
355
610
# add the comment
356
611
if key not in self.comments:
357
612
self.comments[key] = []
667
def decode(self, encoding):
669
Decode all strings and values to unicode, using the specified encoding.
671
Works with subsections and list values.
673
Uses the ``walk`` method.
675
Testing ``encode`` and ``decode``.
677
>>> m.decode('ascii')
678
>>> def testuni(val):
679
... for entry in val:
680
... if not isinstance(entry, unicode):
681
... print >> sys.stderr, type(entry)
682
... raise AssertionError, 'decode failed.'
683
... if isinstance(val[entry], dict):
684
... testuni(val[entry])
685
... elif not isinstance(val[entry], unicode):
686
... raise AssertionError, 'decode failed.'
688
>>> m.encode('ascii')
692
def decode(section, key, encoding=encoding):
695
if isinstance(val, (list, tuple)):
698
newval.append(entry.decode(encoding))
699
elif isinstance(val, dict):
702
newval = val.decode(encoding)
703
newkey = key.decode(encoding)
704
section.rename(key, newkey)
705
section[newkey] = newval
706
# using ``call_on_sections`` allows us to modify section names
707
self.walk(decode, call_on_sections=True)
709
def encode(self, encoding):
711
Encode all strings and values from unicode,
712
using the specified encoding.
714
Works with subsections and list values.
715
Uses the ``walk`` method.
717
def encode(section, key, encoding=encoding):
720
if isinstance(val, (list, tuple)):
723
newval.append(entry.encode(encoding))
724
elif isinstance(val, dict):
727
newval = val.encode(encoding)
728
newkey = key.encode(encoding)
729
section.rename(key, newkey)
730
section[newkey] = newval
731
self.walk(encode, call_on_sections=True)
733
def istrue(self, key):
734
"""A deprecated version of ``as_bool``."""
735
warn('use of ``istrue`` is deprecated. Use ``as_bool`` method '
736
'instead.', DeprecationWarning)
737
return self.as_bool(key)
739
947
def as_bool(self, key):
741
949
Accepts a key as input. The corresponding value must be a string or
742
950
the objects (``True`` or 1) or (``False`` or 0). We allow 0 and 1 to
743
951
retain compatibility with Python 2.2.
745
If the string is one of ``True``, ``On``, ``Yes``, or ``1`` it returns
953
If the string is one of ``True``, ``On``, ``Yes``, or ``1`` it returns
748
If the string is one of ``False``, ``Off``, ``No``, or ``0`` it returns
956
If the string is one of ``False``, ``Off``, ``No``, or ``0`` it returns
751
959
``as_bool`` is not case sensitive.
753
961
Any other input will raise a ``ValueError``.
755
963
>>> a = ConfigObj()
756
964
>>> a['a'] = 'fish'
757
965
>>> a.as_bool('a')
950
1190
'true': True, 'false': False,
953
def __init__(self, infile=None, options=None, **kwargs):
1194
def __init__(self, infile=None, options=None, _inspec=False, **kwargs):
955
Parse or create a config file object.
1196
Parse a config file or create a config file object.
957
1198
``ConfigObj(infile=None, options=None, **kwargs)``
1200
self._inspec = _inspec
1201
# init the superclass
1202
Section.__init__(self, self, 0, self)
1204
infile = infile or []
1205
options = dict(options or {})
963
1207
# keyword arguments take precedence over an options dictionary
964
1208
options.update(kwargs)
965
# init the superclass
966
Section.__init__(self, self, 0, self)
1210
options['list_values'] = False
968
1212
defaults = OPTION_DEFAULTS.copy()
969
for entry in options.keys():
970
if entry not in defaults.keys():
971
raise TypeError, 'Unrecognised option "%s".' % entry
972
1213
# TODO: check the values too.
1214
for entry in options:
1215
if entry not in defaults:
1216
raise TypeError('Unrecognised option "%s".' % entry)
974
1218
# Add any explicit options to the defaults
975
1219
defaults.update(options)
977
# initialise a few variables
980
self.raise_errors = defaults['raise_errors']
981
self.interpolation = defaults['interpolation']
982
self.list_values = defaults['list_values']
983
self.create_empty = defaults['create_empty']
984
self.file_error = defaults['file_error']
985
self.stringify = defaults['stringify']
986
self.indent_type = defaults['indent_type']
987
self.encoding = defaults['encoding']
988
self.default_encoding = defaults['default_encoding']
992
self.initial_comment = []
993
self.final_comment = []
995
if isinstance(infile, StringTypes):
1220
self._initialise(defaults)
1221
configspec = defaults['configspec']
1222
self._original_configspec = configspec
1223
self._load(infile, configspec)
1226
def _load(self, infile, configspec):
1227
if isinstance(infile, basestring):
996
1228
self.filename = infile
997
1229
if os.path.isfile(infile):
998
infile = open(infile).read() or []
1230
h = open(infile, 'rb')
1231
infile = h.read() or []
999
1233
elif self.file_error:
1000
1234
# raise an error if the file doesn't exist
1001
raise IOError, 'Config file not found: "%s".' % self.filename
1235
raise IOError('Config file not found: "%s".' % self.filename)
1003
1237
# file doesn't already exist
1004
1238
if self.create_empty:
1005
1239
# this is a good test that the filename specified
1006
# isn't impossible - like on a non existent device
1240
# isn't impossible - like on a non-existent device
1007
1241
h = open(infile, 'w')
1011
1246
elif isinstance(infile, (list, tuple)):
1012
1247
infile = list(infile)
1013
1249
elif isinstance(infile, dict):
1014
1250
# initialise self
1015
1251
# the Section class handles creating subsections
1016
1252
if isinstance(infile, ConfigObj):
1017
1253
# get a copy of our ConfigObj
1018
1254
infile = infile.dict()
1019
1256
for entry in infile:
1020
1257
self[entry] = infile[entry]
1021
1258
del self._errors
1022
if defaults['configspec'] is not None:
1023
self._handle_configspec(defaults['configspec'])
1260
if configspec is not None:
1261
self._handle_configspec(configspec)
1025
1263
self.configspec = None
1027
elif getattr(infile, 'read', None) is not None:
1266
elif getattr(infile, 'read', MISSING) is not MISSING:
1028
1267
# This supports file like objects
1029
1268
infile = infile.read() or []
1030
1269
# needs splitting into lines - but needs doing *after* decoding
1031
1270
# in case it's not an 8 bit encoding
1033
raise TypeError, ('infile must be a filename,'
1034
' file like object, or list of lines.')
1272
raise TypeError('infile must be a filename, file like object, or list of lines.')
1037
1275
# don't do it for the empty ConfigObj
1038
1276
infile = self._handle_bom(infile)
1382
1605
'Parse error in value at line %s.',
1383
1606
ParseError, infile, cur_index)
1612
value = unrepr(value)
1613
except Exception, e:
1614
if type(e) == UnknownType:
1615
msg = 'Unknown name or type in value at line %s.'
1617
msg = 'Parse error in value at line %s.'
1618
self._handle_error(msg, UnreprError, infile,
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)
1625
value = unrepr(value)
1626
except Exception, e:
1627
if isinstance(e, UnknownType):
1628
msg = 'Unknown name or type in value at line %s.'
1630
msg = 'Parse error in value at line %s.'
1631
self._handle_error(msg, UnreprError, infile,
1635
# extract comment and lists
1637
(value, comment) = self._handle_value(value)
1640
'Parse error in value at line %s.',
1641
ParseError, infile, cur_index)
1395
## print >> sys.stderr, sline
1396
1644
key = self._unquote(key)
1397
1645
if key in this_section:
1398
1646
self._handle_error(
1399
1647
'Duplicate keyword name at line %s.',
1400
1648
DuplicateError, infile, cur_index)
1403
## print >> sys.stderr, this_section.name
1404
this_section[key] = value
1651
# we set unrepr because if we have got this far we will never
1652
# be creating a new section
1653
this_section.__setitem__(key, value, unrepr=True)
1405
1654
this_section.inline_comments[key] = comment
1406
1655
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)
1419
1658
if self.indent_type is None:
1420
1659
# no indentation used, set the type accordingly
1421
1660
self.indent_type = ''
1422
1662
# preserve the final comment
1423
1663
if not self and not self.initial_comment:
1424
1664
self.initial_comment = comment_list
1665
elif not reset_comment:
1426
1666
self.final_comment = comment_list
1667
self.list_values = temp_list_values
1428
1670
def _match_depth(self, sect, depth):
1430
1672
Given a section and a depth level, walk back through the sections
1431
1673
parents to see if the depth level matches a previous section.
1433
1675
Return a reference to the right section,
1434
1676
or raise a SyntaxError.
1436
1678
while depth < sect.depth:
1437
1679
if sect is sect.parent:
1438
1680
# we've reached the top level already
1440
1682
sect = sect.parent
1441
1683
if sect.depth == depth:
1443
1685
# shouldn't get here
1446
1689
def _handle_error(self, text, ErrorClass, infile, cur_index):
1448
1691
Handle an error according to the error settings.
1450
1693
Either raise the error or store it.
1451
1694
The error will have occured at ``cur_index``
1453
1696
line = infile[cur_index]
1454
1698
message = text % cur_index
1455
1699
error = ErrorClass(message, cur_index, line)
1456
1700
if self.raise_errors:
1460
1704
# reraise when parsing has finished
1461
1705
self._errors.append(error)
1463
1708
def _unquote(self, value):
1464
1709
"""Return an unquoted version of a value"""
1465
1710
if (value[0] == value[-1]) and (value[0] in ('"', "'")):
1466
1711
value = value[1:-1]
1469
1715
def _quote(self, value, multiline=True):
1471
1717
Return a safely quoted version of a value.
1473
1719
Raise a ConfigObjError if the value cannot be safely quoted.
1474
1720
If multiline is ``True`` (default) then use triple quotes
1477
Don't quote values that don't need it.
1478
Recursively quote members of a list and return a comma joined list.
1479
Multiline is ``False`` for lists.
1480
Obey list syntax for empty and single member lists.
1723
* Don't quote values that don't need it.
1724
* Recursively quote members of a list and return a comma joined list.
1725
* Multiline is ``False`` for lists.
1726
* Obey list syntax for empty and single member lists.
1482
1728
If ``list_values=False`` then the value is only quoted if it contains
1483
a ``\n`` (is multiline).
1729
a ``\\n`` (is multiline) or '#'.
1731
If ``write_empty_values`` is set, and the value is an empty string, it
1485
if isinstance(value, (list, tuple)):
1734
if multiline and self.write_empty_values and value == '':
1735
# Only if multiline is set, so that it is used for values not
1736
# keys, and not values that are part of a list
1739
if multiline and isinstance(value, (list, tuple)):
1488
1742
elif len(value) == 1:
1489
1743
return self._quote(value[0], multiline=False) + ','
1490
1744
return ', '.join([self._quote(val, multiline=False)
1491
1745
for val in value])
1492
if not isinstance(value, StringTypes):
1746
if not isinstance(value, basestring):
1493
1747
if self.stringify:
1494
1748
value = str(value)
1496
raise TypeError, 'Value "%s" is not a string.' % value
1500
wspace_plus = ' \r\t\n\v\t\'"'
1750
raise TypeError('Value "%s" is not a string.' % value)
1505
if (not self.list_values and '\n' not in value) or not (multiline and
1506
((("'" in value) and ('"' in value)) or ('\n' in value))):
1755
no_lists_no_quotes = not self.list_values and '\n' not in value and '#' not in value
1756
need_triple = multiline and ((("'" in value) and ('"' in value)) or ('\n' in value ))
1757
hash_triple_quote = multiline and not need_triple and ("'" in value) and ('"' in value) and ('#' in value)
1758
check_for_single = (no_lists_no_quotes or not need_triple) and not hash_triple_quote
1760
if check_for_single:
1507
1761
if not self.list_values:
1508
1762
# we don't quote if ``list_values=False``
1510
1764
# for normal values either single or double quotes will do
1511
1765
elif '\n' in value:
1512
1766
# will only happen if multiline is off - e.g. '\n' in key
1513
raise ConfigObjError, ('Value "%s" cannot be safely quoted.' %
1767
raise ConfigObjError('Value "%s" cannot be safely quoted.' % value)
1515
1768
elif ((value[0] not in wspace_plus) and
1516
1769
(value[-1] not in wspace_plus) and
1517
1770
(',' not in value)):
1520
if ("'" in value) and ('"' in value):
1521
raise ConfigObjError, (
1522
'Value "%s" cannot be safely quoted.' % value)
1773
quot = self._get_single_quote(value)
1528
1775
# if value has '\n' or "'" *and* '"', it will need triple quotes
1529
if (value.find('"""') != -1) and (value.find("'''") != -1):
1530
raise ConfigObjError, (
1531
'Value "%s" cannot be safely quoted.' % value)
1532
if value.find('"""') == -1:
1776
quot = self._get_triple_quote(value)
1778
if quot == noquot and '#' in value and self.list_values:
1779
quot = self._get_single_quote(value)
1536
1781
return quot % value
1784
def _get_single_quote(self, value):
1785
if ("'" in value) and ('"' in value):
1786
raise ConfigObjError('Value "%s" cannot be safely quoted.' % value)
1794
def _get_triple_quote(self, value):
1795
if (value.find('"""') != -1) and (value.find("'''") != -1):
1796
raise ConfigObjError('Value "%s" cannot be safely quoted.' % value)
1797
# upstream version (up to version 4.7.2) has the bug with incorrect quoting;
1798
# fixed in our copy based on the suggestion of ConfigObj's author
1799
if value.find('"""') == -1:
1538
1806
def _handle_value(self, value):
1540
1808
Given a value string, unquote, remove comment,
1541
1809
handle lists. (including empty and single member lists)
1543
Testing list values.
1545
>>> testconfig3 = '''
1548
... c = test1, test2 , test3
1549
... d = test1, test2, test3,
1551
>>> d = ConfigObj(testconfig3.split('\\n'), raise_errors=True)
1554
>>> d['b'] == ['test']
1556
>>> d['c'] == ['test1', 'test2', 'test3']
1558
>>> d['d'] == ['test1', 'test2', 'test3']
1561
Testing with list values off.
1564
... testconfig3.split('\\n'),
1565
... raise_errors=True,
1566
... list_values=False)
1569
>>> e['b'] == 'test,'
1571
>>> e['c'] == 'test1, test2 , test3'
1573
>>> e['d'] == 'test1, test2, test3,'
1576
Testing creating from a dictionary.
1599
>>> g = ConfigObj(f)
1603
Testing we correctly detect badly built list values (4 of them).
1605
>>> testconfig4 = '''
1609
... dummy = ,,hello, goodbye
1612
... ConfigObj(testconfig4.split('\\n'))
1613
... except ConfigObjError, e:
1617
Testing we correctly detect badly quoted values (4 of them).
1619
>>> testconfig5 = '''
1620
... config = "hello # comment
1622
... fish = 'goodbye # comment
1623
... dummy = "hello again
1626
... ConfigObj(testconfig5.split('\\n'))
1627
... except ConfigObjError, e:
1812
# Parsing a configspec so don't handle comments
1631
1814
# do we look for lists in values ?
1632
1815
if not self.list_values:
1633
1816
mat = self._nolistvalue.match(value)
1634
1817
if mat is None:
1636
(value, comment) = mat.groups()
1637
1819
# NOTE: we don't unquote here
1638
return (value, comment)
1639
1822
mat = self._valueexp.match(value)
1640
1823
if mat is None:
1641
1824
# the value is badly constructed, probably badly quoted,
1642
1825
# or an invalid list
1644
1827
(list_values, single, empty_list, comment) = mat.groups()
1645
1828
if (list_values == '') and (single is None):
1646
1829
# change this if you want to accept empty values
1648
1831
# NOTE: note there is no error handling from here if the regex
1649
1832
# is wrong: then incorrect values will slip through
1650
1833
if empty_list is not None:
1651
1834
# the single comma - meaning an empty list
1652
1835
return ([], comment)
1653
1836
if single is not None:
1654
single = self._unquote(single)
1837
# handle empty values
1838
if list_values and not single:
1839
# FIXME: the '' is a workaround because our regex now matches
1840
# '' at the end of a list if it has a trailing comma
1843
single = single or '""'
1844
single = self._unquote(single)
1655
1845
if list_values == '':
1656
1846
# not a list value
1657
1847
return (single, comment)
1711
1880
# we've got to the end of the config, oops...
1713
1882
mat = multi_line.match(line)
1714
1883
if mat is None:
1715
1884
# a badly formed line
1717
1886
(value, comment) = mat.groups()
1718
1887
return (newvalue + value, comment, cur_index)
1720
1890
def _handle_configspec(self, configspec):
1721
1891
"""Parse the configspec."""
1723
configspec = ConfigObj(
1728
except ConfigObjError, e:
1729
# FIXME: Should these errors have a reference
1730
# to the already parsed ConfigObj ?
1731
raise ConfigspecError('Parsing configspec failed: %s' % e)
1733
raise IOError('Reading configspec failed: %s' % e)
1734
self._set_configspec_value(configspec, self)
1736
def _set_configspec_value(self, configspec, section):
1737
"""Used to recursively set configspec values."""
1738
if '__many__' in configspec.sections:
1739
section.configspec['__many__'] = configspec['__many__']
1740
if len(configspec.sections) > 1:
1741
# FIXME: can we supply any useful information here ?
1742
raise RepeatSectionError
1743
for entry in configspec.scalars:
1744
section.configspec[entry] = configspec[entry]
1892
# FIXME: Should we check that the configspec was created with the
1893
# correct settings ? (i.e. ``list_values=False``)
1894
if not isinstance(configspec, ConfigObj):
1896
configspec = ConfigObj(configspec,
1900
except ConfigObjError, e:
1901
# FIXME: Should these errors have a reference
1902
# to the already parsed ConfigObj ?
1903
raise ConfigspecError('Parsing configspec failed: %s' % e)
1905
raise IOError('Reading configspec failed: %s' % e)
1907
self.configspec = configspec
1911
def _set_configspec(self, section, copy):
1913
Called by validate. Handles setting the configspec on subsections
1914
including sections to be validated by __many__
1916
configspec = section.configspec
1917
many = configspec.get('__many__')
1918
if isinstance(many, dict):
1919
for entry in section.sections:
1920
if entry not in configspec:
1921
section[entry].configspec = many
1745
1923
for entry in configspec.sections:
1746
1924
if entry == '__many__':
1748
1926
if entry not in section:
1749
1927
section[entry] = {}
1750
self._set_configspec_value(configspec[entry], section[entry])
1752
def _handle_repeat(self, section, configspec):
1753
"""Dynamically assign configspec for repeated section."""
1755
section_keys = configspec.sections
1756
scalar_keys = configspec.scalars
1757
except AttributeError:
1758
section_keys = [entry for entry in configspec
1759
if isinstance(configspec[entry], dict)]
1760
scalar_keys = [entry for entry in configspec
1761
if not isinstance(configspec[entry], dict)]
1762
if '__many__' in section_keys and len(section_keys) > 1:
1763
# FIXME: can we supply any useful information here ?
1764
raise RepeatSectionError
1767
for entry in scalar_keys:
1768
val = configspec[entry]
1769
scalars[entry] = val
1770
for entry in section_keys:
1771
val = configspec[entry]
1772
if entry == '__many__':
1773
scalars[entry] = val
1775
sections[entry] = val
1777
section.configspec = scalars
1778
for entry in sections:
1779
if entry not in section:
1781
self._handle_repeat(section[entry], sections[entry])
1930
section.comments[entry] = configspec.comments.get(entry, [])
1931
section.inline_comments[entry] = configspec.inline_comments.get(entry, '')
1933
# Could be a scalar when we expect a section
1934
if isinstance(section[entry], Section):
1935
section[entry].configspec = configspec[entry]
1783
1938
def _write_line(self, indent_string, entry, this_entry, comment):
1784
1939
"""Write an individual line, for the write method"""
1785
1940
# NOTE: the calls to self._quote here handles non-StringType values.
1786
return '%s%s%s%s%s' % (
1788
self._decode_element(self._quote(entry, multiline=False)),
1789
self._a_to_u(' = '),
1790
self._decode_element(self._quote(this_entry)),
1791
self._decode_element(comment))
1942
val = self._decode_element(self._quote(this_entry))
1944
val = repr(this_entry)
1945
return '%s%s%s%s%s' % (indent_string,
1946
self._decode_element(self._quote(entry, multiline=False)),
1947
self._a_to_u(' = '),
1949
self._decode_element(comment))
1793
1952
def _write_marker(self, indent_string, depth, entry, comment):
1794
1953
"""Write a section marker line"""
1795
return '%s%s%s%s%s' % (
1797
self._a_to_u('[' * depth),
1798
self._quote(self._decode_element(entry), multiline=False),
1799
self._a_to_u(']' * depth),
1800
self._decode_element(comment))
1954
return '%s%s%s%s%s' % (indent_string,
1955
self._a_to_u('[' * depth),
1956
self._quote(self._decode_element(entry), multiline=False),
1957
self._a_to_u(']' * depth),
1958
self._decode_element(comment))
1802
1961
def _handle_comment(self, comment):
1804
Deal with a comment.
1806
>>> filename = a.filename
1807
>>> a.filename = None
1808
>>> values = a.write()
1810
>>> while index < 23:
1812
... line = values[index-1]
1813
... assert line.endswith('# comment ' + str(index))
1814
>>> a.filename = filename
1816
>>> start_comment = ['# Initial Comment', '', '#']
1817
>>> end_comment = ['', '#', '# Final Comment']
1818
>>> newconfig = start_comment + testconfig1.split('\\n') + end_comment
1819
>>> nc = ConfigObj(newconfig)
1820
>>> nc.initial_comment
1821
['# Initial Comment', '', '#']
1822
>>> nc.final_comment
1823
['', '#', '# Final Comment']
1824
>>> nc.initial_comment == start_comment
1826
>>> nc.final_comment == end_comment
1962
"""Deal with a comment."""
1829
1963
if not comment:
1831
if self.indent_type == '\t':
1832
start = self._a_to_u('\t')
1834
start = self._a_to_u(' ' * NUM_INDENT_SPACES)
1965
start = self.indent_type
1835
1966
if not comment.startswith('#'):
1836
start += _a_to_u('# ')
1967
start += self._a_to_u(' # ')
1837
1968
return (start + comment)
1839
def _compute_indent_string(self, depth):
1841
Compute the indent string, according to current indent_type and depth
1843
if self.indent_type == '':
1844
# no indentation at all
1846
if self.indent_type == '\t':
1848
if self.indent_type == ' ':
1849
return ' ' * NUM_INDENT_SPACES * depth
1852
1971
# Public methods
1854
1973
def write(self, outfile=None, section=None):
1856
1975
Write the current ConfigObj as a file
1858
1977
tekNico: FIXME: use StringIO instead of real files
1860
1979
>>> filename = a.filename
1861
1980
>>> a.filename = 'test.ini'
1863
1982
>>> a.filename = filename
1864
1983
>>> a == ConfigObj('test.ini', raise_errors=True)
1866
>>> os.remove('test.ini')
1867
>>> b.filename = 'test.ini'
1869
>>> b == ConfigObj('test.ini', raise_errors=True)
1871
>>> os.remove('test.ini')
1872
>>> i.filename = 'test.ini'
1874
>>> i == ConfigObj('test.ini', raise_errors=True)
1876
>>> os.remove('test.ini')
1878
>>> a['DEFAULT'] = {'a' : 'fish'}
1879
>>> a['a'] = '%(a)s'
1881
['a = %(a)s', '[DEFAULT]', 'a = fish']
1883
1986
if self.indent_type is None:
1884
1987
# this can be true if initialised from a dictionary
1885
1988
self.indent_type = DEFAULT_INDENT_TYPE
1888
1991
cs = self._a_to_u('#')
1889
1992
csp = self._a_to_u('# ')
1953
2055
out[0] = BOM_UTF8 + out[0]
1956
2058
# Turn the list to a string, joined with correct newlines
1957
output = (self._a_to_u(self.newlines or os.linesep)
2059
newline = self.newlines or os.linesep
2060
output = self._a_to_u(newline).join(out)
1959
2061
if self.encoding:
1960
2062
output = output.encode(self.encoding)
1961
if (self.BOM and ((self.encoding is None) or
1962
(BOM_LIST.get(self.encoding.lower()) == 'utf_8'))):
2063
if self.BOM and ((self.encoding is None) or match_utf8(self.encoding)):
1963
2064
# Add the UTF8 BOM
1964
2065
output = BOM_UTF8 + output
2067
if not output.endswith(newline):
1965
2069
if outfile is not None:
1966
2070
outfile.write(output)
1968
h = open(self.filename, 'w')
2072
h = open(self.filename, 'wb')
1969
2073
h.write(output)
1972
def validate(self, validator, preserve_errors=False, section=None):
2077
def validate(self, validator, preserve_errors=False, copy=False,
1974
2080
Test the ConfigObj against a configspec.
1976
2082
It uses the ``validator`` object from *validate.py*.
1978
2084
To run ``validate`` on the current ConfigObj, call: ::
1980
2086
test = config.validate(validator)
1982
2088
(Normally having previously passed in the configspec when the ConfigObj
1983
2089
was created - you can dynamically assign a dictionary of checks to the
1984
2090
``configspec`` attribute of a section though).
1986
2092
It returns ``True`` if everything passes, or a dictionary of
1987
2093
pass/fails (True/False). If every member of a subsection passes, it
1988
2094
will just have the value ``True``. (It also returns ``False`` if all
1991
2097
In addition, it converts the values from strings to their native
1992
2098
types if their checks pass (and ``stringify`` is set).
1994
2100
If ``preserve_errors`` is ``True`` (``False`` is default) then instead
1995
2101
of a marking a fail with a ``False``, it will preserve the actual
1996
2102
exception object. This can contain info about the reason for failure.
1997
For example the ``VdtValueTooSmallError`` indeicates that the value
2103
For example the ``VdtValueTooSmallError`` indicates that the value
1998
2104
supplied was too small. If a value (or section) is missing it will
1999
2105
still be marked as ``False``.
2001
2107
You must have the validate module to use ``preserve_errors=True``.
2003
2109
You can then use the ``flatten_errors`` function to turn your nested
2004
2110
results dictionary into a flattened list of failures - useful for
2005
2111
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
2381
2113
if section is None:
2382
2114
if self.configspec is None:
2383
raise ValueError, 'No configspec supplied.'
2115
raise ValueError('No configspec supplied.')
2384
2116
if preserve_errors:
2385
if VdtMissingValue is None:
2386
raise ImportError('Missing validate module.')
2117
# We do this once to remove a top level dependency on the validate module
2118
# Which makes importing configobj faster
2119
from validate import VdtMissingValue
2120
self._vdtMissingValue = VdtMissingValue
2389
spec_section = section.configspec
2390
if '__many__' in section.configspec:
2391
many = spec_section['__many__']
2392
# dynamically assign the configspecs
2393
# for the sections below
2394
for entry in section.sections:
2395
self._handle_repeat(section[entry], many)
2400
for entry in spec_section:
2401
if entry == '__many__':
2403
if (not entry in section.scalars) or (entry in section.defaults):
2405
# or entries from defaults
2410
val = section[entry]
2125
section.initial_comment = section.configspec.initial_comment
2126
section.final_comment = section.configspec.final_comment
2127
section.encoding = section.configspec.encoding
2128
section.BOM = section.configspec.BOM
2129
section.newlines = section.configspec.newlines
2130
section.indent_type = section.configspec.indent_type
2133
configspec = section.configspec
2134
self._set_configspec(section, copy)
2136
def validate_entry(entry, spec, val, missing, ret_true, ret_false):
2412
check = validator.check(spec_section[entry],
2138
check = validator.check(spec,
2414
2140
missing=missing
2416
2142
except validator.baseErrorClass, e:
2417
if not preserve_errors or isinstance(e, VdtMissingValue):
2143
if not preserve_errors or isinstance(e, self._vdtMissingValue):
2418
2144
out[entry] = False
2420
2146
# preserve the error
2461
2271
elif ret_false:
2277
"""Clear ConfigObj instance and restore to 'freshly created' state."""
2280
# FIXME: Should be done by '_initialise', but ConfigObj constructor (and reload)
2281
# requires an empty dictionary
2282
self.configspec = None
2283
# Just to be sure ;-)
2284
self._original_configspec = None
2289
Reload a ConfigObj from file.
2291
This method raises a ``ReloadError`` if the ConfigObj doesn't have
2292
a filename attribute pointing to a file.
2294
if not isinstance(self.filename, basestring):
2297
filename = self.filename
2298
current_options = {}
2299
for entry in OPTION_DEFAULTS:
2300
if entry == 'configspec':
2302
current_options[entry] = getattr(self, entry)
2304
configspec = self._original_configspec
2305
current_options['configspec'] = configspec
2308
self._initialise(current_options)
2309
self._load(filename, configspec)
2466
2313
class SimpleVal(object):
2468
2315
A simple validator.
2469
2316
Can be used to check that all members expected are present.
2471
2318
To use it, provide a configspec with all your members in (the value given
2472
2319
will be ignored). Pass an instance of ``SimpleVal`` to the ``validate``
2473
2320
method of your ``ConfigObj``. ``validate`` will return ``True`` if all
2474
2321
members are present, or a dictionary with True/False meaning
2475
2322
present/missing. (Whole missing sections will be replaced with ``False``)
2477
>>> val = SimpleVal()
2493
... '''.split('\\n')
2494
>>> configspec = '''
2509
... '''.split('\\n')
2510
>>> o = ConfigObj(config, configspec=configspec)
2513
>>> o = ConfigObj(configspec=configspec)
2518
2325
def __init__(self):
2519
2326
self.baseErrorClass = ConfigObjError
2521
2328
def check(self, check, member, missing=False):
2522
2329
"""A dummy check method, always returns the value unchanged."""
2524
raise self.baseErrorClass
2331
raise self.baseErrorClass()
2527
2335
# Check / processing functions for options
2528
2336
def flatten_errors(cfg, res, levels=None, results=None):
2530
2338
An example function that will turn a nested dictionary of results
2531
2339
(as returned by ``ConfigObj.validate``) into a flat list.
2533
2341
``cfg`` is the ConfigObj instance being checked, ``res`` is the results
2534
2342
dictionary returned by ``validate``.
2536
2344
(This is a recursive function, so you shouldn't use the ``levels`` or
2537
``results`` arguments - they are used by the function.
2345
``results`` arguments - they are used by the function.)
2539
2347
Returns a list of keys that failed. Each member of the list is a tuple :
2542
2351
([list of sections...], key, result)
2544
2353
If ``validate`` was called with ``preserve_errors=False`` (the default)
2545
2354
then ``result`` will always be ``False``.
2547
2356
*list of sections* is a flattened list of sections that the key was found
2550
If the section was missing then key will be ``None``.
2359
If the section was missing (or a section was expected and a scalar provided
2360
- or vice-versa) then key will be ``None``.
2552
2362
If the value (or section) was missing then ``result`` will be ``False``.
2554
2364
If ``validate`` was called with ``preserve_errors=True`` and a value
2555
2365
was present, but failed the check, then ``result`` will be the exception
2556
2366
object returned. You can use this as a string that describes the failure.
2558
2368
For example *The value "3" is of the wrong type*.
2560
# FIXME: is the ordering of the output arbitrary ?
2561
2370
>>> import validate
2562
2371
>>> vtor = validate.Validator()
2563
2372
>>> my_ini = '''
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
2461
"""*A programming language is a medium of expression.* - Paul Graham"""
added
removed
bzrlib/util/configobj/configobj.py
