exception core.project.configobj.ConfigObjError(message='', line_number=None, line='')

Bases: exceptions.SyntaxError

This is the base class for all errors that ConfigObj raises. It is a subclass of SyntaxError.

exception core.project.configobj.NestingError(message='', line_number=None, line='')

Bases: core.project.configobj.ConfigObjError

This error indicates a level of nesting that doesn't match.

exception core.project.configobj.ParseError(message='', line_number=None, line='')

Bases: core.project.configobj.ConfigObjError

This error indicates that a line is badly written. It is neither a valid key = value line, nor a valid section marker line.

exception core.project.configobj.DuplicateError(message='', line_number=None, line='')

Bases: core.project.configobj.ConfigObjError

The keyword or section specified already exists.

exception core.project.configobj.ConfigspecError(message='', line_number=None, line='')

Bases: core.project.configobj.ConfigObjError

An error occured whilst parsing a configspec.

exception core.project.configobj.InterpolationError(message='', line_number=None, line='')

Bases: core.project.configobj.ConfigObjError

Base class for the two interpolation errors.

exception core.project.configobj.InterpolationLoopError(option)

Bases: core.project.configobj.InterpolationError

Maximum interpolation depth exceeded in string interpolation.

exception core.project.configobj.MissingInterpolationOption(option)

Bases: core.project.configobj.InterpolationError

A value specified for interpolation was missing.

exception core.project.configobj.RepeatSectionError(message='', line_number=None, line='')

Bases: core.project.configobj.ConfigObjError

This error indicates additional sections in a section with a __many__ (repeated) section.

exception core.project.configobj.ReloadError

Bases: exceptions.IOError

A 'reload' operation failed. This exception is a subclass of IOError.

exception core.project.configobj.UnreprError(message='', line_number=None, line='')

Bases: core.project.configobj.ConfigObjError

An error parsing in unrepr mode.

exception core.project.configobj.UnknownType

Bases: exceptions.Exception

class core.project.configobj.ConfigObj(infile=None, options=None, configspec=None, encoding=None, interpolation=True, raise_errors=False, list_values=True, create_empty=False, file_error=False, stringify=True, indent_type=None, default_encoding=None, unrepr=False, write_empty_values=False, _inspec=False)

Bases: core.project.configobj.Section

An object to read, create, and write config files.

reload()

Reload a ConfigObj from file.

This method raises a ReloadError if the ConfigObj doesn't have a filename attribute pointing to a file.

reset()

Clear ConfigObj instance and restore to 'freshly created' state.

validate(validator, preserve_errors=False, copy=False, section=None)

Test the ConfigObj against a configspec.

It uses the validator object from validate.py.

To run validate on the current ConfigObj, call:

test = config.validate(validator)

(Normally having previously passed in the configspec when the ConfigObj was created - you can dynamically assign a dictionary of checks to the configspec attribute of a section though).

It returns True if everything passes, or a dictionary of pass/fails (True/False). If every member of a subsection passes, it will just have the value True. (It also returns False if all members fail).

In addition, it converts the values from strings to their native types if their checks pass (and stringify is set).

If preserve_errors is True (False is default) then instead of a marking a fail with a False, it will preserve the actual exception object. This can contain info about the reason for failure. For example the VdtValueTooSmallError indicates that the value supplied was too small. If a value (or section) is missing it will still be marked as False.

You must have the validate module to use preserve_errors=True.

You can then use the flatten_errors function to turn your nested results dictionary into a flattened list of failures - useful for displaying meaningful error messages.

write(outfile=None, section=None)

Write the current ConfigObj as a file

tekNico: FIXME: use StringIO instead of real files

>>> filename = a.filename
>>> a.filename = 'test.ini'
>>> a.write()
>>> a.filename = filename
>>> a == ConfigObj('test.ini', raise_errors=True)
1
>>> import os
>>> os.remove('test.ini')

class core.project.configobj.SimpleVal

Bases: object

A simple validator. Can be used to check that all members expected are present.

To use it, provide a configspec with all your members in (the value given will be ignored). Pass an instance of SimpleVal to the validate method of your ConfigObj. validate will return True if all members are present, or a dictionary with True/False meaning present/missing. (Whole missing sections will be replaced with False)

check(check, member, missing=False)

A dummy check method, always returns the value unchanged.

core.project.configobj.flatten_errors(cfg, res, levels=None, results=None)

An example function that will turn a nested dictionary of results (as returned by ConfigObj.validate) into a flat list.

cfg is the ConfigObj instance being checked, res is the results dictionary returned by validate.

(This is a recursive function, so you shouldn't use the levels or results arguments - they are used by the function.)

Returns a list of keys that failed. Each member of the list is a tuple:

([list of sections...], key, result)

If validate was called with preserve_errors=False (the default) then result will always be False.

list of sections is a flattened list of sections that the key was found in.

If the section was missing (or a section was expected and a scalar provided - or vice-versa) then key will be None.

If the value (or section) was missing then result will be False.

If validate was called with preserve_errors=True and a value was present, but failed the check, then result will be the exception object returned. You can use this as a string that describes the failure.

For example The value "3" is of the wrong type.

core.project.configobj.get_extra_values(conf, _prepend=())

Find all the values and sections not in the configspec from a validated ConfigObj.

get_extra_values returns a list of tuples where each tuple represents either an extra section, or an extra value.

The tuples contain two values, a tuple representing the section the value is in and the name of the extra values. For extra values in the top level section the first member will be an empty tuple. For values in the 'foo' section the first member will be ('foo',). For members in the 'bar' subsection of the 'foo' section the first member will be ('foo', 'bar').

NOTE: If you call get_extra_values on a ConfigObj instance that hasn't been validated it will return an empty list.