doc/api/python/escapeddict.EscapedDict-class.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     1 <?xml version="1.0" encoding="ascii"?>
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3           "DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     5 <head>
       
     6   <title>escapeddict.EscapedDict</title>
       
     7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
       
     8   <script type="text/javascript" src="epydoc.js"></script>
       
     9 </head>
       
    10 
       
    11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
       
    12       alink="#204080">
       
    13 <!-- ==================== NAVIGATION BAR ==================== -->
       
    14 <table class="navbar" border="0" width="100%" cellpadding="0"
       
    15        bgcolor="#a0c0ff" cellspacing="0">
       
    16   <tr valign="middle">
       
    17 
       
    18   <!-- Tree link -->
       
    19       <th>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
    29 
       
    30       <th class="navbar" width="100%"></th>
       
    31   </tr>
       
    32 </table>
       
    33 <table width="100%" cellpadding="0" cellspacing="0">
       
    34   <tr valign="top">
       
    35     <td width="100%">
       
    36       <span class="breadcrumbs">
       
    37         <a href="escapeddict-module.html">Module&nbsp;escapeddict</a> ::
       
    38         Class&nbsp;EscapedDict
       
    39       </span>
       
    40     </td>
       
    41     <td>
       
    42       <table cellpadding="0" cellspacing="0">
       
    43         <!-- hide/show private -->
       
    44         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    45     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    46         <tr><td align="right"><span class="options"
       
    47             >[<a href="frames.html" target="_top">frames</a
       
    48             >]&nbsp;|&nbsp;<a href="escapeddict.EscapedDict-class.html"
       
    49             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    50       </table>
       
    51     </td>
       
    52   </tr>
       
    53 </table>
       
    54 <!-- ==================== CLASS DESCRIPTION ==================== -->
       
    55 <h1 class="epydoc">Class EscapedDict</h1><span class="codelink"><a href="escapeddict-pysrc.html#EscapedDict">source&nbsp;code</a></span><br /><br />
       
    56 <pre class="base-tree">
       
    57 UserDict.UserDict --+
       
    58                     |
       
    59                    <strong class="uidshort">EscapedDict</strong>
       
    60 </pre>
       
    61 
       
    62 <hr />
       
    63 Implements a dictionary that escapes the key values recursively.<br /><br />
       
    64 
       
    65 <!-- ==================== INSTANCE METHODS ==================== -->
       
    66 <a name="section-InstanceMethods"></a>
       
    67 <table class="summary" border="1" cellpadding="3"
       
    68        cellspacing="0" width="100%" bgcolor="white">
       
    69 <tr bgcolor="#70b0f0" class="table-header">
       
    70   <td colspan="2" class="table-header">
       
    71     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    72       <tr valign="top">
       
    73         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    74         <td align="right" valign="top"
       
    75          ><span class="options">[<a href="#section-InstanceMethods"
       
    76          class="privatelink" onclick="toggle_private();"
       
    77          >hide private</a>]</span></td>
       
    78       </tr>
       
    79     </table>
       
    80   </td>
       
    81 </tr>
       
    82 <tr>
       
    83     <td width="15%" align="right" valign="top" class="summary">
       
    84       <span class="summary-type">&nbsp;</span>
       
    85     </td><td class="summary">
       
    86       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    87         <tr>
       
    88           <td><span class="summary-sig"><a href="escapeddict.EscapedDict-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    89         <span class="summary-sig-arg">dict</span>=<span class="summary-sig-default">{}</span>,
       
    90         <span class="summary-sig-arg">failonerror</span>=<span class="summary-sig-default">False</span>)</span></td>
       
    91           <td align="right" valign="top">
       
    92             <span class="codelink"><a href="escapeddict-pysrc.html#EscapedDict.__init__">source&nbsp;code</a></span>
       
    93             
       
    94           </td>
       
    95         </tr>
       
    96       </table>
       
    97       
       
    98     </td>
       
    99   </tr>
       
   100 <tr>
       
   101     <td width="15%" align="right" valign="top" class="summary">
       
   102       <span class="summary-type">&nbsp;</span>
       
   103     </td><td class="summary">
       
   104       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   105         <tr>
       
   106           <td><span class="summary-sig"><a href="escapeddict.EscapedDict-class.html#__getitem__" class="summary-sig-name">__getitem__</a>(<span class="summary-sig-arg">self</span>,
       
   107         <span class="summary-sig-arg">key</span>)</span><br />
       
   108       Overrides the usual __getitem__ to insert values of other keys referenced in this key's
       
   109 value.</td>
       
   110           <td align="right" valign="top">
       
   111             <span class="codelink"><a href="escapeddict-pysrc.html#EscapedDict.__getitem__">source&nbsp;code</a></span>
       
   112             
       
   113           </td>
       
   114         </tr>
       
   115       </table>
       
   116       
       
   117     </td>
       
   118   </tr>
       
   119   <tr>
       
   120     <td colspan="2" class="summary">
       
   121     <p class="indent-wrapped-lines"><b>Inherited from <code>UserDict.UserDict</code></b>:
       
   122       <code>__cmp__</code>,
       
   123       <code>__contains__</code>,
       
   124       <code>__delitem__</code>,
       
   125       <code>__len__</code>,
       
   126       <code>__repr__</code>,
       
   127       <code>__setitem__</code>,
       
   128       <code>clear</code>,
       
   129       <code>copy</code>,
       
   130       <code>get</code>,
       
   131       <code>has_key</code>,
       
   132       <code>items</code>,
       
   133       <code>iteritems</code>,
       
   134       <code>iterkeys</code>,
       
   135       <code>itervalues</code>,
       
   136       <code>keys</code>,
       
   137       <code>pop</code>,
       
   138       <code>popitem</code>,
       
   139       <code>setdefault</code>,
       
   140       <code>update</code>,
       
   141       <code>values</code>
       
   142       </p>
       
   143     </td>
       
   144   </tr>
       
   145 </table>
       
   146 <!-- ==================== CLASS METHODS ==================== -->
       
   147 <a name="section-ClassMethods"></a>
       
   148 <table class="summary" border="1" cellpadding="3"
       
   149        cellspacing="0" width="100%" bgcolor="white">
       
   150 <tr bgcolor="#70b0f0" class="table-header">
       
   151   <td colspan="2" class="table-header">
       
   152     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   153       <tr valign="top">
       
   154         <td align="left"><span class="table-header">Class Methods</span></td>
       
   155         <td align="right" valign="top"
       
   156          ><span class="options">[<a href="#section-ClassMethods"
       
   157          class="privatelink" onclick="toggle_private();"
       
   158          >hide private</a>]</span></td>
       
   159       </tr>
       
   160     </table>
       
   161   </td>
       
   162 </tr>
       
   163   <tr>
       
   164     <td colspan="2" class="summary">
       
   165     <p class="indent-wrapped-lines"><b>Inherited from <code>UserDict.UserDict</code></b>:
       
   166       <code>fromkeys</code>
       
   167       </p>
       
   168     </td>
       
   169   </tr>
       
   170 </table>
       
   171 <!-- ==================== METHOD DETAILS ==================== -->
       
   172 <a name="section-MethodDetails"></a>
       
   173 <table class="details" border="1" cellpadding="3"
       
   174        cellspacing="0" width="100%" bgcolor="white">
       
   175 <tr bgcolor="#70b0f0" class="table-header">
       
   176   <td colspan="2" class="table-header">
       
   177     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   178       <tr valign="top">
       
   179         <td align="left"><span class="table-header">Method Details</span></td>
       
   180         <td align="right" valign="top"
       
   181          ><span class="options">[<a href="#section-MethodDetails"
       
   182          class="privatelink" onclick="toggle_private();"
       
   183          >hide private</a>]</span></td>
       
   184       </tr>
       
   185     </table>
       
   186   </td>
       
   187 </tr>
       
   188 </table>
       
   189 <a name="__init__"></a>
       
   190 <div>
       
   191 <table class="details" border="1" cellpadding="3"
       
   192        cellspacing="0" width="100%" bgcolor="white">
       
   193 <tr><td>
       
   194   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   195   <tr valign="top"><td>
       
   196   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   197         <span class="sig-arg">dict</span>=<span class="sig-default">{}</span>,
       
   198         <span class="sig-arg">failonerror</span>=<span class="sig-default">False</span>)</span>
       
   199     <br /><em class="fname">(Constructor)</em>
       
   200   </h3>
       
   201   </td><td align="right" valign="top"
       
   202     ><span class="codelink"><a href="escapeddict-pysrc.html#EscapedDict.__init__">source&nbsp;code</a></span>&nbsp;
       
   203     </td>
       
   204   </table>
       
   205   
       
   206   
       
   207   <dl class="fields">
       
   208     <dt>Overrides:
       
   209       UserDict.UserDict.__init__
       
   210     </dt>
       
   211   </dl>
       
   212 </td></tr></table>
       
   213 </div>
       
   214 <a name="__getitem__"></a>
       
   215 <div>
       
   216 <table class="details" border="1" cellpadding="3"
       
   217        cellspacing="0" width="100%" bgcolor="white">
       
   218 <tr><td>
       
   219   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   220   <tr valign="top"><td>
       
   221   <h3 class="epydoc"><span class="sig"><span class="sig-name">__getitem__</span>(<span class="sig-arg">self</span>,
       
   222         <span class="sig-arg">key</span>)</span>
       
   223     <br /><em class="fname">(Indexing operator)</em>
       
   224   </h3>
       
   225   </td><td align="right" valign="top"
       
   226     ><span class="codelink"><a href="escapeddict-pysrc.html#EscapedDict.__getitem__">source&nbsp;code</a></span>&nbsp;
       
   227     </td>
       
   228   </table>
       
   229   
       
   230   Overrides the usual __getitem__ to insert values of other keys referenced in this key's
       
   231 value.
       
   232   <dl class="fields">
       
   233     <dt>Overrides:
       
   234       UserDict.UserDict.__getitem__
       
   235     </dt>
       
   236   </dl>
       
   237 </td></tr></table>
       
   238 </div>
       
   239 <br />
       
   240 <!-- ==================== NAVIGATION BAR ==================== -->
       
   241 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   242        bgcolor="#a0c0ff" cellspacing="0">
       
   243   <tr valign="middle">
       
   244 
       
   245   <!-- Tree link -->
       
   246       <th>&nbsp;&nbsp;&nbsp;<a
       
   247         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   248 
       
   249   <!-- Index link -->
       
   250       <th>&nbsp;&nbsp;&nbsp;<a
       
   251         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   252 
       
   253   <!-- Help link -->
       
   254       <th>&nbsp;&nbsp;&nbsp;<a
       
   255         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   256 
       
   257       <th class="navbar" width="100%"></th>
       
   258   </tr>
       
   259 </table>
       
   260 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   261   <tr>
       
   262     <td align="left" class="footer">
       
   263     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:18 2009
       
   264     </td>
       
   265     <td align="right" class="footer">
       
   266       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   267     </td>
       
   268   </tr>
       
   269 </table>
       
   270 
       
   271 <script type="text/javascript">
       
   272   <!--
       
   273   // Private objects are initially displayed (because if
       
   274   // javascript is turned off then we want them to be
       
   275   // visible); but by default, we want to hide them.  So hide
       
   276   // them unless we have a cookie that says to show them.
       
   277   checkCookie()
       
   278   // -->
       
   279 </script>
       
   280   
       
   281 </body>
       
   282 </html>