Your IP : 172.28.240.42
<?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.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> <a
href="configobj-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </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">
<a href="configobj-module.html">Module configobj</a> ::
Class 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 private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="configobj.ConfigObj-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ConfigObj</h1><p class="nomargin-top"><span class="codelink"><a href="configobj-pysrc.html#ConfigObj">source code</a></span></p>
<pre class="base-tree">
object --+
|
dict --+
|
<a href="configobj.Section-class.html" onclick="show_private();">Section</a> --+
|
<strong class="uidshort">ConfigObj</strong>
</pre>
<hr />
<p>An object to read, create, and write config files.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></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">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
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"><pre class="literalblock">
new empty dictionary
</pre></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj.ConfigObj-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">infile</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">options</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">configspec</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">interpolation</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">raise_errors</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">list_values</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">create_empty</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">file_error</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">stringify</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">indent_type</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">default_encoding</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">unrepr</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">write_empty_values</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">_inspec</span>=<span class="summary-sig-default">False</span>)</span><br />
Parse a config file or create a config file object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_load"></a><span class="summary-sig-name">_load</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">infile</span>,
<span class="summary-sig-arg">configspec</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._load">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj.ConfigObj-class.html#_initialise" class="summary-sig-name" onclick="show_private();">_initialise</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">options</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._initialise">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj.ConfigObj-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
str(x)</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj.__repr__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj.ConfigObj-class.html#_handle_bom" class="summary-sig-name" onclick="show_private();">_handle_bom</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">infile</span>)</span><br />
Handle any BOM, and decode if necessary.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._handle_bom">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_a_to_u"></a><span class="summary-sig-name">_a_to_u</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">aString</span>)</span><br />
Decode ASCII strings to unicode if a self.encoding is specified.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._a_to_u">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj.ConfigObj-class.html#_decode" class="summary-sig-name" onclick="show_private();">_decode</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">infile</span>,
<span class="summary-sig-arg">encoding</span>)</span><br />
Decode infile to unicode.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._decode">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_decode_element"></a><span class="summary-sig-name">_decode_element</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">line</span>)</span><br />
Decode element to unicode if necessary.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._decode_element">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_str"></a><span class="summary-sig-name">_str</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Used by ``stringify`` within validate, to turn non-string values into
strings.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._str">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_parse"></a><span class="summary-sig-name">_parse</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">infile</span>)</span><br />
Actually parse the config file.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._parse">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj.ConfigObj-class.html#_match_depth" class="summary-sig-name" onclick="show_private();">_match_depth</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">sect</span>,
<span class="summary-sig-arg">depth</span>)</span><br />
Given a section and a depth level, walk back through the sections
parents to see if the depth level matches a previous section.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._match_depth">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj.ConfigObj-class.html#_handle_error" class="summary-sig-name" onclick="show_private();">_handle_error</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">text</span>,
<span class="summary-sig-arg">ErrorClass</span>,
<span class="summary-sig-arg">infile</span>,
<span class="summary-sig-arg">cur_index</span>)</span><br />
Handle an error according to the error settings.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._handle_error">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_unquote"></a><span class="summary-sig-name">_unquote</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Return an unquoted version of a value</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._unquote">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj.ConfigObj-class.html#_quote" class="summary-sig-name" onclick="show_private();">_quote</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>,
<span class="summary-sig-arg">multiline</span>=<span class="summary-sig-default">True</span>)</span><br />
Return a safely quoted version of a value.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._quote">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_get_single_quote"></a><span class="summary-sig-name">_get_single_quote</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._get_single_quote">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_get_triple_quote"></a><span class="summary-sig-name">_get_triple_quote</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._get_triple_quote">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj.ConfigObj-class.html#_handle_value" class="summary-sig-name" onclick="show_private();">_handle_value</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span><br />
Given a value string, unquote, remove comment, handle lists.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._handle_value">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_multiline"></a><span class="summary-sig-name">_multiline</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>,
<span class="summary-sig-arg">infile</span>,
<span class="summary-sig-arg">cur_index</span>,
<span class="summary-sig-arg">maxline</span>)</span><br />
Extract the value, where we are in a multiline situation.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._multiline">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_handle_configspec"></a><span class="summary-sig-name">_handle_configspec</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">configspec</span>)</span><br />
Parse the configspec.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._handle_configspec">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj.ConfigObj-class.html#_set_configspec" class="summary-sig-name" onclick="show_private();">_set_configspec</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">section</span>,
<span class="summary-sig-arg">copy</span>)</span><br />
Called by validate.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._set_configspec">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_write_line"></a><span class="summary-sig-name">_write_line</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">indent_string</span>,
<span class="summary-sig-arg">entry</span>,
<span class="summary-sig-arg">this_entry</span>,
<span class="summary-sig-arg">comment</span>)</span><br />
Write an individual line, for the write method</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._write_line">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_write_marker"></a><span class="summary-sig-name">_write_marker</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">indent_string</span>,
<span class="summary-sig-arg">depth</span>,
<span class="summary-sig-arg">entry</span>,
<span class="summary-sig-arg">comment</span>)</span><br />
Write a section marker line</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._write_marker">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_handle_comment"></a><span class="summary-sig-name">_handle_comment</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">comment</span>)</span><br />
Deal with a comment.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj._handle_comment">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj.ConfigObj-class.html#write" class="summary-sig-name">write</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">outfile</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">section</span>=<span class="summary-sig-default">None</span>)</span><br />
Write the current ConfigObj as a file</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj.write">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj.ConfigObj-class.html#validate" class="summary-sig-name">validate</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">validator</span>,
<span class="summary-sig-arg">preserve_errors</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">copy</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">section</span>=<span class="summary-sig-default">None</span>)</span><br />
Test the ConfigObj against a configspec.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj.validate">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="reset"></a><span class="summary-sig-name">reset</span>(<span class="summary-sig-arg">self</span>)</span><br />
Clear ConfigObj instance and restore to 'freshly created' state.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj.reset">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="configobj.ConfigObj-class.html#reload" class="summary-sig-name">reload</a>(<span class="summary-sig-arg">self</span>)</span><br />
Reload a ConfigObj from file.</td>
<td align="right" valign="top">
<span class="codelink"><a href="configobj-pysrc.html#ConfigObj.reload">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="configobj.Section-class.html" onclick="show_private();">Section</a></code></b>:
<code><a href="configobj.Section-class.html#__delitem__">__delitem__</a></code>,
<code><a href="configobj.Section-class.html#__getitem__">__getitem__</a></code>,
<code><a href="configobj.Section-class.html#__iter__">__iter__</a></code>,
<code><a href="configobj.Section-class.html#__reduce__">__reduce__</a></code>,
<code><a href="configobj.Section-class.html#__setitem__">__setitem__</a></code>,
<code><a href="configobj.Section-class.html#__setstate__">__setstate__</a></code>,
<code><a href="configobj.Section-class.html#__str__">__str__</a></code>,
<code><a href="configobj.Section-class.html#as_bool">as_bool</a></code>,
<code><a href="configobj.Section-class.html#as_float">as_float</a></code>,
<code><a href="configobj.Section-class.html#as_int">as_int</a></code>,
<code><a href="configobj.Section-class.html#as_list">as_list</a></code>,
<code><a href="configobj.Section-class.html#clear">clear</a></code>,
<code><a href="configobj.Section-class.html#dict">dict</a></code>,
<code><a href="configobj.Section-class.html#get">get</a></code>,
<code><a href="configobj.Section-class.html#items">items</a></code>,
<code><a href="configobj.Section-class.html#iteritems">iteritems</a></code>,
<code><a href="configobj.Section-class.html#iterkeys">iterkeys</a></code>,
<code><a href="configobj.Section-class.html#itervalues">itervalues</a></code>,
<code><a href="configobj.Section-class.html#keys">keys</a></code>,
<code><a href="configobj.Section-class.html#merge">merge</a></code>,
<code><a href="configobj.Section-class.html#pop">pop</a></code>,
<code><a href="configobj.Section-class.html#popitem">popitem</a></code>,
<code><a href="configobj.Section-class.html#rename">rename</a></code>,
<code><a href="configobj.Section-class.html#restore_default">restore_default</a></code>,
<code><a href="configobj.Section-class.html#restore_defaults">restore_defaults</a></code>,
<code><a href="configobj.Section-class.html#setdefault">setdefault</a></code>,
<code><a href="configobj.Section-class.html#update">update</a></code>,
<code><a href="configobj.Section-class.html#values">values</a></code>,
<code><a href="configobj.Section-class.html#walk">walk</a></code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="configobj.Section-class.html" onclick="show_private();">Section</a></code></b> (private):
<code><a href="configobj.Section-class.html#_interpolate" onclick="show_private();">_interpolate</a></code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code>dict</code></b>:
<code>__cmp__</code>,
<code>__contains__</code>,
<code>__eq__</code>,
<code>__ge__</code>,
<code>__getattribute__</code>,
<code>__gt__</code>,
<code>__le__</code>,
<code>__len__</code>,
<code>__lt__</code>,
<code>__ne__</code>,
<code>__new__</code>,
<code>__sizeof__</code>,
<code>copy</code>,
<code>fromkeys</code>,
<code>has_key</code>,
<code>viewitems</code>,
<code>viewkeys</code>,
<code>viewvalues</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></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">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
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"> </span>
</td><td class="summary">
<a href="configobj.ConfigObj-class.html#_keyword" class="summary-name" onclick="show_private();">_keyword</a> = <code title="re.compile(r'(?x)^(\s*)((?:".*?")|(?:\'.*?\')|(?:[^\'"=].*?))\s*=\s*(.\
*)$')">re.compile(r'<code class="re-flags">(?x)</code>^<code class="re-group">(</code>\s<code class="re-op">*</code><code class="re-group">)</code><code class="re-group">(</code><code class="re-group">(?:</code>".<code class="re-op">*?</code>"<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code>\'.<code class="re-op">*?</code>\'<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code><code class="re-group">[</code><code class="re-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"> </span>
</td><td class="summary">
<a href="configobj.ConfigObj-class.html#_sectionmarker" class="summary-name" onclick="show_private();">_sectionmarker</a> = <code title="re.compile(r'(?x)^(\s*)((?:\[\s*)+)((?:"\s*\S.*?\s*")|(?:\'\s*\S.*?\s*\
\')|(?:[^\'"\s].*?))((?:\s*\])+)\s*(#.*)?$')">re.compile(r'<code class="re-flags">(?x)</code>^<code class="re-group">(</code>\s<code class="re-op">*</code><code class="re-group">)</code><code class="re-group">(</code><code class="re-group">(?:</code>\[\s<code class="re-op">*</code><code class="re-group">)</code><code class="re-op">+</code><code class="re-group">)</code><code class="re-group">(</code><code class="re-group">(?:</code>"\s<code class="re-op">*</code>\S<code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="configobj.ConfigObj-class.html#_valueexp" class="summary-name" onclick="show_private();">_valueexp</a> = <code title="re.compile(r'(?x)^(?:(?:((?:(?:(?:".*?")|(?:\'.*?\')|(?:[^\'",#][^,#]*\
?))\s*,\s*)*)((?:".*?")|(?:\'.*?\')|(?:[^\'",#\s][^,]*?)|(?:(?<!,)))?)\
|(,))\s*(#.*)?$')">re.compile(r'<code class="re-flags">(?x)</code>^<code class="re-group">(?:</code><code class="re-group">(?:</code><code class="re-group">(</code><code class="re-group">(?:</code><code class="re-group">(?:</code><code class="re-group">(?:</code>".<code class="re-op">*?</code>"<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code>\'.<code class="re-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"> </span>
</td><td class="summary">
<a href="configobj.ConfigObj-class.html#_listvalueexp" class="summary-name" onclick="show_private();">_listvalueexp</a> = <code title="re.compile(r'(?x)((?:".*?")|(?:\'.*?\')|(?:[^\'",#]?.*?))\s*,\s*')">re.compile(r'<code class="re-flags">(?x)</code><code class="re-group">(</code><code class="re-group">(?:</code>".<code class="re-op">*?</code>"<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code>\'.<code class="re-op">*?</code>\'<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code><code class="re-group">[</code><code class="re-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"> </span>
</td><td class="summary">
<a href="configobj.ConfigObj-class.html#_nolistvalue" class="summary-name" onclick="show_private();">_nolistvalue</a> = <code title="re.compile(r'(?x)^((?:".*?")|(?:\'.*?\')|(?:[^\'"#].*?)|(?:))\s*(#.*)?\
$')">re.compile(r'<code class="re-flags">(?x)</code>^<code class="re-group">(</code><code class="re-group">(?:</code>".<code class="re-op">*?</code>"<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code>\'.<code class="re-op">*?</code>\'<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code><code class="re-group">[</code><code class="re-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"> </span>
</td><td class="summary">
<a name="_single_line_single"></a><span class="summary-name">_single_line_single</span> = <code title="re.compile(r'^\'\'\'(.*?)\'\'\'\s*(#.*)?$')">re.compile(r'^\'\'\'<code class="re-group">(</code>.<code class="re-op">*?</code><code class="re-group">)</code>\'\'\'\s<code class="re-op">*</code><code class="re-group">(</code>#.<code class="re-op">*</code><code class="re-group">)</code><code class="re-op">?</code>$')</code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_single_line_double"></a><span class="summary-name">_single_line_double</span> = <code title="re.compile(r'^"""(.*?)"""\s*(#.*)?$')">re.compile(r'^"""<code class="re-group">(</code>.<code class="re-op">*?</code><code class="re-group">)</code>"""\s<code class="re-op">*</code><code class="re-group">(</code>#.<code class="re-op">*</code><code class="re-group">)</code><code class="re-op">?</code>$')</code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_multi_line_single"></a><span class="summary-name">_multi_line_single</span> = <code title="re.compile(r'^(.*?)\'\'\'\s*(#.*)?$')">re.compile(r'^<code class="re-group">(</code>.<code class="re-op">*?</code><code class="re-group">)</code>\'\'\'\s<code class="re-op">*</code><code class="re-group">(</code>#.<code class="re-op">*</code><code class="re-group">)</code><code class="re-op">?</code>$')</code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_multi_line_double"></a><span class="summary-name">_multi_line_double</span> = <code title="re.compile(r'^(.*?)"""\s*(#.*)?$')">re.compile(r'^<code class="re-group">(</code>.<code class="re-op">*?</code><code class="re-group">)</code>"""\s<code class="re-op">*</code><code class="re-group">(</code>#.<code class="re-op">*</code><code class="re-group">)</code><code class="re-op">?</code>$')</code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="configobj.ConfigObj-class.html#_triple_quote" class="summary-name" onclick="show_private();">_triple_quote</a> = <code title="{'"""': (re.compile(r'^"""(.*?)"""\s*(#.*)?$'),
re.compile(r'^(.*?)"""\s*(#.*)?$')),
'\'\'\'': (re.compile(r'^\'\'\'(.*?)\'\'\'\s*(#.*)?$'),
re.compile(r'^(.*?)\'\'\'\s*(#.*)?$'))}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">"""</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>re.compile(r'^"""<code class="re-group">(</code>.<code class="re-op">*?</code><code class="re-group">)</code>"""\s<code class="re-op">*</code><code class="re-group">(</code>#.<code class="re-op">*</code><code class="re-group">)</code><code class="re-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"> </span>
</td><td class="summary">
<a href="configobj.ConfigObj-class.html#_bools" class="summary-name" onclick="show_private();">_bools</a> = <code title="{'0': False,
'1': True,
'false': False,
'no': False,
'off': False,
'on': True,
'true': True,
'yes': True}"><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">0</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">1</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">false</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">no</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>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>dict</code></b>:
<code>__hash__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></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">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></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">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></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">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">infile</span>=<span class="sig-default">None</span>,
<span class="sig-arg">options</span>=<span class="sig-default">None</span>,
<span class="sig-arg">configspec</span>=<span class="sig-default">None</span>,
<span class="sig-arg">encoding</span>=<span class="sig-default">None</span>,
<span class="sig-arg">interpolation</span>=<span class="sig-default">True</span>,
<span class="sig-arg">raise_errors</span>=<span class="sig-default">False</span>,
<span class="sig-arg">list_values</span>=<span class="sig-default">True</span>,
<span class="sig-arg">create_empty</span>=<span class="sig-default">False</span>,
<span class="sig-arg">file_error</span>=<span class="sig-default">False</span>,
<span class="sig-arg">stringify</span>=<span class="sig-default">True</span>,
<span class="sig-arg">indent_type</span>=<span class="sig-default">None</span>,
<span class="sig-arg">default_encoding</span>=<span class="sig-default">None</span>,
<span class="sig-arg">unrepr</span>=<span class="sig-default">False</span>,
<span class="sig-arg">write_empty_values</span>=<span class="sig-default">False</span>,
<span class="sig-arg">_inspec</span>=<span class="sig-default">False</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#ConfigObj.__init__">source code</a></span>
</td>
</tr></table>
<pre class="literalblock">
Parse a config file or create a config file object.
``ConfigObj(infile=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)``
</pre>
<dl class="fields">
<dt>Returns: <pre class="literalblock">
new empty dictionary
</pre></dt>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="_initialise"></a>
<div class="private">
<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">_initialise</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">options</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#ConfigObj._initialise">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
<a href="configobj.Section-class.html#_initialise" onclick="show_private();">Section._initialise</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="__repr__"></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">__repr__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#ConfigObj.__repr__">source code</a></span>
</td>
</tr></table>
<p>str(x)</p>
<dl class="fields">
<dt>Overrides:
object.__repr__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="_handle_bom"></a>
<div class="private">
<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">_handle_bom</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">infile</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#ConfigObj._handle_bom">source code</a></span>
</td>
</tr></table>
<p>Handle any BOM, and decode if necessary.</p>
<p>If an encoding is specified, that *must* be used - but the BOM should
still be removed (and the BOM attribute set).</p>
<p>(If the encoding is wrongly specified, then a BOM for an alternative
encoding won't be discovered or removed.)</p>
<p>If an encoding is not specified, UTF8 or UTF16 BOM will be detected
and removed. The BOM attribute will be set. UTF16 will be decoded to
unicode.</p>
<p>NOTE: This method must not be called with an empty ``infile``.</p>
<p>Specifying the *wrong* encoding is likely to cause a
``UnicodeDecodeError``.</p>
<p>``infile`` must always be returned as a list of lines, but may be
passed in as a single string.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_decode"></a>
<div class="private">
<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">_decode</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">infile</span>,
<span class="sig-arg">encoding</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#ConfigObj._decode">source code</a></span>
</td>
</tr></table>
<p>Decode infile to unicode. Using the specified encoding.</p>
<p>if is a string, it also needs converting to a list.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_match_depth"></a>
<div class="private">
<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">_match_depth</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">sect</span>,
<span class="sig-arg">depth</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#ConfigObj._match_depth">source code</a></span>
</td>
</tr></table>
<p>Given a section and a depth level, walk back through the sections
parents to see if the depth level matches a previous section.</p>
<p>Return a reference to the right section, or raise a SyntaxError.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_handle_error"></a>
<div class="private">
<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">_handle_error</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">text</span>,
<span class="sig-arg">ErrorClass</span>,
<span class="sig-arg">infile</span>,
<span class="sig-arg">cur_index</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#ConfigObj._handle_error">source code</a></span>
</td>
</tr></table>
<p>Handle an error according to the error settings.</p>
<p>Either raise the error or store it. The error will have occured at
``cur_index``</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_quote"></a>
<div class="private">
<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">_quote</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>,
<span class="sig-arg">multiline</span>=<span class="sig-default">True</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#ConfigObj._quote">source code</a></span>
</td>
</tr></table>
<p>Return a safely quoted version of a value.</p>
<p>Raise a ConfigObjError if the value cannot be safely quoted. If
multiline is ``True`` (default) then use triple quotes if necessary.</p>
<p>* Don't quote values that don't need it. * Recursively quote members
of a list and return a comma joined list. * Multiline is ``False`` for
lists. * Obey list syntax for empty and single member lists.</p>
<p>If ``list_values=False`` then the value is only quoted if it contains
a ``\n`` (is multiline) or '#'.</p>
<p>If ``write_empty_values`` is set, and the value is an empty string, it
won't be quoted.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_handle_value"></a>
<div class="private">
<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">_handle_value</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">value</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#ConfigObj._handle_value">source code</a></span>
</td>
</tr></table>
<p>Given a value string, unquote, remove comment, handle lists.
(including empty and single member lists)</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_set_configspec"></a>
<div class="private">
<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">_set_configspec</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">section</span>,
<span class="sig-arg">copy</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#ConfigObj._set_configspec">source code</a></span>
</td>
</tr></table>
<p>Called by validate. Handles setting the configspec on subsections
including sections to be validated by __many__</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="write"></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">write</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">outfile</span>=<span class="sig-default">None</span>,
<span class="sig-arg">section</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#ConfigObj.write">source code</a></span>
</td>
</tr></table>
<p>Write the current ConfigObj as a file</p>
<p>tekNico: FIXME: use StringIO instead of real files</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>filename = a.filename
<span class="py-prompt">>>> </span>a.filename = <span class="py-string">'test.ini'</span>
<span class="py-prompt">>>> </span>a.write()
<span class="py-prompt">>>> </span>a.filename = filename
<span class="py-prompt">>>> </span>a == ConfigObj(<span class="py-string">'test.ini'</span>, raise_errors=True)
<span class="py-output">1</span>
<span class="py-output"></span><span class="py-prompt">>>> </span><span class="py-keyword">import</span> os
<span class="py-prompt">>>> </span>os.remove(<span class="py-string">'test.ini'</span>)</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="validate"></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">validate</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">validator</span>,
<span class="sig-arg">preserve_errors</span>=<span class="sig-default">False</span>,
<span class="sig-arg">copy</span>=<span class="sig-default">False</span>,
<span class="sig-arg">section</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#ConfigObj.validate">source code</a></span>
</td>
</tr></table>
<p>Test the ConfigObj against a configspec.</p>
<p>It uses the ``validator`` object from *validate.py*.</p>
<p>To run ``validate`` on the current ConfigObj, call: :</p>
<pre class="literalblock">
test = config.validate(validator)
</pre>
<p>(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).</p>
<p>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).</p>
<p>In addition, it converts the values from strings to their native types
if their checks pass (and ``stringify`` is set).</p>
<p>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``.</p>
<p>You must have the validate module to use ``preserve_errors=True``.</p>
<p>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.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="reload"></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">reload</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="configobj-pysrc.html#ConfigObj.reload">source code</a></span>
</td>
</tr></table>
<p>Reload a ConfigObj from file.</p>
<p>This method raises a ``ReloadError`` if the ConfigObj doesn't have a
filename attribute pointing to a file.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
<a name="section-ClassVariableDetails"></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">Class Variable Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariableDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="_keyword"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_keyword</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
re.compile(r'<code class="re-flags">(?x)</code>^<code class="re-group">(</code>\s<code class="re-op">*</code><code class="re-group">)</code><code class="re-group">(</code><code class="re-group">(?:</code>".<code class="re-op">*?</code>"<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code>\'.<code class="re-op">*?</code>\'<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code><code class="re-group">[</code><code class="re-op">^</code>\'"=<code class="re-group">]</code>.<code class="re-op">*?</code><code class="re-group">)</code><code class="re-group">)</code>\s<code class="re-op">*</code>=\s<code class="re-op">*</code><code class="re-group">(</code>.<code class="re-op"></code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="re-op">*</code><code class="re-group">)</code>$')
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="_sectionmarker"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_sectionmarker</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
re.compile(r'<code class="re-flags">(?x)</code>^<code class="re-group">(</code>\s<code class="re-op">*</code><code class="re-group">)</code><code class="re-group">(</code><code class="re-group">(?:</code>\[\s<code class="re-op">*</code><code class="re-group">)</code><code class="re-op">+</code><code class="re-group">)</code><code class="re-group">(</code><code class="re-group">(?:</code>"\s<code class="re-op">*</code>\S.<code class="re-op">*?</code>\s<code class="re-op">*</code>"<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code>\'\s<code class="re-op">*</code>\S.<code class="re-op">*?</code>\s<code class="re-op">*</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
\'<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code><code class="re-group">[</code><code class="re-op">^</code>\'"\s<code class="re-group">]</code>.<code class="re-op">*?</code><code class="re-group">)</code><code class="re-group">)</code><code class="re-group">(</code><code class="re-group">(?:</code>\s<code class="re-op">*</code>\]<code class="re-group">)</code><code class="re-op">+</code><code class="re-group">)</code>\s<code class="re-op">*</code><code class="re-group">(</code>#.<code class="re-op">*</code><code class="re-group">)</code><code class="re-op">?</code>$')
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="_valueexp"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_valueexp</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
re.compile(r'<code class="re-flags">(?x)</code>^<code class="re-group">(?:</code><code class="re-group">(?:</code><code class="re-group">(</code><code class="re-group">(?:</code><code class="re-group">(?:</code><code class="re-group">(?:</code>".<code class="re-op">*?</code>"<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code>\'.<code class="re-op">*?</code>\'<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code><code class="re-group">[</code><code class="re-op">^</code>\'",#<code class="re-group">]</code><code class="re-group">[</code><code class="re-op">^</code>,#<code class="re-group">]</code><code class="re-op">*</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="re-op">?</code><code class="re-group">)</code><code class="re-group">)</code>\s<code class="re-op">*</code>,\s<code class="re-op">*</code><code class="re-group">)</code><code class="re-op">*</code><code class="re-group">)</code><code class="re-group">(</code><code class="re-group">(?:</code>".<code class="re-op">*?</code>"<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code>\'.<code class="re-op">*?</code>\'<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code><code class="re-group">[</code><code class="re-op">^</code>\'",#\s<code class="re-group">]</code><code class="re-group">[^</code>,<code class="re-group">]</code><code class="re-op">*?</code><code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code><code class="re-group">(?<!</code>,<code class="re-group">)</code><code class="re-group">)</code><code class="re-group">)</code><code class="re-op">?</code><code class="re-group">)</code><code class="re-op"></code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="re-op">|</code><code class="re-group">(</code>,<code class="re-group">)</code><code class="re-group">)</code>\s<code class="re-op">*</code><code class="re-group">(</code>#.<code class="re-op">*</code><code class="re-group">)</code><code class="re-op">?</code>$')
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="_listvalueexp"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_listvalueexp</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
re.compile(r'<code class="re-flags">(?x)</code><code class="re-group">(</code><code class="re-group">(?:</code>".<code class="re-op">*?</code>"<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code>\'.<code class="re-op">*?</code>\'<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code><code class="re-group">[</code><code class="re-op">^</code>\'",#<code class="re-group">]</code><code class="re-op">?</code>.<code class="re-op">*?</code><code class="re-group">)</code><code class="re-group">)</code>\s<code class="re-op">*</code>,\s<code class="re-op">*</code>')
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="_nolistvalue"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_nolistvalue</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
re.compile(r'<code class="re-flags">(?x)</code>^<code class="re-group">(</code><code class="re-group">(?:</code>".<code class="re-op">*?</code>"<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code>\'.<code class="re-op">*?</code>\'<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code><code class="re-group">[</code><code class="re-op">^</code>\'"#<code class="re-group">]</code>.<code class="re-op">*?</code><code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?:</code><code class="re-group">)</code><code class="re-group">)</code>\s<code class="re-op">*</code><code class="re-group">(</code>#.<code class="re-op">*</code><code class="re-group">)</code><code class="re-op">?</code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
$')
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="_triple_quote"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_triple_quote</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">"""</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>re.compile(r'^"""<code class="re-group">(</code>.<code class="re-op">*?</code><code class="re-group">)</code>"""\s<code class="re-op">*</code><code class="re-group">(</code>#.<code class="re-op">*</code><code class="re-group">)</code><code class="re-op">?</code>$')<code class="variable-op">,</code>
re.compile(r'^<code class="re-group">(</code>.<code class="re-op">*?</code><code class="re-group">)</code>"""\s<code class="re-op">*</code><code class="re-group">(</code>#.<code class="re-op">*</code><code class="re-group">)</code><code class="re-op">?</code>$')<code class="variable-group">)</code><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">\'\'\'</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-group">(</code>re.compile(r'^\'\'\'<code class="re-group">(</code>.<code class="re-op">*?</code><code class="re-group">)</code>\'\'\'\s<code class="re-op">*</code><code class="re-group">(</code>#.<code class="re-op">*</code><code class="re-group">)</code><code class="re-op">?</code>$')<code class="variable-op">,</code>
re.compile(r'^<code class="re-group">(</code>.<code class="re-op">*?</code><code class="re-group">)</code>\'\'\'\s<code class="re-op">*</code><code class="re-group">(</code>#.<code class="re-op">*</code><code class="re-group">)</code><code class="re-op">?</code>$')<code class="variable-group">)</code><code class="variable-group">}</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="_bools"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_bools</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">0</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">1</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">false</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">no</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">off</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">on</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">true</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">yes</code><code class="variable-quote">'</code><code class="variable-op">: </code>True<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> <a
href="configobj-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </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 Sat Dec 31 02:31:59 2011
</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>