K2LL33D SHELL

 Apache/2.4.7 (Ubuntu)
 Linux sman1baleendah 3.13.0-24-generic #46-Ubuntu SMP Thu Apr 10 19:11:08 UTC 2014 x86_64
 uid=33(www-data) gid=33(www-data) groups=33(www-data)
 safemode : OFF
 MySQL: ON | Perl: ON | cURL: OFF | WGet: ON
  >  / usr / share / doc / python-configobj / api / 		server ip : 172.67.156.115

your ip : 172.71.1.168

H O M E


Filename/usr/share/doc/python-configobj/api/configobj-module.html
Size41.67 kb
Permissionrw-r--r--
Ownerroot : root
Create time27-Apr-2025 09:56
Last modified23-Feb-2014 22:30
Last accessed06-Jul-2025 23:35
Actionsedit | rename | delete | download (gzip)
Viewtext | code | image
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>configobj</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th bgcolor="#70b0f0" class="navbar-select"
>&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.voidspace.org.uk/python/configobj.html">ConfigObj</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Module&nbsp;configobj
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="configobj-module.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module configobj</h1><p class="nomargin-top"><span class="codelink"><a href="configobj-pysrc.html">source&nbsp;code</a></span></p>
<hr />
<div class="fields"> <p><strong>Version:</strong>
4.7.2
</p>
</div><!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Classes"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.UnknownType-class.html" class="summary-name">UnknownType</a>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.Builder-class.html" class="summary-name" onclick="show_private();">Builder</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.ConfigObjError-class.html" class="summary-name">ConfigObjError</a><br />
This is the base class for all errors that ConfigObj raises.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.NestingError-class.html" class="summary-name">NestingError</a><br />
This error indicates a level of nesting that doesn't match.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.ParseError-class.html" class="summary-name">ParseError</a><br />
This error indicates that a line is badly written.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.ReloadError-class.html" class="summary-name">ReloadError</a><br />
A 'reload' operation failed.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.DuplicateError-class.html" class="summary-name">DuplicateError</a><br />
The keyword or section specified already exists.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.ConfigspecError-class.html" class="summary-name">ConfigspecError</a><br />
An error occured whilst parsing a configspec.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.InterpolationError-class.html" class="summary-name">InterpolationError</a><br />
Base class for the two interpolation errors.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.InterpolationLoopError-class.html" class="summary-name">InterpolationLoopError</a><br />
Maximum interpolation depth exceeded in string interpolation.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.RepeatSectionError-class.html" class="summary-name">RepeatSectionError</a><br />
This error indicates additional sections in a section with a
``__many__`` (repeated) section.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.MissingInterpolationOption-class.html" class="summary-name">MissingInterpolationOption</a><br />
A value specified for interpolation was missing.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.UnreprError-class.html" class="summary-name">UnreprError</a><br />
An error parsing in unrepr mode.
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.InterpolationEngine-class.html" class="summary-name" onclick="show_private();">InterpolationEngine</a><br />
A helper class to help perform string interpolation.
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.ConfigParserInterpolation-class.html" class="summary-name" onclick="show_private();">ConfigParserInterpolation</a><br />
Behaves like ConfigParser.
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.TemplateInterpolation-class.html" class="summary-name" onclick="show_private();">TemplateInterpolation</a><br />
Behaves like string.Template.
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.Section-class.html" class="summary-name" onclick="show_private();">Section</a><br />
A dictionary-like object that represents a section in a config
file.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.ConfigObj-class.html" class="summary-name">ConfigObj</a><br />
An object to read, create, and write config files.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj.SimpleVal-class.html" class="summary-name">SimpleVal</a><br />
A simple validator.
</td>
</tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="match_utf8"></a><span class="summary-sig-name">match_utf8</span>(<span class="summary-sig-arg">encoding</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#match_utf8">source&nbsp;code</a></span>

</td>
</tr>
</table>

</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="any"></a><span class="summary-sig-name">any</span>(<span class="summary-sig-arg">iterable</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#any">source&nbsp;code</a></span>

</td>
</tr>
</table>

</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="getObj"></a><span class="summary-sig-name">getObj</span>(<span class="summary-sig-arg">s</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#getObj">source&nbsp;code</a></span>

</td>
</tr>
</table>

</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="unrepr"></a><span class="summary-sig-name">unrepr</span>(<span class="summary-sig-arg">s</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#unrepr">source&nbsp;code</a></span>

</td>
</tr>
</table>

</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__newobj__"></a><span class="summary-sig-name">__newobj__</span>(<span class="summary-sig-arg">cls</span>,
<span class="summary-sig-arg">*args</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#__newobj__">source&nbsp;code</a></span>

</td>
</tr>
</table>

</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj-module.html#flatten_errors" class="summary-sig-name">flatten_errors</a>(<span class="summary-sig-arg">cfg</span>,
<span class="summary-sig-arg">res</span>,
<span class="summary-sig-arg">levels</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">results</span>=<span class="summary-sig-default">None</span>)</span><br />
An example function that will turn a nested dictionary of results
(as returned by ``ConfigObj.validate``) into a flat list.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#flatten_errors">source&nbsp;code</a></span>

</td>
</tr>
</table>

</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj-module.html#get_extra_values" class="summary-sig-name">get_extra_values</a>(<span class="summary-sig-arg">conf</span>,
<span class="summary-sig-arg">_prepend</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>)</span><br />
Find all the values and sections not in the configspec from a
validated ConfigObj.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#get_extra_values">source&nbsp;code</a></span>

</td>
</tr>
</table>

</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="compiler"></a><span class="summary-name">compiler</span> = <code title="None">None</code><br />
hash(x)
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj-module.html#BOMS" class="summary-name" onclick="show_private();">BOMS</a> = <code title="{'\xef\xbb\xbf': ('utf_8', None),
'\xfe\xff': ('utf16_be', 'utf_16'),
'\xff\xfe': ('utf_16', 'utf_16')}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">\xef\xbb\xbf</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">utf_8</code><code class="variable-quote">'</code><code class="variable-op">, </code>None<code class="variable-group">)</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">\xfe\xff</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">utf16_b</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj-module.html#BOM_LIST" class="summary-name" onclick="show_private();">BOM_LIST</a> = <code title="{'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',
..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">u16</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">utf_16</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">u8</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">utf_8</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">utf</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">utf_8</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">u</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj-module.html#BOM_SET" class="summary-name" onclick="show_private();">BOM_SET</a> = <code title="{None: '\xef\xbb\xbf',
'utf16_be': '\xfe\xff',
'utf16_le': '\xff\xfe',
'utf_16': '\xff\xfe',
'utf_8': '\xef\xbb\xbf'}"><code class="variable-group">{</code>None<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">\xef\xbb\xbf</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">utf16_be</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">\xfe\xff</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">utf1</code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="squot"></a><span class="summary-name">squot</span> = <code title="'\'%s\''"><code class="variable-quote">'</code><code class="variable-string">\'%s\'</code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="dquot"></a><span class="summary-name">dquot</span> = <code title="'&quot;%s&quot;'"><code class="variable-quote">'</code><code class="variable-string">&quot;%s&quot;</code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="noquot"></a><span class="summary-name">noquot</span> = <code title="'%s'"><code class="variable-quote">'</code><code class="variable-string">%s</code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="wspace_plus"></a><span class="summary-name">wspace_plus</span> = <code title="''' \r
\x0b\t\'&quot;'''"><code class="variable-quote">'</code><code class="variable-string"> \r\n\x0b\t\'&quot;</code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="tsquot"></a><span class="summary-name">tsquot</span> = <code title="'&quot;&quot;&quot;%s&quot;&quot;&quot;'"><code class="variable-quote">'</code><code class="variable-string">&quot;&quot;&quot;%s&quot;&quot;&quot;</code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="tdquot"></a><span class="summary-name">tdquot</span> = <code title="'\'\'\'%s\'\'\''"><code class="variable-quote">'</code><code class="variable-string">\'\'\'%s\'\'\'</code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="MISSING"></a><span class="summary-name">MISSING</span> = <code title="object()">object()</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="DEFAULT_INTERPOLATION"></a><span class="summary-name">DEFAULT_INTERPOLATION</span> = <code title="'configparser'"><code class="variable-quote">'</code><code class="variable-string">configparser</code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="DEFAULT_INDENT_TYPE"></a><span class="summary-name">DEFAULT_INDENT_TYPE</span> = <code title="' '"><code class="variable-quote">'</code><code class="variable-string"> </code><code class="variable-quote">'</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="MAX_INTERPOL_DEPTH"></a><span class="summary-name">MAX_INTERPOL_DEPTH</span> = <code title="10">10</code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj-module.html#OPTION_DEFAULTS" class="summary-name" onclick="show_private();">OPTION_DEFAULTS</a> = <code title="{'configspec': None,
'create_empty': False,
'default_encoding': None,
'encoding': None,
'file_error': False,
'indent_type': None,
'interpolation': True,
'list_values': True,
..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">configspec</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">create_empty</code><code class="variable-quote">'</code><code class="variable-op">: </code>False<code class="variable-op">, </code><code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="_builder"></a><span class="summary-name">_builder</span> = <code title="Builder()">Builder()</code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a href="configobj-module.html#interpolation_engines" class="summary-name" onclick="show_private();">interpolation_engines</a> = <code title="{'configparser': &lt;class 'configobj.ConfigParserInterpolation'&gt;,
'template': &lt;class 'configobj.TemplateInterpolation'&gt;}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">configparser</code><code class="variable-quote">'</code><code class="variable-op">: </code>&lt;class 'configobj.Con<code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code><br />
hash(x)
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="flatten_errors"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">flatten_errors</span>(<span class="sig-arg">cfg</span>,
<span class="sig-arg">res</span>,
<span class="sig-arg">levels</span>=<span class="sig-default">None</span>,
<span class="sig-arg">results</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#flatten_errors">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>

