-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathsimplexmlapi-module.html
405 lines (387 loc) · 19.1 KB
/
simplexmlapi-module.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
<?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>simplexmlapi</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 bgcolor="#70b0f0" class="navbar-select"
> Home </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>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package simplexmlapi
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="simplexmlapi-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package simplexmlapi</h1><p class="nomargin-top"><span class="codelink"><a href="simplexmlapi-pysrc.html">source code</a></span></p>
<p>A simple, fast way to create dotted-name APIs for XML data</p>
<p>simplexmlapi exposes an API similar to those of the marshal and pickle
modules.</p>
<p>An XML document may be loaded into a <a
href="simplexmlapi.api.SimpleXmlApi-class.html"
class="link">SimpleXmlApi</a> object and traversed using Python-like
dotted names. One may also map attributes of the <a
href="simplexmlapi.api.SimpleXmlApi-class.html"
class="link">SimpleXmlApi</a> object to given dotted names.</p>
<p>Each segment of the dotted name will be resolved to the first child
element with that tag name. If no such element exists, it will be
resolved to an attribute on the current element. If no such attribute
exists, an exception will be raised.</p>
<p>Traversing the tree manually -- that is, without using an attribute
map -- will return a <a href="simplexmlapi.node.DotNode-class.html"
class="link">DotNode</a> or <a
href="simplexmlapi.node.DotNodeAttribute-class.html"
class="link">DotNodeAttribute</a> instance. To get the text value of a
node or attribute, access the '_' property or call the
<code>getValue()</code> method. When accessing an attribute mapping, the
text value is returned automatically; no call to <code>getValue()</code>
is necessary.</p>
<p>If multiple matching child elements exist, <code>__0</code> may be
appended to the name, where <code>'0'</code> is the index of the desired
element.</p>
<p>In case of tag name/attribute conflicts, attribute resolution may be
specified explicitly by appending <code>__a</code> to the name.</p>
<p>Parsing an XML document and traversing elements with dotted names:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">import</span> simplexmlapi
<span class="py-prompt">>>> </span>s = <span class="py-string">'''</span>
<span class="py-more">... </span><span class="py-string"> <xml> <obj></span>
<span class="py-more">... </span><span class="py-string"> <prop name="value">A Value</prop></span>
<span class="py-more">... </span><span class="py-string"> <prop name="thing">A Thing</prop></span>
<span class="py-more">... </span><span class="py-string"> </obj> </xml></span>
<span class="py-more">... </span><span class="py-string"> '''</span>
<span class="py-prompt">>>> </span>api = simplexmlapi.loads(s)
<span class="py-prompt">>>> </span>api.obj.prop._
<span class="py-output">u'A Value'</span>
<span class="py-output"></span><span class="py-prompt">>>> </span>api.obj.prop.name._
<span class="py-output">'value'</span>
<span class="py-output"></span><span class="py-prompt">>>> </span>api.obj.prop__1.name._
<span class="py-output">'thing'</span>
<span class="py-output"></span><span class="py-prompt">>>> </span>api.obj.prop__1.name__a._
<span class="py-output">'thing'</span>
<span class="py-output"></span><span class="py-prompt">>>> </span><span class="py-keyword">from</span> StringIO <span class="py-keyword">import</span> StringIO
<span class="py-prompt">>>> </span>io = StringIO(s)
<span class="py-prompt">>>> </span>api = simplexmlapi.load(io)
<span class="py-prompt">>>> </span>api.obj.prop._
<span class="py-output">u'A Value'</span></pre>
<p>Mapping dotted names to attributes:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">import</span> simplexmlapi
<span class="py-prompt">>>> </span>s = <span class="py-string">'''</span>
<span class="py-more">... </span><span class="py-string"> <xml> <obj></span>
<span class="py-more">... </span><span class="py-string"> <prop name="value">A Value</prop></span>
<span class="py-more">... </span><span class="py-string"> <prop name="thing">A Thing</prop></span>
<span class="py-more">... </span><span class="py-string"> </obj> </xml></span>
<span class="py-more">... </span><span class="py-string"> '''</span>
<span class="py-prompt">>>> </span>api = simplexmlapi.loads(s)
<span class="py-prompt">>>> </span>api.add_mapping(<span class="py-string">'value'</span>, <span class="py-string">'obj.prop__0'</span>)
<span class="py-prompt">>>> </span>api.add_mapping(<span class="py-string">'thing'</span>, <span class="py-string">'obj.prop__1'</span>)
<span class="py-prompt">>>> </span>api.value
<span class="py-output">u'A Value'</span>
<span class="py-output"></span><span class="py-prompt">>>> </span>api.thing
<span class="py-output">u'A Thing'</span>
<span class="py-output"></span><span class="py-prompt">>>> </span>attr_map = dict(value=<span class="py-string">"obj.prop__0"</span>, thing=<span class="py-string">"obj.prop__1"</span>)
<span class="py-prompt">>>> </span>api2 = simplexmlapi.loads(s, map=attr_map)
<span class="py-prompt">>>> </span>api2.value
<span class="py-output">u'A Value'</span>
<span class="py-output"></span><span class="py-prompt">>>> </span>api2.thing
<span class="py-output">u'A Thing'</span></pre>
<p>Extending <a href="simplexmlapi.api.SimpleXmlApi-class.html"
class="link">SimpleXmlApi</a>:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">import</span> simplexmlapi
<span class="py-prompt">>>> </span><span class="py-keyword">class</span> <span class="py-defname">SampleApi</span>(simplexmlapi.SimpleXmlApi):
<span class="py-more">... </span> _map = {
<span class="py-more">... </span> <span class="py-string">'value'</span> : <span class="py-string">'obj.prop__0'</span>,
<span class="py-more">... </span> <span class="py-string">'thing'</span> : <span class="py-string">'obj.prop__1'</span> }
<span class="py-more">...</span>
<span class="py-prompt">>>> </span>s = <span class="py-string">'''</span>
<span class="py-more">... </span><span class="py-string"> <xml></span>
<span class="py-more">... </span><span class="py-string"> <obj></span>
<span class="py-more">... </span><span class="py-string"> <prop name="value">A Value</prop></span>
<span class="py-more">... </span><span class="py-string"> <prop name="thing">A Thing</prop></span>
<span class="py-more">... </span><span class="py-string"> </obj></span>
<span class="py-more">... </span><span class="py-string"> </xml></span>
<span class="py-more">... </span><span class="py-string"> '''</span>
<span class="py-prompt">>>> </span>api = simplexmlapi.loads(s, cls=SampleApi)
<span class="py-prompt">>>> </span>api.value
<span class="py-output">u'A Value'</span>
<span class="py-output"></span><span class="py-prompt">>>> </span>api.thing
<span class="py-output">u'A Thing'</span></pre>
<hr />
<div class="fields"> <p><strong>Version:</strong>
0.1.2
</p>
</div><!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Submodules</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Submodules"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr><td class="summary">
<ul class="nomargin">
<li class="private"> <strong class="uidlink"><a href="simplexmlapi.api-module.html" onclick="show_private();">simplexmlapi.api</a></strong> </li>
<li class="private"> <strong class="uidlink"><a href="simplexmlapi.node-module.html" onclick="show_private();">simplexmlapi.node</a></strong> </li>
<li> <strong class="uidlink"><a href="simplexmlapi.tests-module.html">simplexmlapi.tests</a></strong>
<ul>
<li> <strong class="uidlink"><a href="simplexmlapi.tests.test_api-module.html">simplexmlapi.tests.test_api</a></strong> </li>
<li> <strong class="uidlink"><a href="simplexmlapi.tests.test_dotnode-module.html">simplexmlapi.tests.test_dotnode</a></strong> </li>
</ul>
</li>
</ul></td></tr>
</table>
<br />
<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Classes"
class="privatelink" onclick="toggle_private();"
>hide private</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">
<a href="simplexmlapi.api.SimpleXmlApi-class.html" class="summary-name">SimpleXmlApi</a><br />
The main API class, comprising a map of attributes to dotted path
names.
</td>
</tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</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="simplexmlapi-module.html#load" class="summary-sig-name">load</a>(<span class="summary-sig-arg">fp</span>,
<span class="summary-sig-arg">map</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">cls</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Parse <code>fp</code> (a file-like object containing an XML document)
and return a dotted-name-walkable <a
href="simplexmlapi.api.SimpleXmlApi-class.html"
class="link">SimpleXmlApi</a> instance.</td>
<td align="right" valign="top">
<span class="codelink"><a href="simplexmlapi-pysrc.html#load">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="simplexmlapi-module.html#loads" class="summary-sig-name">loads</a>(<span class="summary-sig-arg">s</span>,
<span class="summary-sig-arg">map</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">cls</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Parse <code>s</code> (a <code>str</code> or <code>unicode</code>
instance containing an XML document) and return a
dotted-name-walkable <a
href="simplexmlapi.api.SimpleXmlApi-class.html"
class="link">SimpleXmlApi</a> instance.</td>
<td align="right" valign="top">
<span class="codelink"><a href="simplexmlapi-pysrc.html#loads">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="load"></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">load</span>(<span class="sig-arg">fp</span>,
<span class="sig-arg">map</span>=<span class="sig-default">None</span>,
<span class="sig-arg">cls</span>=<span class="sig-default">None</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="simplexmlapi-pysrc.html#load">source code</a></span>
</td>
</tr></table>
<p>Parse <code>fp</code> (a file-like object containing an XML document)
and return a dotted-name-walkable <a
href="simplexmlapi.api.SimpleXmlApi-class.html"
class="link">SimpleXmlApi</a> instance.</p>
<p>If <code>map</code> is specified, attributes will be created on the
returned instance mapping <code class="link">map</code>'s keys to its
associated dotted-name values.</p>
<p>To use a custom <a href="simplexmlapi.api.SimpleXmlApi-class.html"
class="link">SimpleXmlApi</a> subclass, specify it with the
<code>cls</code> kwarg.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="loads"></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">loads</span>(<span class="sig-arg">s</span>,
<span class="sig-arg">map</span>=<span class="sig-default">None</span>,
<span class="sig-arg">cls</span>=<span class="sig-default">None</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="simplexmlapi-pysrc.html#loads">source code</a></span>
</td>
</tr></table>
<p>Parse <code>s</code> (a <code>str</code> or <code>unicode</code>
instance containing an XML document) and return a dotted-name-walkable <a
href="simplexmlapi.api.SimpleXmlApi-class.html"
class="link">SimpleXmlApi</a> instance.</p>
<p>If map is specified, attributes will be created on the returned
instance mapping map's keys to its associated dotted-name values.</p>
<p>To use a custom <a href="simplexmlapi.api.SimpleXmlApi-class.html"
class="link">SimpleXmlApi</a> subclass, specify it with the <code
class="link">cls</code> kwarg.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th bgcolor="#70b0f0" class="navbar-select"
> Home </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>
<th class="navbar" width="100%"></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 Thu Sep 18 13:30:17 2008
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>