Current Path : /usr/share/doc/python-configobj/api/ |
Current File : //usr/share/doc/python-configobj/api/configobj.TemplateInterpolation-class.html |
<?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.TemplateInterpolation</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 TemplateInterpolation </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.TemplateInterpolation-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class TemplateInterpolation</h1><p class="nomargin-top"><span class="codelink"><a href="configobj-pysrc.html#TemplateInterpolation">source code</a></span></p> <pre class="base-tree"> object --+ | <a href="configobj.InterpolationEngine-class.html" onclick="show_private();">InterpolationEngine</a> --+ | <strong class="uidshort">TemplateInterpolation</strong> </pre> <hr /> <p>Behaves like string.Template.</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 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.TemplateInterpolation-class.html#_parse_match" class="summary-sig-name" onclick="show_private();">_parse_match</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">match</span>)</span><br /> Implementation-dependent helper function.</td> <td align="right" valign="top"> <span class="codelink"><a href="configobj-pysrc.html#TemplateInterpolation._parse_match">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.InterpolationEngine-class.html" onclick="show_private();">InterpolationEngine</a></code></b>: <code><a href="configobj.InterpolationEngine-class.html#__init__">__init__</a></code>, <code><a href="configobj.InterpolationEngine-class.html#interpolate">interpolate</a></code> </p> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="configobj.InterpolationEngine-class.html" onclick="show_private();">InterpolationEngine</a></code></b> (private): <code><a href="configobj.InterpolationEngine-class.html#_fetch" onclick="show_private();">_fetch</a></code> </p></div> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__delattr__</code>, <code>__format__</code>, <code>__getattribute__</code>, <code>__hash__</code>, <code>__new__</code>, <code>__reduce__</code>, <code>__reduce_ex__</code>, <code>__repr__</code>, <code>__setattr__</code>, <code>__sizeof__</code>, <code>__str__</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 name="_cookie"></a><span class="summary-name">_cookie</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"> </span> </td><td class="summary"> <a name="_delimiter"></a><span class="summary-name">_delimiter</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"> </span> </td><td class="summary"> <a href="configobj.TemplateInterpolation-class.html#_KEYCRE" class="summary-name" onclick="show_private();">_KEYCRE</a> = <code title="re.compile(r'(?ix)\$(?:(?P<escaped>\$)|(?P<named>[_a-z][_a-z0-9]*)|\{(\ ?P<braced>[^\}]*)\})')">re.compile(r'<code class="re-flags">(?ix)</code>\$<code class="re-group">(?:</code><code class="re-group">(?P<</code><code class="re-ref">escaped</code><code class="re-group">></code>\$<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?P<</code><code class="re-ref">named</code><code class="re-group">></code><code class="re-group">[</code>_a<code class="variable-ellipsis">...</code></code> </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="_parse_match"></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">_parse_match</span>(<span class="sig-arg">self</span>, <span class="sig-arg">match</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="configobj-pysrc.html#TemplateInterpolation._parse_match">source code</a></span> </td> </tr></table> <p>Implementation-dependent helper function.</p> <p>Will be passed a match object corresponding to the interpolation key we just found (e.g., "%(foo)s" or "$foo"). Should look up that key in the appropriate config file section (using the ``_fetch()`` helper function) and return a 3-tuple: (key, value, section)</p> <p>``key`` is the name of the key we're looking for ``value`` is the value found for that key ``section`` is a reference to the section where it was found</p> <p>``key`` and ``section`` should be None if no further interpolation should be performed on the resulting value (e.g., if we interpolated "$$" and returned "$").</p> <dl class="fields"> <dt>Overrides: <a href="configobj.InterpolationEngine-class.html#_parse_match" onclick="show_private();">InterpolationEngine._parse_match</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </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="_KEYCRE"></a> <div class="private"> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">_KEYCRE</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">(?ix)</code>\$<code class="re-group">(?:</code><code class="re-group">(?P<</code><code class="re-ref">escaped</code><code class="re-group">></code>\$<code class="re-group">)</code><code class="re-op">|</code><code class="re-group">(?P<</code><code class="re-ref">named</code><code class="re-group">></code><code class="re-group">[</code>_a<code class="re-op">-</code>z<code class="re-group">]</code><code class="re-group">[</code>_a<code class="re-op">-</code>z0<code class="re-op">-</code>9<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><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span> <code class="re-group">?P<</code><code class="re-ref">braced</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-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>