<?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.ParserElement</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 ParserElement
</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.ParserElement-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ParserElement</h1><p class="nomargin-top"><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement">source code</a></span></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">ParserElement</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="pyparsing.pyparsing.ParseExpression-class.html">ParseExpression</a></li><li>, <a href="pyparsing.pyparsing.Token-class.html">Token</a></li><li>, <a href="pyparsing.pyparsing.ParseElementEnhance-class.html">ParseElementEnhance</a></li> </ul>
</dd></dl>
<hr />
<p>Abstract base level parser element class.</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 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.ParserElement-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">savelist</span>=<span class="summary-sig-default">False</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#ParserElement.__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 href="pyparsing.pyparsing.ParserElement-class.html#copy" class="summary-sig-name">copy</a>(<span class="summary-sig-arg">self</span>)</span><br />
Make a copy of this ParserElement.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.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 name="setName"></a><span class="summary-sig-name">setName</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Define name for this expression, for use in debugging.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.setName">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.ParserElement-class.html#setResultsName" class="summary-sig-name">setResultsName</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">listAllMatches</span>=<span class="summary-sig-default">False</span>)</span><br />
Define name for referencing matching tokens as a nested attribute of
the returned parse results.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.setResultsName">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.ParserElement-class.html#setBreak" class="summary-sig-name">setBreak</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">breakFlag</span>=<span class="summary-sig-default">True</span>)</span><br />
Method to invoke the Python pdb debugger when this element is about
to be parsed.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.setBreak">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.ParserElement-class.html#setParseAction" class="summary-sig-name">setParseAction</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">*fns</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Define action to perform when successfully matching parse element
definition.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.setParseAction">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.ParserElement-class.html#addParseAction" class="summary-sig-name">addParseAction</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">*fns</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Add parse action to expression's list of parse actions.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.addParseAction">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.ParserElement-class.html#setFailAction" class="summary-sig-name">setFailAction</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">fn</span>)</span><br />
Define action to perform if parsing fails at this expression.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.setFailAction">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="preParse"></a><span class="summary-sig-name">preParse</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">instring</span>,
<span class="summary-sig-arg">loc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.preParse">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="parseImpl"></a><span class="summary-sig-name">parseImpl</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">instring</span>,
<span class="summary-sig-arg">loc</span>,
<span class="summary-sig-arg">doActions</span>=<span class="summary-sig-default">True</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.parseImpl">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="postParse"></a><span class="summary-sig-name">postParse</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">instring</span>,
<span class="summary-sig-arg">loc</span>,
<span class="summary-sig-arg">tokenlist</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.postParse">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="tryParse"></a><span class="summary-sig-name">tryParse</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">instring</span>,
<span class="summary-sig-arg">loc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.tryParse">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.ParserElement-class.html#parseString" class="summary-sig-name">parseString</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">instring</span>,
<span class="summary-sig-arg">parseAll</span>=<span class="summary-sig-default">False</span>)</span><br />
Execute the parse expression with the given string.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.parseString">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.ParserElement-class.html#scanString" class="summary-sig-name">scanString</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">instring</span>,
<span class="summary-sig-arg">maxMatches</span>=<span class="summary-sig-default">2147483647</span>)</span><br />
Scan the input string for expression matches.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.scanString">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.ParserElement-class.html#transformString" class="summary-sig-name">transformString</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">instring</span>)</span><br />
Extension to scanString, to modify matching text with modified tokens
that may be returned from a parse action.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.transformString">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.ParserElement-class.html#searchString" class="summary-sig-name">searchString</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">instring</span>,
<span class="summary-sig-arg">maxMatches</span>=<span class="summary-sig-default">2147483647</span>)</span><br />
Another extension to scanString, simplifying the access to the tokens
found to match the given parse expression.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.searchString">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><br />
Implementation of + operator - returns And</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__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="__radd__"></a><span class="summary-sig-name">__radd__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Implementation of + operator when left operand is not a ParserElement</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__radd__">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="__sub__"></a><span class="summary-sig-name">__sub__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Implementation of - operator, returns And with error stop</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__sub__">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="__rsub__"></a><span class="summary-sig-name">__rsub__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Implementation of - operator when left operand is not a ParserElement</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__rsub__">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="__mul__"></a><span class="summary-sig-name">__mul__</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#ParserElement.__mul__">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="__rmul__"></a><span class="summary-sig-name">__rmul__</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#ParserElement.__rmul__">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="__or__"></a><span class="summary-sig-name">__or__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Implementation of | operator - returns MatchFirst</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__or__">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="__ror__"></a><span class="summary-sig-name">__ror__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Implementation of | operator when left operand is not a ParserElement</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__ror__">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="__xor__"></a><span class="summary-sig-name">__xor__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Implementation of ^ operator - returns Or</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__xor__">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="__rxor__"></a><span class="summary-sig-name">__rxor__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Implementation of ^ operator when left operand is not a ParserElement</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__rxor__">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="__and__"></a><span class="summary-sig-name">__and__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Implementation of & operator - returns Each</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__and__">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="__rand__"></a><span class="summary-sig-name">__rand__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Implementation of & operator when left operand is not a
ParserElement</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__rand__">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="__invert__"></a><span class="summary-sig-name">__invert__</span>(<span class="summary-sig-arg">self</span>)</span><br />
Implementation of ~ operator - returns NotAny</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__invert__">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.ParserElement-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>)</span><br />
Shortcut for setResultsName, with listAllMatches=default:</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__call__">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="suppress"></a><span class="summary-sig-name">suppress</span>(<span class="summary-sig-arg">self</span>)</span><br />
Suppresses the output of this ParserElement; useful to keep
punctuation from cluttering up returned output.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.suppress">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.ParserElement-class.html#leaveWhitespace" class="summary-sig-name">leaveWhitespace</a>(<span class="summary-sig-arg">self</span>)</span><br />
Disables the skipping of whitespace before matching the characters in
the ParserElement's defined pattern.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.leaveWhitespace">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="setWhitespaceChars"></a><span class="summary-sig-name">setWhitespaceChars</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">chars</span>)</span><br />
Overrides the default whitespace chars</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.setWhitespaceChars">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.ParserElement-class.html#parseWithTabs" class="summary-sig-name">parseWithTabs</a>(<span class="summary-sig-arg">self</span>)</span><br />
Overrides default behavior to expand <TAB>s to spaces before
parsing the input string.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.parseWithTabs">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="ignore"></a><span class="summary-sig-name">ignore</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Define expression to be ignored (e.g., comments) while doing pattern
matching; may be called repeatedly, to define multiple comment or
other ignorable patterns.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.ignore">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="setDebugActions"></a><span class="summary-sig-name">setDebugActions</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">startAction</span>,
<span class="summary-sig-arg">successAction</span>,
<span class="summary-sig-arg">exceptionAction</span>)</span><br />
Enable display of debugging messages while doing pattern matching.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.setDebugActions">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.ParserElement-class.html#setDebug" class="summary-sig-name">setDebug</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">flag</span>=<span class="summary-sig-default">True</span>)</span><br />
Enable display of debugging messages while doing pattern matching.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.setDebug">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.ParserElement-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#ParserElement.__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 href="pyparsing.pyparsing.ParserElement-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#ParserElement.__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 name="streamline"></a><span class="summary-sig-name">streamline</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.streamline">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="checkRecursion"></a><span class="summary-sig-name">checkRecursion</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">parseElementList</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.checkRecursion">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="validate"></a><span class="summary-sig-name">validate</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">validateTrace</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>)</span><br />
Check defined expressions for valid structure, check for infinite
recursive definitions.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.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 href="pyparsing.pyparsing.ParserElement-class.html#parseFile" class="summary-sig-name">parseFile</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">file_or_filename</span>,
<span class="summary-sig-arg">parseAll</span>=<span class="summary-sig-default">False</span>)</span><br />
Execute the parse expression on the given file or filename.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.parseFile">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="getException"></a><span class="summary-sig-name">getException</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.getException">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">aname</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__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="__eq__"></a><span class="summary-sig-name">__eq__</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#ParserElement.__eq__">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="__ne__"></a><span class="summary-sig-name">__ne__</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#ParserElement.__ne__">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.ParserElement-class.html#__hash__" class="summary-sig-name">__hash__</a>(<span class="summary-sig-arg">self</span>)</span><br />
hash(x)</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__hash__">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="__req__"></a><span class="summary-sig-name">__req__</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#ParserElement.__req__">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="__rne__"></a><span class="summary-sig-name">__rne__</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#ParserElement.__rne__">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>__new__</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"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="setDefaultWhitespaceChars"></a><span class="summary-sig-name">setDefaultWhitespaceChars</span>(<span class="summary-sig-arg">chars</span>)</span><br />
Overrides the default whitespace chars</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.setDefaultWhitespaceChars">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="resetCache"></a><span class="summary-sig-name">resetCache</span>()</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.resetCache">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.ParserElement-class.html#enablePackrat" class="summary-sig-name">enablePackrat</a>()</span><br />
Enables "packrat" parsing, which adds memoizing to the
parsing logic.</td>
<td align="right" valign="top">
<span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.enablePackrat">source code</a></span>
</td>
</tr>
</table>
</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 align="left" colspan="2" class="table-header">
<span class="table-header">Class Variables</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="DEFAULT_WHITE_CHARS"></a><span class="summary-name">DEFAULT_WHITE_CHARS</span> = <code title="'''
\t\r'''"><code class="variable-quote">'</code><code class="variable-string"> \n\t\r</code><code class="variable-quote">'</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 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="__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">savelist</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="pyparsing.pyparsing-pysrc.html#ParserElement.__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="copy"></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">copy</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.copy">source code</a></span>
</td>
</tr></table>
<p>Make a copy of this ParserElement. Useful for defining different
parse actions for the same parsing pattern, using copies of the original
parse element.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="setResultsName"></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">setResultsName</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">listAllMatches</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.setResultsName">source code</a></span>
</td>
</tr></table>
<p>Define name for referencing matching tokens as a nested attribute of
the returned parse results. NOTE: this returns a *copy* of the original
ParserElement object; this is so that the client can define a basic
element, such as an integer, and reference it in multiple places with
different names.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="setBreak"></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">setBreak</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">breakFlag</span>=<span class="sig-default">True</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.setBreak">source code</a></span>
</td>
</tr></table>
<p>Method to invoke the Python pdb debugger when this element is about to
be parsed. Set breakFlag to True to enable, False to disable.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="setParseAction"></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">setParseAction</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">*fns</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.setParseAction">source code</a></span>
</td>
</tr></table>
<p>Define action to perform when successfully matching parse element
definition. Parse action fn is a callable method with 0-3 arguments,
called as fn(s,loc,toks), fn(loc,toks), fn(toks), or just fn(),
where:</p>
<ul>
<li>
s = the original string being parsed (see note below)
</li>
<li>
loc = the location of the matching substring
</li>
<li>
toks = a list of the matched tokens, packaged as a ParseResults
object
</li>
</ul>
<p>If the functions in fns modify the tokens, they can return them as the
return value from fn, and the modified list of tokens will replace the
original. Otherwise, fn does not need to return any value.</p>
<p>Note: the default parsing behavior is to expand tabs in the input
string before starting the parsing process. See <a
href="pyparsing.pyparsing.ParserElement-class.html#parseString"
class="link"><i>parseString</i></a> for more information on parsing
strings containing <TAB>s, and suggested methods to maintain a
consistent view of the parsed string, the parse location, and line and
column positions within the parsed string.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="addParseAction"></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">addParseAction</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">*fns</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.addParseAction">source code</a></span>
</td>
</tr></table>
<p>Add parse action to expression's list of parse actions. See <a
href="pyparsing.pyparsing.ParserElement-class.html#setParseAction"
class="link"><i>setParseAction</i></a>.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="setFailAction"></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">setFailAction</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">fn</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.setFailAction">source code</a></span>
</td>
</tr></table>
<p>Define action to perform if parsing fails at this expression. Fail
acton fn is a callable function that takes the arguments
fn(s,loc,expr,err) where:</p>
<ul>
<li>
s = string being parsed
</li>
<li>
loc = location where expression match was attempted and failed
</li>
<li>
expr = the parse expression that failed
</li>
<li>
err = the exception thrown
</li>
</ul>
<p>The function returns no value. It may throw ParseFatalException if it
is desired to stop parsing immediately.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="enablePackrat"></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">enablePackrat</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#ParserElement.enablePackrat">source code</a></span>
</td>
</tr></table>
<p>Enables "packrat" parsing, which adds memoizing to the
parsing logic. Repeated parse attempts at the same string location (which
happens often in many complex grammars) can immediately return a cached
value, instead of re-executing parsing/validating code. Memoizing is
done of both valid results and parsing exceptions.</p>
<p>This speedup may break existing programs that use parse actions that
have side-effects. For this reason, packrat parsing is disabled when you
first import pyparsing. To activate the packrat feature, your program
must call the class method ParserElement.enablePackrat(). If your
program uses psyco to "compile as you go", you must call
enablePackrat before calling psyco.full(). If you do not do this, Python
will crash. For best results, call enablePackrat() immediately after
importing pyparsing.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="parseString"></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">parseString</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">instring</span>,
<span class="sig-arg">parseAll</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.parseString">source code</a></span>
</td>
</tr></table>
<p>Execute the parse expression with the given string. This is the main
interface to the client code, once the complete expression has been
built.</p>
<p>If you want the grammar to require that the entire input string be
successfully parsed, then set parseAll to True (equivalent to ending the
grammar with StringEnd()).</p>
<p>Note: parseString implicitly calls expandtabs() on the input string,
in order to report proper column numbers in parse actions. If the input
string contains tabs and the grammar uses parse actions that use the loc
argument to index into the string being parsed, you can ensure you have a
consistent view of the input string by:</p>
<ul>
<li>
calling parseWithTabs on your grammar before calling parseString (see
<a href="pyparsing.pyparsing.ParserElement-class.html#parseWithTabs"
class="link"><i>parseWithTabs</i></a>)
</li>
<li>
define your parse action using the full (s,loc,toks) signature, and
reference the input string using the parse action's s argument
</li>
<li>
explictly expand the tabs in your input string before calling
parseString
</li>
</ul>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="scanString"></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">scanString</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">instring</span>,
<span class="sig-arg">maxMatches</span>=<span class="sig-default">2147483647</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.scanString">source code</a></span>
</td>
</tr></table>
<p>Scan the input string for expression matches. Each match will return
the matching tokens, start location, and end location. May be called
with optional maxMatches argument, to clip scanning after 'n' matches are
found.</p>
<p>Note that the start and end locations are reported relative to the
string being parsed. See <a
href="pyparsing.pyparsing.ParserElement-class.html#parseString"
class="link"><i>parseString</i></a> for more information on parsing
strings with embedded tabs.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="transformString"></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">transformString</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">instring</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.transformString">source code</a></span>
</td>
</tr></table>
<p>Extension to scanString, to modify matching text with modified tokens
that may be returned from a parse action. To use transformString, define
a grammar and attach a parse action to it that modifies the returned
token list. Invoking transformString() on a target string will then scan
for matches, and replace the matched text patterns according to the logic
in the parse action. transformString() returns the resulting transformed
string.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="searchString"></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">searchString</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">instring</span>,
<span class="sig-arg">maxMatches</span>=<span class="sig-default">2147483647</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.searchString">source code</a></span>
</td>
</tr></table>
<p>Another extension to scanString, simplifying the access to the tokens
found to match the given parse expression. May be called with optional
maxMatches argument, to clip searching after 'n' matches are found.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="__call__"></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">__call__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>)</span>
<br /><em class="fname">(Call operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__call__">source code</a></span>
</td>
</tr></table>
<p>Shortcut for setResultsName, with listAllMatches=default:</p>
<pre class="literalblock">
userdata = Word(alphas).setResultsName("name") + Word(nums+"-").setResultsName("socsecno")
</pre>
<p>could be written as:</p>
<pre class="literalblock">
userdata = Word(alphas)("name") + Word(nums+"-")("socsecno")
</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="leaveWhitespace"></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">leaveWhitespace</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.leaveWhitespace">source code</a></span>
</td>
</tr></table>
<p>Disables the skipping of whitespace before matching the characters in
the ParserElement's defined pattern. This is normally only used
internally by the pyparsing module, but may be needed in some
whitespace-sensitive grammars.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="parseWithTabs"></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">parseWithTabs</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.parseWithTabs">source code</a></span>
</td>
</tr></table>
<p>Overrides default behavior to expand <TAB>s to spaces before
parsing the input string. Must be called before parseString when the
input grammar contains elements that match <TAB> characters.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="setDebug"></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">setDebug</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">flag</span>=<span class="sig-default">True</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.setDebug">source code</a></span>
</td>
</tr></table>
<p>Enable display of debugging messages while doing pattern matching. Set
flag to True to enable, False to disable.</p>
<dl class="fields">
</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#ParserElement.__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="__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#ParserElement.__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="parseFile"></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">parseFile</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">file_or_filename</span>,
<span class="sig-arg">parseAll</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.parseFile">source code</a></span>
</td>
</tr></table>
<p>Execute the parse expression on the given file or filename. If a
filename is specified (instead of a file object), the entire file is
opened, read, and closed before parsing.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="__hash__"></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">__hash__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Hashing function)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="pyparsing.pyparsing-pysrc.html#ParserElement.__hash__">source code</a></span>
</td>
</tr></table>
<p>hash(x)</p>
<dl class="fields">
<dt>Overrides:
object.__hash__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</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 Mon Apr 13 16:51:34 2009
</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>
