1 <?xml version="1.0" encoding="ascii"?>
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>lxml.objectify.ObjectPath</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
18 <th> <a
19 href="lxml-module.html">Home</a> </th>
22 <th> <a
23 href="module-tree.html">Trees</a> </th>
26 <th> <a
27 href="identifier-index.html">Indices</a> </th>
30 <th> <a
31 href="help.html">Help</a> </th>
33 <!-- Project homepage -->
34 <th class="navbar" align="right" width="100%">
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><th class="navbar" align="center"
37 ><a class="navbar" target="_top" href="/">lxml API</a></th>
41 <table width="100%" cellpadding="0" cellspacing="0">
44 <span class="breadcrumbs">
45 <a href="lxml-module.html">Package lxml</a> ::
46 <a href="lxml.objectify-module.html">Module objectify</a> ::
51 <table cellpadding="0" cellspacing="0">
52 <!-- hide/show private -->
53 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
54 onclick="toggle_private();">hide private</a>]</span></td></tr>
55 <tr><td align="right"><span class="options"
56 >[<a href="frames.html" target="_top">frames</a
57 >] | <a href="lxml.objectify.ObjectPath-class.html"
58 target="_top">no frames</a>]</span></td></tr>
63 <!-- ==================== CLASS DESCRIPTION ==================== -->
64 <h1 class="epydoc">Class ObjectPath</h1><p class="nomargin-top"></p>
65 <pre class="base-tree">
68 <strong class="uidshort">ObjectPath</strong>
73 Immutable object that represents a compiled object path.</p>
74 <p>Example for a path: 'root.child[1].{other}child[25]'</p>
76 <!-- ==================== INSTANCE METHODS ==================== -->
77 <a name="section-InstanceMethods"></a>
78 <table class="summary" border="1" cellpadding="3"
79 cellspacing="0" width="100%" bgcolor="white">
80 <tr bgcolor="#70b0f0" class="table-header">
81 <td colspan="2" class="table-header">
82 <table border="0" cellpadding="0" cellspacing="0" width="100%">
84 <td align="left"><span class="table-header">Instance Methods</span></td>
85 <td align="right" valign="top"
86 ><span class="options">[<a href="#section-InstanceMethods"
87 class="privatelink" onclick="toggle_private();"
88 >hide private</a>]</span></td>
94 <td width="15%" align="right" valign="top" class="summary">
95 <span class="summary-type"> </span>
96 </td><td class="summary">
97 <table width="100%" cellpadding="0" cellspacing="0" border="0">
99 <td><span class="summary-sig"><a href="lxml.objectify.ObjectPath-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">...</span>)</span><br />
100 Follow the attribute path in the object structure and return the
101 target attribute value.</td>
102 <td align="right" valign="top">
112 <td width="15%" align="right" valign="top" class="summary">
113 <span class="summary-type"> </span>
114 </td><td class="summary">
115 <table width="100%" cellpadding="0" cellspacing="0" border="0">
117 <td><span class="summary-sig"><a href="lxml.objectify.ObjectPath-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">path</span>)</span><br />
118 x.__init__(...) initializes x; see help(type(x)) for signature</td>
119 <td align="right" valign="top">
129 <td width="15%" align="right" valign="top" class="summary">
130 <span class="summary-type">a new object with type S, a subtype of T</span>
131 </td><td class="summary">
132 <table width="100%" cellpadding="0" cellspacing="0" border="0">
134 <td><span class="summary-sig"><a href="lxml.objectify.ObjectPath-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
135 <span class="summary-sig-arg">S</span>,
136 <span class="summary-sig-arg">...</span>)</span></td>
137 <td align="right" valign="top">
147 <td width="15%" align="right" valign="top" class="summary">
148 <span class="summary-type"> </span>
149 </td><td class="summary">
150 <table width="100%" cellpadding="0" cellspacing="0" border="0">
152 <td><span class="summary-sig"><a href="lxml.objectify.ObjectPath-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">x</span>)</span><br />
154 <td align="right" valign="top">
164 <td width="15%" align="right" valign="top" class="summary">
165 <span class="summary-type"> </span>
166 </td><td class="summary">
167 <table width="100%" cellpadding="0" cellspacing="0" border="0">
169 <td><span class="summary-sig"><a href="lxml.objectify.ObjectPath-class.html#addattr" class="summary-sig-name">addattr</a>(<span class="summary-sig-arg">self</span>,
170 <span class="summary-sig-arg">root</span>,
171 <span class="summary-sig-arg">value</span>)</span><br />
172 Append a value to the target element in a subtree.</td>
173 <td align="right" valign="top">
183 <td width="15%" align="right" valign="top" class="summary">
184 <span class="summary-type"> </span>
185 </td><td class="summary">
186 <table width="100%" cellpadding="0" cellspacing="0" border="0">
188 <td><span class="summary-sig"><a name="hasattr"></a><span class="summary-sig-name">hasattr</span>(<span class="summary-sig-arg">self</span>,
189 <span class="summary-sig-arg">root</span>)</span></td>
190 <td align="right" valign="top">
200 <td width="15%" align="right" valign="top" class="summary">
201 <span class="summary-type"> </span>
202 </td><td class="summary">
203 <table width="100%" cellpadding="0" cellspacing="0" border="0">
205 <td><span class="summary-sig"><a href="lxml.objectify.ObjectPath-class.html#setattr" class="summary-sig-name">setattr</a>(<span class="summary-sig-arg">self</span>,
206 <span class="summary-sig-arg">root</span>,
207 <span class="summary-sig-arg">value</span>)</span><br />
208 Set the value of the target element in a subtree.</td>
209 <td align="right" valign="top">
219 <td colspan="2" class="summary">
220 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
221 <code>__delattr__</code>,
222 <code>__format__</code>,
223 <code>__getattribute__</code>,
224 <code>__hash__</code>,
225 <code>__reduce__</code>,
226 <code>__reduce_ex__</code>,
227 <code>__repr__</code>,
228 <code>__setattr__</code>,
229 <code>__sizeof__</code>,
230 <code>__subclasshook__</code>
235 <!-- ==================== PROPERTIES ==================== -->
236 <a name="section-Properties"></a>
237 <table class="summary" border="1" cellpadding="3"
238 cellspacing="0" width="100%" bgcolor="white">
239 <tr bgcolor="#70b0f0" class="table-header">
240 <td colspan="2" class="table-header">
241 <table border="0" cellpadding="0" cellspacing="0" width="100%">
243 <td align="left"><span class="table-header">Properties</span></td>
244 <td align="right" valign="top"
245 ><span class="options">[<a href="#section-Properties"
246 class="privatelink" onclick="toggle_private();"
247 >hide private</a>]</span></td>
253 <td width="15%" align="right" valign="top" class="summary">
254 <span class="summary-type"> </span>
255 </td><td class="summary">
256 <a name="find"></a><span class="summary-name">find</span>
260 <td colspan="2" class="summary">
261 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
262 <code>__class__</code>
267 <!-- ==================== METHOD DETAILS ==================== -->
268 <a name="section-MethodDetails"></a>
269 <table class="details" border="1" cellpadding="3"
270 cellspacing="0" width="100%" bgcolor="white">
271 <tr bgcolor="#70b0f0" class="table-header">
272 <td colspan="2" class="table-header">
273 <table border="0" cellpadding="0" cellspacing="0" width="100%">
275 <td align="left"><span class="table-header">Method Details</span></td>
276 <td align="right" valign="top"
277 ><span class="options">[<a href="#section-MethodDetails"
278 class="privatelink" onclick="toggle_private();"
279 >hide private</a>]</span></td>
285 <a name="__call__"></a>
287 <table class="details" border="1" cellpadding="3"
288 cellspacing="0" width="100%" bgcolor="white">
290 <table width="100%" cellpadding="0" cellspacing="0" border="0">
291 <tr valign="top"><td>
292 <h3 class="epydoc"><span class="sig"><span class="sig-name">__call__</span>(<span class="sig-arg">...</span>)</span>
293 <br /><em class="fname">(Call operator)</em>
295 </td><td align="right" valign="top"
300 <p>Follow the attribute path in the object structure and return the
301 target attribute value.</p>
302 <p>If it it not found, either returns a default value (if one was passed
303 as second argument) or raises AttributeError.</p>
308 <a name="__init__"></a>
310 <table class="details" border="1" cellpadding="3"
311 cellspacing="0" width="100%" bgcolor="white">
313 <table width="100%" cellpadding="0" cellspacing="0" border="0">
314 <tr valign="top"><td>
315 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">path</span>)</span>
316 <br /><em class="fname">(Constructor)</em>
318 </td><td align="right" valign="top"
323 x.__init__(...) initializes x; see help(type(x)) for signature
331 <a name="__new__"></a>
333 <table class="details" border="1" cellpadding="3"
334 cellspacing="0" width="100%" bgcolor="white">
336 <table width="100%" cellpadding="0" cellspacing="0" border="0">
337 <tr valign="top"><td>
338 <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
339 <span class="sig-arg">S</span>,
340 <span class="sig-arg">...</span>)</span>
342 </td><td align="right" valign="top"
349 <dt>Returns: a new object with type S, a subtype of T</dt>
356 <a name="__str__"></a>
358 <table class="details" border="1" cellpadding="3"
359 cellspacing="0" width="100%" bgcolor="white">
361 <table width="100%" cellpadding="0" cellspacing="0" border="0">
362 <tr valign="top"><td>
363 <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">x</span>)</span>
364 <br /><em class="fname">(Informal representation operator)</em>
366 </td><td align="right" valign="top"
379 <a name="addattr"></a>
381 <table class="details" border="1" cellpadding="3"
382 cellspacing="0" width="100%" bgcolor="white">
384 <table width="100%" cellpadding="0" cellspacing="0" border="0">
385 <tr valign="top"><td>
386 <h3 class="epydoc"><span class="sig"><span class="sig-name">addattr</span>(<span class="sig-arg">self</span>,
387 <span class="sig-arg">root</span>,
388 <span class="sig-arg">value</span>)</span>
390 </td><td align="right" valign="top"
395 <p>Append a value to the target element in a subtree.</p>
396 <p>If any of the children on the path does not exist, it is created.</p>
401 <a name="setattr"></a>
403 <table class="details" border="1" cellpadding="3"
404 cellspacing="0" width="100%" bgcolor="white">
406 <table width="100%" cellpadding="0" cellspacing="0" border="0">
407 <tr valign="top"><td>
408 <h3 class="epydoc"><span class="sig"><span class="sig-name">setattr</span>(<span class="sig-arg">self</span>,
409 <span class="sig-arg">root</span>,
410 <span class="sig-arg">value</span>)</span>
412 </td><td align="right" valign="top"
417 <p>Set the value of the target element in a subtree.</p>
418 <p>If any of the children on the path does not exist, it is created.</p>
424 <!-- ==================== NAVIGATION BAR ==================== -->
425 <table class="navbar" border="0" width="100%" cellpadding="0"
426 bgcolor="#a0c0ff" cellspacing="0">
429 <th> <a
430 href="lxml-module.html">Home</a> </th>
433 <th> <a
434 href="module-tree.html">Trees</a> </th>
437 <th> <a
438 href="identifier-index.html">Indices</a> </th>
441 <th> <a
442 href="help.html">Help</a> </th>
444 <!-- Project homepage -->
445 <th class="navbar" align="right" width="100%">
446 <table border="0" cellpadding="0" cellspacing="0">
447 <tr><th class="navbar" align="center"
448 ><a class="navbar" target="_top" href="/">lxml API</a></th>
452 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
454 <td align="left" class="footer">
455 Generated by Epydoc 3.0.1
456 on Wed Jan 29 12:26:21 2020
458 <td align="right" class="footer">
459 <a target="mainFrame" href="http://epydoc.sourceforge.net"
460 >http://epydoc.sourceforge.net</a>
465 <script type="text/javascript">
467 // Private objects are initially displayed (because if
468 // javascript is turned off then we want them to be
469 // visible); but by default, we want to hide them. So hide
470 // them unless we have a cookie that says to show them.