<pre class="literalblock">

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 &quot;3&quot; is of the wrong type*.

</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="get_extra_values"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_extra_values</span>(<span class="sig-arg">conf</span>,
<span class="sig-arg">_prepend</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#get_extra_values">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>

<p>Find all the values and sections not in the configspec from a
validated ConfigObj.</p>
<p>``get_extra_values`` returns a list of tuples where each tuple
represents either an extra section, or an extra value.</p>
<p>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')``.</p>
<p>NOTE: If you call ``get_extra_values`` on a ConfigObj instance that
hasn't been validated it will return an empty list.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-VariablesDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="BOMS"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">BOMS</h3>

<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">\xef\xbb\xbf</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">utf_8</code><code class="variable-quote">'</code><code class="variable-op">, </code>None<code class="variable-group">)</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">\xfe\xff</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">utf16_be</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">utf_16</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">\xff\xfe</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code><code class="variable-quote">'</code><code class="variable-string">utf_16</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">utf_16</code><code class="variable-quote">'</code><code class="variable-group">)</code><code class="variable-group">}</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="BOM_LIST"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">BOM_LIST</h3>

<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">u16</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">utf_16</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">u8</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">utf_8</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">utf</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">utf_8</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">utf-16</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">utf_16</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">utf-16be</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">utf16_be</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">utf-16le</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">utf16_le</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">utf-8</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">utf_8</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">utf16</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">utf_16</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="BOM_SET"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">BOM_SET</h3>

<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code>None<code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">\xef\xbb\xbf</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">utf16_be</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">\xfe\xff</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">utf16_le</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">\xff\xfe</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">utf_16</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">\xff\xfe</code><code class="variable-quote">'</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">utf_8</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">\xef\xbb\xbf</code><code class="variable-quote">'</code><code class="variable-group">}</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="OPTION_DEFAULTS"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">OPTION_DEFAULTS</h3>

<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">configspec</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">create_empty</code><code class="variable-quote">'</code><code class="variable-op">: </code>False<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">default_encoding</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">encoding</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">file_error</code><code class="variable-quote">'</code><code class="variable-op">: </code>False<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">indent_type</code><code class="variable-quote">'</code><code class="variable-op">: </code>None<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">interpolation</code><code class="variable-quote">'</code><code class="variable-op">: </code>True<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">list_values</code><code class="variable-quote">'</code><code class="variable-op">: </code>True<code class="variable-op">,</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="interpolation_engines"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">interpolation_engines</h3>

<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">configparser</code><code class="variable-quote">'</code><code class="variable-op">: </code>&lt;class 'configobj.ConfigParserInterpolation'&gt;<code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">template</code><code class="variable-quote">'</code><code class="variable-op">: </code>&lt;class 'configobj.TemplateInterpolation'&gt;<code class="variable-group">}</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th bgcolor="#70b0f0" class="navbar-select"
>&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.voidspace.org.uk/python/configobj.html">ConfigObj</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sun Feb 23 14:30:53 2014
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>

<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>