configobj

Module configobj |
[hide private]
[frames] | no frames]

# Module configobj

source code

Version: 4.7.2

Classes | [hide private]
| UnknownType
| Builder
| ConfigObjError This is the base class for all errors that ConfigObj raises.
| NestingError This error indicates a level of nesting that doesn't match.
| ParseError This error indicates that a line is badly written.
| ReloadError A 'reload' operation failed.
| DuplicateError The keyword or section specified already exists.
| ConfigspecError An error occured whilst parsing a configspec.
| InterpolationError Base class for the two interpolation errors.
| InterpolationLoopError Maximum interpolation depth exceeded in string interpolation.
| RepeatSectionError This error indicates additional sections in a section with a ``__many__`` (repeated) section.
| MissingInterpolationOption A value specified for interpolation was missing.
| UnreprError An error parsing in unrepr mode.
| InterpolationEngine A helper class to help perform string interpolation.
| ConfigParserInterpolation Behaves like ConfigParser.
| TemplateInterpolation Behaves like string.Template.
| Section A dictionary-like object that represents a section in a config file.
| ConfigObj An object to read, create, and write config files.
| SimpleVal A simple validator.

Functions | [hide private]
match_utf8(encoding) | source code
any(iterable) | source code
getObj(s) | source code
unrepr(s) | source code
__newobj__(cls, *args) | source code
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. | source code
get_extra_values(conf, _prepend=`(``)`) Find all the values and sections not in the configspec from a validated ConfigObj. | source code

Variables | [hide private]
| compiler = `None` hash(x)
| BOMS = ``{``'``\xef\xbb\xbf``'``:` `(``'``utf_8``'``,` None`)``,` `'``\xfe\xff``'``:` `(``'``utf16_b``...``
| BOM_LIST = ``{``'``u16``'``:` `'``utf_16``'``,` `'``u8``'``:` `'``utf_8``'``,` `'``utf``'``:` `'``utf_8``'``,` `'``u``...``
| BOM_SET = ``{`None`:` `'``\xef\xbb\xbf``'``,` `'``utf16_be``'``:` `'``\xfe\xff``'``,` `'``utf1``...``
| squot = ``'``\'%s\'``'``
| dquot = ``'``"%s"``'``
| noquot = ``'``%s``'``
| wspace_plus = ``'``\r\n\x0b\t\'"``'``
| tsquot = ``'``"""%s"""``'``
| tdquot = ``'``\'\'\'%s\'\'\'``'``
| MISSING = `object()`
| DEFAULT_INTERPOLATION = ``'``configparser``'``
| DEFAULT_INDENT_TYPE = ``'``` `'``
| MAX_INTERPOL_DEPTH = `10`
| OPTION_DEFAULTS = ``{``'``configspec``'``:` None`,` `'``create_empty``'``:` False`,` `...``
| _builder = `Builder()`
| interpolation_engines = ``{``'``configparser``'``:` <class 'configobj.Con`...``
| __package__ = `None` hash(x)

Function Details | [hide private]

### flatten_errors(cfg, res, levels=None, results=None) | source code
    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*.

### get_extra_values(conf, _prepend=`(``)`) | source code
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.

Variables Details | [hide private]

  ### BOMS Value:
      {'\xef\xbb\xbf': ('utf_8', None),
       '\xfe\xff': ('utf16_be', 'utf_16'),
       '\xff\xfe': ('utf_16', 'utf_16')}

  ### BOM_LIST Value:
      {'u16': 'utf_16',
       'u8': 'utf_8',
       'utf': 'utf_8',
       'utf-16': 'utf_16',
       'utf-16be': 'utf16_be',
       'utf-16le': 'utf16_le',
       'utf-8': 'utf_8',
       'utf16': 'utf_16',
      ...

  ### BOM_SET Value:
      {None: '\xef\xbb\xbf',
       'utf16_be': '\xfe\xff',
       'utf16_le': '\xff\xfe',
       'utf_16': '\xff\xfe',
       'utf_8': '\xef\xbb\xbf'}

  ### OPTION_DEFAULTS Value:
      {'configspec': None,
       'create_empty': False,
       'default_encoding': None,
       'encoding': None,
       'file_error': False,
       'indent_type': None,
       'interpolation': True,
       'list_values': True,
      ...

  ### interpolation_engines Value:
      {'configparser': <class 'configobj.ConfigParserInterpolation'>,
       'template': <class 'configobj.TemplateInterpolation'>}