<?xml version="1.0" encoding="iso-8859-1"?>
<!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>parserFwk.pyparsing.ParserElement</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="parserFwk.pyparsing-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
pyparsing
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
Package parserFwk ::
<a href="parserFwk.pyparsing-module.html">Module pyparsing</a> ::
Class ParserElement
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="parserFwk.pyparsing.ParserElement-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Type ParserElement</h2>
<pre class="base-tree">
<a href="__builtin__.object-class.html"><code>object</code></a> --+
|
<b>ParserElement</b>
</pre><br />
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="parserFwk.pyparsing.ParseElementEnhance-class.html"><code>ParseElementEnhance</code></a>,
<a href="parserFwk.pyparsing.ParseExpression-class.html"><code>ParseExpression</code></a>,
<a href="parserFwk.pyparsing.Token-class.html"><code>Token</code></a></dd></dl>
<hr/>
Abstract base level parser element class.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>savelist</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#__add__" class="summary-sig-name"><code>__add__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
<br />
Implementation of + operator - returns And</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#__and__" class="summary-sig-name"><code>__and__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
<br />
Implementation of & operator - returns Each</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#__invert__" class="summary-sig-name"><code>__invert__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Implementation of ~ operator - returns NotAny</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#__or__" class="summary-sig-name"><code>__or__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
<br />
Implementation of | operator - returns MatchFirst</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#__radd__" class="summary-sig-name"><code>__radd__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
<br />
Implementation of += operator</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#__rand__" class="summary-sig-name"><code>__rand__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
<br />
Implementation of right-& operator</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__repr__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#__ror__" class="summary-sig-name"><code>__ror__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
<br />
Implementation of |= operator</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#__rxor__" class="summary-sig-name"><code>__rxor__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
<br />
Implementation of ^= operator</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__str__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#__xor__" class="summary-sig-name"><code>__xor__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
<br />
Implementation of ^ operator - returns Or</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="checkRecursion"></a><span class="summary-sig"><span class="summary-sig-name">checkRecursion</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>parseElementList</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#copy" class="summary-sig-name"><code>copy</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Make a copy of this ParserElement.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#enablePackrat" class="summary-sig-name"><code>enablePackrat</code></a>()</span></code>
<br />
Enables "packrat" parsing, which adds memoizing to the
parsing logic. <i>(Static method)</i>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#ignore" class="summary-sig-name"><code>ignore</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
<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></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#leaveWhitespace" class="summary-sig-name"><code>leaveWhitespace</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Disables the skipping of whitespace before matching the characters in
the ParserElement's defined pattern.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#parseFile" class="summary-sig-name"><code>parseFile</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>file_or_filename</span>)</span></code>
<br />
Execute the parse expression on the given file or filename.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="parseImpl"></a><span class="summary-sig"><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></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#parseString" class="summary-sig-name"><code>parseString</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>instring</span>)</span></code>
<br />
Execute the parse expression with the given string.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#parseWithTabs" class="summary-sig-name"><code>parseWithTabs</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Overrides default behavior to expand <TAB>s to spaces before
parsing the input string.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="postParse"></a><span class="summary-sig"><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></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="preParse"></a><span class="summary-sig"><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></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="resetCache"></a><span class="summary-sig"><span class="summary-sig-name">resetCache</span>()</span></code>
<br />
<i>(Static method)</i>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#scanString" class="summary-sig-name"><code>scanString</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>instring</span>)</span></code>
<br />
Scan the input string for expression matches.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#searchString" class="summary-sig-name"><code>searchString</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>instring</span>)</span></code>
<br />
Another extension to scanString, simplifying the access to the tokens
found to match the given parse expression.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#setDebug" class="summary-sig-name"><code>setDebug</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>flag</span>)</span></code>
<br />
Enable display of debugging messages while doing pattern matching.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#setDebugActions" class="summary-sig-name"><code>setDebugActions</code></a>(<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></code>
<br />
Enable display of debugging messages while doing pattern matching.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#setDefaultWhitespaceChars" class="summary-sig-name"><code>setDefaultWhitespaceChars</code></a>(<span class=summary-sig-arg>chars</span>)</span></code>
<br />
Overrides the default whitespace chars <i>(Static method)</i>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#setName" class="summary-sig-name"><code>setName</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Define name for this expression, for use in debugging.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#setParseAction" class="summary-sig-name"><code>setParseAction</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-vararg">*fns</span>)</span></code>
<br />
Define action to perform when successfully matching parse element
definition.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#setResultsName" class="summary-sig-name"><code>setResultsName</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>listAllMatches</span>)</span></code>
<br />
Define name for referencing matching tokens as a nested attribute of
the returned parse results.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#setWhitespaceChars" class="summary-sig-name"><code>setWhitespaceChars</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>chars</span>)</span></code>
<br />
Overrides the default whitespace chars</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="skipIgnorables"></a><span class="summary-sig"><span class="summary-sig-name">skipIgnorables</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>instring</span>,
<span class=summary-sig-arg>loc</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="streamline"></a><span class="summary-sig"><span class="summary-sig-name">streamline</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#suppress" class="summary-sig-name"><code>suppress</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Suppresses the output of this ParserElement; useful to keep
punctuation from cluttering up returned output.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#transformString" class="summary-sig-name"><code>transformString</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>instring</span>)</span></code>
<br />
Extension to scanString, to modify matching text with modified tokens
that may be returned from a parse action.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="tryParse"></a><span class="summary-sig"><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></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParserElement-class.html#validate" class="summary-sig-name"><code>validate</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>validateTrace</span>)</span></code>
<br />
Check defined expressions for valid structure, check for infinite
recursive definitions.</td></tr>
<tr><td colspan="2">
<b>Inherited from <a href="__builtin__.object-class.html"><code>object</code></a>:</b>
<a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a>,
<a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a>,
<a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a>,
<a href="__builtin__.object-class.html#__new__"><code>__new__</code></a>,
<a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a>,
<a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a>,
<a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a>
</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="parserFwk.pyparsing.ParserElement-class.html#DEFAULT_WHITE_CHARS"><code>DEFAULT_WHITE_CHARS</code></a></b> = <span title="' \n\t\r'"><code><span class="variable-quote">'</span> \n\t\r<span class="variable-quote">'</span> </code>
</span></td></tr>
</table><br />
<!-- =========== START OF INSTANCE METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Method Details</th></tr>
</table>
<a name="__add__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__add__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>other</span>)</span>
<br /><i>(Addition operator)</i>
</h3>
Implementation of + operator - returns And
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__and__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__and__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>other</span>)</span>
<br /><i>(And operator)</i>
</h3>
Implementation of & operator - returns Each
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__invert__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__invert__</span>(<span class=sig-arg>self</span>)</span>
</h3>
Implementation of ~ operator - returns NotAny
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__or__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__or__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>other</span>)</span>
<br /><i>(Or operator)</i>
</h3>
Implementation of | operator - returns MatchFirst
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__radd__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__radd__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>other</span>)</span>
<br /><i>(Right-side addition operator)</i>
</h3>
Implementation of += operator
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__rand__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__rand__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>other</span>)</span>
</h3>
Implementation of right-& operator
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__ror__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__ror__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>other</span>)</span>
</h3>
Implementation of |= operator
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__rxor__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__rxor__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>other</span>)</span>
</h3>
Implementation of ^= operator
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__xor__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__xor__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>other</span>)</span>
</h3>
Implementation of ^ operator - returns Or
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="copy"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">copy</span>(<span class=sig-arg>self</span>)</span>
</h3>
Make a copy of this ParserElement. Useful for defining different
parse actions for the same parsing pattern, using copies of the
original parse element.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="ignore"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">ignore</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>other</span>)</span>
</h3>
Define expression to be ignored (e.g., comments) while doing pattern
matching; may be called repeatedly, to define multiple comment or other
ignorable patterns.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="leaveWhitespace"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">leaveWhitespace</span>(<span class=sig-arg>self</span>)</span>
</h3>
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.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="parseFile"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parseFile</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>file_or_filename</span>)</span>
</h3>
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.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="parseString"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parseString</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>instring</span>)</span>
</h3>
Execute the parse expression with the given string. This is the main
interface to the client code, once the complete expression has been
built.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="parseWithTabs"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parseWithTabs</span>(<span class=sig-arg>self</span>)</span>
</h3>
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.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="scanString"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">scanString</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>instring</span>)</span>
</h3>
Scan the input string for expression matches. Each match will return
the matching tokens, start location, and end location.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="searchString"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">searchString</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>instring</span>)</span>
</h3>
Another extension to scanString, simplifying the access to the
tokens found to match the given parse expression.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setDebug"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><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>
Enable display of debugging messages while doing pattern
matching.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setDebugActions"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setDebugActions</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>startAction</span>,
<span class=sig-arg>successAction</span>,
<span class=sig-arg>exceptionAction</span>)</span>
</h3>
Enable display of debugging messages while doing pattern
matching.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setName"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setName</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>)</span>
</h3>
Define name for this expression, for use in debugging.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setParseAction"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setParseAction</span>(<span class=sig-arg>self</span>,
<span class="sig-vararg">*fns</span>)</span>
</h3>
Define action to perform when successfully matching parse element
definition. Parse action fn is a callable method with the arguments (s,
loc, toks) where:
<ul>
<li>
s = the original string being parsed
</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>
If the functions in fns modify the tokens, it 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.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setResultsName"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><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>
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.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setWhitespaceChars"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setWhitespaceChars</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>chars</span>)</span>
</h3>
Overrides the default whitespace chars
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="suppress"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">suppress</span>(<span class=sig-arg>self</span>)</span>
</h3>
Suppresses the output of this ParserElement; useful to keep
punctuation from cluttering up returned output.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="transformString"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">transformString</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>instring</span>)</span>
</h3>
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.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="validate"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">validate</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>validateTrace</span>=<span class=sig-default>[]</span>)</span>
</h3>
Check defined expressions for valid structure, check for infinite
recursive definitions.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF STATIC METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Static Method Details</th></tr>
</table>
<a name="enablePackrat"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">enablePackrat</span>()</span>
</h3>
<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>
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.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setDefaultWhitespaceChars"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setDefaultWhitespaceChars</span>(<span class=sig-arg>chars</span>)</span>
</h3>
Overrides the default whitespace chars
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="DEFAULT_WHITE_CHARS"></a>
<h3>DEFAULT_WHITE_CHARS</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="' \n\t\r'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'''</span>
\t\r<span class="variable-quote">'''</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="parserFwk.pyparsing-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
pyparsing
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Fri Mar 31 23:37:57 2006</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
7d3d6e5bed16fe556d7983604bb8c690
>
files
>
83
