doc/html/api/lxml.objectify.ObjectPath-class.html

   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">
   5 <head>
   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>
   9 </head>
  10
  11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
  12       alink="#204080">
  13 <!-- ==================== NAVIGATION BAR ==================== -->
  14 <table class="navbar" border="0" width="100%" cellpadding="0"
  15        bgcolor="#a0c0ff" cellspacing="0">
  16   <tr valign="middle">
  17   <!-- Home link -->
  18       <th>&nbsp;&nbsp;&nbsp;<a
  19         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
  20
  21   <!-- Tree link -->
  22       <th>&nbsp;&nbsp;&nbsp;<a
  23         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  24
  25   <!-- Index link -->
  26       <th>&nbsp;&nbsp;&nbsp;<a
  27         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  28
  29   <!-- Help link -->
  30       <th>&nbsp;&nbsp;&nbsp;<a
  31         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  32
  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>
  38           </tr></table></th>
  39   </tr>
  40 </table>
  41 <table width="100%" cellpadding="0" cellspacing="0">
  42   <tr valign="top">
  43     <td width="100%">
  44       <span class="breadcrumbs">
  45         <a href="lxml-module.html">Package&nbsp;lxml</a> ::
  46         <a href="lxml.objectify-module.html">Module&nbsp;objectify</a> ::
  47         Class&nbsp;ObjectPath
  48       </span>
  49     </td>
  50     <td>
  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&nbsp;private</a>]</span></td></tr>
  55         <tr><td align="right"><span class="options"
  56             >[<a href="frames.html" target="_top">frames</a
  57             >]&nbsp;|&nbsp;<a href="lxml.objectify.ObjectPath-class.html"
  58             target="_top">no&nbsp;frames</a>]</span></td></tr>
  59       </table>
  60     </td>
  61   </tr>
  62 </table>
  63 <!-- ==================== CLASS DESCRIPTION ==================== -->
  64 <h1 class="epydoc">Class ObjectPath</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">ObjectPath</strong>
  69 </pre>
  70
  71 <hr />
  72 <p>ObjectPath(path)
  73 Immutable object that represents a compiled object path.</p>
  74 <p>Example for a path: 'root.child[1].{other}child[25]'</p>
  75
  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%">
  83       <tr valign="top">
  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>
  89       </tr>
  90     </table>
  91   </td>
  92 </tr>
  93 <tr>
  94     <td width="15%" align="right" valign="top" class="summary">
  95       <span class="summary-type">&nbsp;</span>
  96     </td><td class="summary">
  97       <table width="100%" cellpadding="0" cellspacing="0" border="0">
  98         <tr>
  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">
 103
 104
 105           </td>
 106         </tr>
 107       </table>
 108
 109     </td>
 110   </tr>
 111 <tr>
 112     <td width="15%" align="right" valign="top" class="summary">
 113       <span class="summary-type">&nbsp;</span>
 114     </td><td class="summary">
 115       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 116         <tr>
 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">
 120
 121
 122           </td>
 123         </tr>
 124       </table>
 125
 126     </td>
 127   </tr>
 128 <tr>
 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">
 133         <tr>
 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">
 138
 139
 140           </td>
 141         </tr>
 142       </table>
 143
 144     </td>
 145   </tr>
 146 <tr>
 147     <td width="15%" align="right" valign="top" class="summary">
 148       <span class="summary-type">&nbsp;</span>
 149     </td><td class="summary">
 150       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 151         <tr>
 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 />
 153       str(x)</td>
 154           <td align="right" valign="top">
 155
 156
 157           </td>
 158         </tr>
 159       </table>
 160
 161     </td>
 162   </tr>
 163 <tr>
 164     <td width="15%" align="right" valign="top" class="summary">
 165       <span class="summary-type">&nbsp;</span>
 166     </td><td class="summary">
 167       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 168         <tr>
 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">
 174
 175
 176           </td>
 177         </tr>
 178       </table>
 179
 180     </td>
 181   </tr>
 182 <tr>
 183     <td width="15%" align="right" valign="top" class="summary">
 184       <span class="summary-type">&nbsp;</span>
 185     </td><td class="summary">
 186       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 187         <tr>
 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">
 191
 192
 193           </td>
 194         </tr>
 195       </table>
 196
 197     </td>
 198   </tr>
 199 <tr>
 200     <td width="15%" align="right" valign="top" class="summary">
 201       <span class="summary-type">&nbsp;</span>
 202     </td><td class="summary">
 203       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 204         <tr>
 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">
 210
 211
 212           </td>
 213         </tr>
 214       </table>
 215
 216     </td>
 217   </tr>
 218   <tr>
 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>
 231       </p>
 232     </td>
 233   </tr>
 234 </table>
 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%">
 242       <tr valign="top">
 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>
 248       </tr>
 249     </table>
 250   </td>
 251 </tr>
 252 <tr>
 253     <td width="15%" align="right" valign="top" class="summary">
 254       <span class="summary-type">&nbsp;</span>
 255     </td><td class="summary">
 256         <a name="find"></a><span class="summary-name">find</span>
 257     </td>
 258   </tr>
 259   <tr>
 260     <td colspan="2" class="summary">
 261     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 262       <code>__class__</code>
 263       </p>
 264     </td>
 265   </tr>
 266 </table>
 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%">
 274       <tr valign="top">
 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>
 280       </tr>
 281     </table>
 282   </td>
 283 </tr>
 284 </table>
 285 <a name="__call__"></a>
 286 <div>
 287 <table class="details" border="1" cellpadding="3"
 288        cellspacing="0" width="100%" bgcolor="white">
 289 <tr><td>
 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>
 294   </h3>
 295   </td><td align="right" valign="top"
 296     >&nbsp;
 297     </td>
 298   </tr></table>
 299
 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>
 304   <dl class="fields">
 305   </dl>
 306 </td></tr></table>
 307 </div>
 308 <a name="__init__"></a>
 309 <div>
 310 <table class="details" border="1" cellpadding="3"
 311        cellspacing="0" width="100%" bgcolor="white">
 312 <tr><td>
 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>
 317   </h3>
 318   </td><td align="right" valign="top"
 319     >&nbsp;
 320     </td>
 321   </tr></table>
 322
 323   x.__init__(...) initializes x; see help(type(x)) for signature
 324   <dl class="fields">
 325     <dt>Overrides:
 326         object.__init__
 327     </dt>
 328   </dl>
 329 </td></tr></table>
 330 </div>
 331 <a name="__new__"></a>
 332 <div>
 333 <table class="details" border="1" cellpadding="3"
 334        cellspacing="0" width="100%" bgcolor="white">
 335 <tr><td>
 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>
 341   </h3>
 342   </td><td align="right" valign="top"
 343     >&nbsp;
 344     </td>
 345   </tr></table>
 346
 347
 348   <dl class="fields">
 349     <dt>Returns: a new object with type S, a subtype of T</dt>
 350     <dt>Overrides:
 351         object.__new__
 352     </dt>
 353   </dl>
 354 </td></tr></table>
 355 </div>
 356 <a name="__str__"></a>
 357 <div>
 358 <table class="details" border="1" cellpadding="3"
 359        cellspacing="0" width="100%" bgcolor="white">
 360 <tr><td>
 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>
 365   </h3>
 366   </td><td align="right" valign="top"
 367     >&nbsp;
 368     </td>
 369   </tr></table>
 370
 371   str(x)
 372   <dl class="fields">
 373     <dt>Overrides:
 374         object.__str__
 375     </dt>
 376   </dl>
 377 </td></tr></table>
 378 </div>
 379 <a name="addattr"></a>
 380 <div>
 381 <table class="details" border="1" cellpadding="3"
 382        cellspacing="0" width="100%" bgcolor="white">
 383 <tr><td>
 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>
 389   </h3>
 390   </td><td align="right" valign="top"
 391     >&nbsp;
 392     </td>
 393   </tr></table>
 394
 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>
 397   <dl class="fields">
 398   </dl>
 399 </td></tr></table>
 400 </div>
 401 <a name="setattr"></a>
 402 <div>
 403 <table class="details" border="1" cellpadding="3"
 404        cellspacing="0" width="100%" bgcolor="white">
 405 <tr><td>
 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>
 411   </h3>
 412   </td><td align="right" valign="top"
 413     >&nbsp;
 414     </td>
 415   </tr></table>
 416
 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>
 419   <dl class="fields">
 420   </dl>
 421 </td></tr></table>
 422 </div>
 423 <br />
 424 <!-- ==================== NAVIGATION BAR ==================== -->
 425 <table class="navbar" border="0" width="100%" cellpadding="0"
 426        bgcolor="#a0c0ff" cellspacing="0">
 427   <tr valign="middle">
 428   <!-- Home link -->
 429       <th>&nbsp;&nbsp;&nbsp;<a
 430         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 431
 432   <!-- Tree link -->
 433       <th>&nbsp;&nbsp;&nbsp;<a
 434         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 435
 436   <!-- Index link -->
 437       <th>&nbsp;&nbsp;&nbsp;<a
 438         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 439
 440   <!-- Help link -->
 441       <th>&nbsp;&nbsp;&nbsp;<a
 442         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 443
 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>
 449           </tr></table></th>
 450   </tr>
 451 </table>
 452 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 453   <tr>
 454     <td align="left" class="footer">
 455     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:19 2012
 456     </td>
 457     <td align="right" class="footer">
 458       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 459         >http://epydoc.sourceforge.net</a>
 460     </td>
 461   </tr>
 462 </table>
 463
 464 <script type="text/javascript">
 465   <!--
 466   // Private objects are initially displayed (because if
 467   // javascript is turned off then we want them to be
 468   // visible); but by default, we want to hide them.  So hide
 469   // them unless we have a cookie that says to show them.
 470   checkCookie();
 471   // -->
 472 </script>
 473 </body>
 474 </html>