1
<?xml version="1.0" encoding="iso-8859-1"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
"DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>parserFwk.pyparsing.ParseResults</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="parserFwk.pyparsing-module.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
24
</p></th></tr></table>
28
<table width="100%" cellpadding="0" cellspacing="0">
31
<font size="-1"><b class="breadcrumbs">
32
Package parserFwk ::
33
<a href="parserFwk.pyparsing-module.html">Module pyparsing</a> ::
34
Class ParseResults
37
<td><table cellpadding="0" cellspacing="0">
38
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="parserFwk.pyparsing.ParseResults-class.html" target="_top">no frames</a>]</font></td></tr>
42
<!-- =========== START OF CLASS DESCRIPTION =========== -->
43
<h2 class="class">Type ParseResults</h2>
45
<pre class="base-tree">
46
<a href="__builtin__.object-class.html"><code>object</code></a> --+
53
Structured parse results, to provide multiple means of access to the
57
as a list (len(results))
60
by list index (results[0], results[1], etc.)
63
by attribute (results.<resultsName>)
69
<!-- =========== START OF METHOD SUMMARY =========== -->
70
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
71
<tr bgcolor="#70b0f0" class="summary">
72
<th colspan="2">Method Summary</th></tr>
73
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
74
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
75
<span class=summary-sig-arg>toklist</span>,
76
<span class=summary-sig-arg>name</span>,
77
<span class=summary-sig-arg>asList</span>,
78
<span class=summary-sig-arg>modal</span>)</span></code>
80
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
81
<td><code><a name="__add__"></a><span class="summary-sig"><span class="summary-sig-name">__add__</span>(<span class=summary-sig-arg>self</span>,
82
<span class=summary-sig-arg>other</span>)</span></code>
84
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
85
<td><code><a name="__bool__"></a><span class="summary-sig"><span class="summary-sig-name">__bool__</span>(<span class=summary-sig-arg>self</span>)</span></code>
87
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
88
<td><code><a name="__contains__"></a><span class="summary-sig"><span class="summary-sig-name">__contains__</span>(<span class=summary-sig-arg>self</span>,
89
<span class=summary-sig-arg>k</span>)</span></code>
91
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
92
<td><code><a name="__delitem__"></a><span class="summary-sig"><span class="summary-sig-name">__delitem__</span>(<span class=summary-sig-arg>self</span>,
93
<span class=summary-sig-arg>i</span>)</span></code>
95
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
96
<td><code><a name="__getattr__"></a><span class="summary-sig"><span class="summary-sig-name">__getattr__</span>(<span class=summary-sig-arg>self</span>,
97
<span class=summary-sig-arg>name</span>)</span></code>
99
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
100
<td><code><a name="__getitem__"></a><span class="summary-sig"><span class="summary-sig-name">__getitem__</span>(<span class=summary-sig-arg>self</span>,
101
<span class=summary-sig-arg>i</span>)</span></code>
103
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
104
<td><code><a name="__getstate__"></a><span class="summary-sig"><span class="summary-sig-name">__getstate__</span>(<span class=summary-sig-arg>self</span>)</span></code>
106
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
107
<td><code><a name="__iadd__"></a><span class="summary-sig"><span class="summary-sig-name">__iadd__</span>(<span class=summary-sig-arg>self</span>,
108
<span class=summary-sig-arg>other</span>)</span></code>
110
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
111
<td><code><a name="__iter__"></a><span class="summary-sig"><span class="summary-sig-name">__iter__</span>(<span class=summary-sig-arg>self</span>)</span></code>
113
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
114
<td><code><a name="__len__"></a><span class="summary-sig"><span class="summary-sig-name">__len__</span>(<span class=summary-sig-arg>self</span>)</span></code>
116
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
117
<td><code><a name="__new__"></a><span class="summary-sig"><span class="summary-sig-name">__new__</span>(<span class=summary-sig-arg>cls</span>,
118
<span class=summary-sig-arg>toklist</span>,
119
<span class=summary-sig-arg>name</span>,
120
<span class=summary-sig-arg>asList</span>,
121
<span class=summary-sig-arg>modal</span>)</span></code>
123
<i>(Static method)</i>
125
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
126
<td><code><a name="__nonzero__"></a><span class="summary-sig"><span class="summary-sig-name">__nonzero__</span>(<span class=summary-sig-arg>self</span>)</span></code>
128
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
129
<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>
131
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
132
<td><code><a name="__setitem__"></a><span class="summary-sig"><span class="summary-sig-name">__setitem__</span>(<span class=summary-sig-arg>self</span>,
133
<span class=summary-sig-arg>k</span>,
134
<span class=summary-sig-arg>v</span>)</span></code>
136
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
137
<td><code><a name="__setstate__"></a><span class="summary-sig"><span class="summary-sig-name">__setstate__</span>(<span class=summary-sig-arg>self</span>,
138
<span class=summary-sig-arg>state</span>)</span></code>
140
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
141
<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>
143
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
144
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParseResults-class.html#asDict" class="summary-sig-name"><code>asDict</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
146
Returns the named parse results as dictionary.</td></tr>
147
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
148
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParseResults-class.html#asList" class="summary-sig-name"><code>asList</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
150
Returns the parse results as a nested list of matching tokens, all
151
converted to strings.</td></tr>
152
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
153
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParseResults-class.html#asXML" class="summary-sig-name"><code>asXML</code></a>(<span class=summary-sig-arg>self</span>,
154
<span class=summary-sig-arg>doctag</span>,
155
<span class=summary-sig-arg>namedItemsOnly</span>,
156
<span class=summary-sig-arg>indent</span>,
157
<span class=summary-sig-arg>formatted</span>)</span></code>
159
Returns the parse results as XML.</td></tr>
160
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
161
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParseResults-class.html#copy" class="summary-sig-name"><code>copy</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
163
Returns a new copy of a ParseResults object.</td></tr>
164
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
165
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParseResults-class.html#dump" class="summary-sig-name"><code>dump</code></a>(<span class=summary-sig-arg>self</span>,
166
<span class=summary-sig-arg>indent</span>,
167
<span class=summary-sig-arg>depth</span>)</span></code>
169
Diagnostic method for listing out the contents of a ParseResults.</td></tr>
170
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
171
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParseResults-class.html#getName" class="summary-sig-name"><code>getName</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
173
Returns the results name for this token expression.</td></tr>
174
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
175
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParseResults-class.html#items" class="summary-sig-name"><code>items</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
177
Returns all named result keys and values as a list of tuples.</td></tr>
178
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
179
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParseResults-class.html#keys" class="summary-sig-name"><code>keys</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
181
Returns all named result keys.</td></tr>
182
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
183
<td><code><span class="summary-sig"><a href="parserFwk.pyparsing.ParseResults-class.html#values" class="summary-sig-name"><code>values</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
185
Returns all named result values.</td></tr>
187
<b>Inherited from <a href="__builtin__.object-class.html"><code>object</code></a>:</b>
188
<a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a>,
189
<a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a>,
190
<a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a>,
191
<a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a>,
192
<a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a>,
193
<a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a>
198
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
199
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
200
<tr bgcolor="#70b0f0" class="summary">
201
<th colspan="2">Class Variable Summary</th></tr>
202
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
203
<td><b><a href="parserFwk.pyparsing.ParseResults-class.html#__slots__"><code>__slots__</code></a></b> = <span title="('__toklist', '__tokdict', '__doinit', '__name', '__parent', '__accumNames', '__weakref__')"><code>('__toklist', '__tokdict', '__doinit', '__na<span class="variable-ellipsis">...</span></code>
208
<!-- =========== START OF INSTANCE METHOD DETAILS =========== -->
209
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
210
<tr bgcolor="#70b0f0" class="details">
211
<th colspan="2">Instance Method Details</th></tr>
214
<a name="asDict"></a>
215
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
216
<h3><span class="sig"><span class="sig-name">asDict</span>(<span class=sig-arg>self</span>)</span>
218
Returns the named parse results as dictionary.
223
<a name="asList"></a>
224
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
225
<h3><span class="sig"><span class="sig-name">asList</span>(<span class=sig-arg>self</span>)</span>
227
Returns the parse results as a nested list of matching tokens, all
228
converted to strings.
234
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
235
<h3><span class="sig"><span class="sig-name">asXML</span>(<span class=sig-arg>self</span>,
236
<span class=sig-arg>doctag</span>=<span class=sig-default>None</span>,
237
<span class=sig-arg>namedItemsOnly</span>=<span class=sig-default>False</span>,
238
<span class=sig-arg>indent</span>=<span class=sig-default>''</span>,
239
<span class=sig-arg>formatted</span>=<span class=sig-default>True</span>)</span>
241
Returns the parse results as XML. Tags are created for tokens and
242
lists that have defined results names.
248
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
249
<h3><span class="sig"><span class="sig-name">copy</span>(<span class=sig-arg>self</span>)</span>
251
Returns a new copy of a ParseResults object.
257
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
258
<h3><span class="sig"><span class="sig-name">dump</span>(<span class=sig-arg>self</span>,
259
<span class=sig-arg>indent</span>=<span class=sig-default>''</span>,
260
<span class=sig-arg>depth</span>=<span class=sig-default>0</span>)</span>
262
Diagnostic method for listing out the contents of a ParseResults.
263
Accepts an optional indent argument so that this string can be embedded
264
in a nested display of other data.
269
<a name="getName"></a>
270
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
271
<h3><span class="sig"><span class="sig-name">getName</span>(<span class=sig-arg>self</span>)</span>
273
Returns the results name for this token expression.
279
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
280
<h3><span class="sig"><span class="sig-name">items</span>(<span class=sig-arg>self</span>)</span>
282
Returns all named result keys and values as a list of tuples.
288
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
289
<h3><span class="sig"><span class="sig-name">keys</span>(<span class=sig-arg>self</span>)</span>
291
Returns all named result keys.
296
<a name="values"></a>
297
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
298
<h3><span class="sig"><span class="sig-name">values</span>(<span class=sig-arg>self</span>)</span>
300
Returns all named result values.
307
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
308
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
309
<tr bgcolor="#70b0f0" class="details">
310
<th colspan="2">Class Variable Details</th></tr>
312
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
313
<a name="__slots__"></a>
319
<dt><b>Type:</b></dt>
324
<span title="('__toklist', '__tokdict', '__doinit', '__name', '__parent', '__accumNames', '__weakref__')"> <dt><b>Value:</b></dt>
326
<pre class="variable">
333
'__weakref__') </pre>
334
</td></tr></table></dd>
337
</dl></td></tr></table>
341
<!-- =========== START OF NAVBAR =========== -->
342
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
344
<th class="navbar"> <a class="navbar" href="parserFwk.pyparsing-module.html">Home</a> </th>
345
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
346
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
347
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
348
<th class="navbar" align="right" width="100%">
349
<table border="0" cellpadding="0" cellspacing="0">
350
<tr><th class="navbar" align="center">
353
</p></th></tr></table>
358
<table border="0" cellpadding="0" cellspacing="0" width="100%">
360
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Jul 22 09:32:59 2007</font></td>
361
<td align="right"><a href="http://epydoc.sourceforge.net"
362
><font size="-2">http://epydoc.sf.net</font></a></td>