<?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>pyparsing.pyparsing.ParseResults</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="pyparsing.pyparsing-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" >pyparsing</th> </tr></table></th> </tr> </table> <table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <span class="breadcrumbs"> Package pyparsing :: <a href="pyparsing.pyparsing-module.html">Module pyparsing</a> :: Class ParseResults </span> </td> <td> <table cellpadding="0" cellspacing="0"> <!-- hide/show private --> <tr><td align="right"><span class="options" >[<a href="frames.html" target="_top">frames</a >] | <a href="pyparsing.pyparsing.ParseResults-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class ParseResults</h1><p class="nomargin-top"><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults">source code</a></span></p> <pre class="base-tree"> object --+ | <strong class="uidshort">ParseResults</strong> </pre> <hr /> <p>Structured parse results, to provide multiple means of access to the parsed data:</p> <ul> <li> as a list (len(results)) </li> <li> by list index (results[0], results[1], etc.) </li> <li> by attribute (results.<resultsName>) </li> </ul> <!-- ==================== 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 align="left" colspan="2" class="table-header"> <span class="table-header">Instance Methods</span></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="pyparsing.pyparsing.ParseResults-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">toklist</span>, <span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">asList</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">modal</span>=<span class="summary-sig-default">True</span>)</span><br /> x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__init__">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="__getitem__"></a><span class="summary-sig-name">__getitem__</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">i</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__getitem__">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="__setitem__"></a><span class="summary-sig-name">__setitem__</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">k</span>, <span class="summary-sig-arg">v</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__setitem__">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="__delitem__"></a><span class="summary-sig-name">__delitem__</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">i</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__delitem__">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="__contains__"></a><span class="summary-sig-name">__contains__</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">k</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__contains__">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="__len__"></a><span class="summary-sig-name">__len__</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__len__">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="__bool__"></a><span class="summary-sig-name">__bool__</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__bool__">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="__nonzero__"></a><span class="summary-sig-name">__nonzero__</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__bool__">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="__iter__"></a><span class="summary-sig-name">__iter__</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__iter__">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="__reversed__"></a><span class="summary-sig-name">__reversed__</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__reversed__">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="keys"></a><span class="summary-sig-name">keys</span>(<span class="summary-sig-arg">self</span>)</span><br /> Returns all named result keys.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.keys">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="pyparsing.pyparsing.ParseResults-class.html#pop" class="summary-sig-name">pop</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">index</span>=<span class="summary-sig-default">-1</span>)</span><br /> Removes and returns item at specified index (default=last).</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.pop">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="get"></a><span class="summary-sig-name">get</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">key</span>, <span class="summary-sig-arg">defaultValue</span>=<span class="summary-sig-default">None</span>)</span><br /> Returns named result matching the given key, or if there is no such name, then returns the given defaultValue or None if no defaultValue is specified.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.get">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="insert"></a><span class="summary-sig-name">insert</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">index</span>, <span class="summary-sig-arg">insStr</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.insert">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="items"></a><span class="summary-sig-name">items</span>(<span class="summary-sig-arg">self</span>)</span><br /> Returns all named result keys and values as a list of tuples.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.items">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="values"></a><span class="summary-sig-name">values</span>(<span class="summary-sig-arg">self</span>)</span><br /> Returns all named result values.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.values">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="__getattr__"></a><span class="summary-sig-name">__getattr__</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">name</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__getattr__">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="__add__"></a><span class="summary-sig-name">__add__</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">other</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__add__">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="__iadd__"></a><span class="summary-sig-name">__iadd__</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">other</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__iadd__">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="pyparsing.pyparsing.ParseResults-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br /> repr(x)</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__repr__">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="pyparsing.pyparsing.ParseResults-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br /> str(x)</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__str__">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="asList"></a><span class="summary-sig-name">asList</span>(<span class="summary-sig-arg">self</span>)</span><br /> Returns the parse results as a nested list of matching tokens, all converted to strings.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.asList">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="asDict"></a><span class="summary-sig-name">asDict</span>(<span class="summary-sig-arg">self</span>)</span><br /> Returns the named parse results as dictionary.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.asDict">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="copy"></a><span class="summary-sig-name">copy</span>(<span class="summary-sig-arg">self</span>)</span><br /> Returns a new copy of a ParseResults object.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.copy">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="pyparsing.pyparsing.ParseResults-class.html#asXML" class="summary-sig-name">asXML</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">doctag</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">namedItemsOnly</span>=<span class="summary-sig-default">False</span>, <span class="summary-sig-arg">indent</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>, <span class="summary-sig-arg">formatted</span>=<span class="summary-sig-default">True</span>)</span><br /> Returns the parse results as XML.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.asXML">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="getName"></a><span class="summary-sig-name">getName</span>(<span class="summary-sig-arg">self</span>)</span><br /> Returns the results name for this token expression.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.getName">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="pyparsing.pyparsing.ParseResults-class.html#dump" class="summary-sig-name">dump</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">indent</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>, <span class="summary-sig-arg">depth</span>=<span class="summary-sig-default">0</span>)</span><br /> Diagnostic method for listing out the contents of a ParseResults.</td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.dump">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="__getstate__"></a><span class="summary-sig-name">__getstate__</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__getstate__">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="__setstate__"></a><span class="summary-sig-name">__setstate__</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">state</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__setstate__">source code</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>__delattr__</code>, <code>__getattribute__</code>, <code>__hash__</code>, <code>__reduce__</code>, <code>__reduce_ex__</code>, <code>__setattr__</code> </p> </td> </tr> </table> <!-- ==================== STATIC METHODS ==================== --> <a name="section-StaticMethods"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Static Methods</span></td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">a new object with type S, a subtype of T</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="pyparsing.pyparsing.ParseResults-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">cls</span>, <span class="summary-sig-arg">toklist</span>, <span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">asList</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">modal</span>=<span class="summary-sig-default">True</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__new__">source code</a></span> </td> </tr> </table> </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 align="left" colspan="2" class="table-header"> <span class="table-header">Properties</span></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 align="left" colspan="2" class="table-header"> <span class="table-header">Method Details</span></td> </tr> </table> <a name="__new__"></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">__new__</span>(<span class="sig-arg">cls</span>, <span class="sig-arg">toklist</span>, <span class="sig-arg">name</span>=<span class="sig-default">None</span>, <span class="sig-arg">asList</span>=<span class="sig-default">True</span>, <span class="sig-arg">modal</span>=<span class="sig-default">True</span>)</span> <br /><em class="fname">Static Method</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__new__">source code</a></span> </td> </tr></table> <dl class="fields"> <dt>Returns: a new object with type S, a subtype of T</dt> <dt>Overrides: object.__new__ <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <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">toklist</span>, <span class="sig-arg">name</span>=<span class="sig-default">None</span>, <span class="sig-arg">asList</span>=<span class="sig-default">True</span>, <span class="sig-arg">modal</span>=<span class="sig-default">True</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__init__">source code</a></span> </td> </tr></table> <p>x.__init__(...) initializes x; see x.__class__.__doc__ for signature</p> <dl class="fields"> <dt>Overrides: object.__init__ <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="pop"></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">pop</span>(<span class="sig-arg">self</span>, <span class="sig-arg">index</span>=<span class="sig-default">-1</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.pop">source code</a></span> </td> </tr></table> <p>Removes and returns item at specified index (default=last). Will work with either numeric indices or dict-key indicies.</p> <dl class="fields"> </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="pyparsing.pyparsing-pysrc.html#ParseResults.__repr__">source code</a></span> </td> </tr></table> <p>repr(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="__str__"></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">__str__</span>(<span class="sig-arg">self</span>)</span> <br /><em class="fname">(Informal representation operator)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.__str__">source code</a></span> </td> </tr></table> <p>str(x)</p> <dl class="fields"> <dt>Overrides: object.__str__ <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="asXML"></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">asXML</span>(<span class="sig-arg">self</span>, <span class="sig-arg">doctag</span>=<span class="sig-default">None</span>, <span class="sig-arg">namedItemsOnly</span>=<span class="sig-default">False</span>, <span class="sig-arg">indent</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>, <span class="sig-arg">formatted</span>=<span class="sig-default">True</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.asXML">source code</a></span> </td> </tr></table> <p>Returns the parse results as XML. Tags are created for tokens and lists that have defined results names.</p> <dl class="fields"> </dl> </td></tr></table> </div> <a name="dump"></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">dump</span>(<span class="sig-arg">self</span>, <span class="sig-arg">indent</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>, <span class="sig-arg">depth</span>=<span class="sig-default">0</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParseResults.dump">source code</a></span> </td> </tr></table> <p>Diagnostic method for listing out the contents of a ParseResults. Accepts an optional indent argument so that this string can be embedded in a nested display of other data.</p> <dl class="fields"> </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="pyparsing.pyparsing-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" >pyparsing</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 May 31 22:26:41 2008 </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>