doc/html/api/lxml.etree._IDDict-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.etree._IDDict</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.etree-module.html">Module&nbsp;etree</a> ::
  47         Class&nbsp;_IDDict
  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.etree._IDDict-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 _IDDict</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">_IDDict</strong>
  69 </pre>
  70
  71 <hr />
  72 <p>IDDict(self, etree)
  73 A dictionary-like proxy class that mapps ID attributes to elements.</p>
  74 <p>The dictionary must be instantiated with the root element of a parsed XML
  75 document, otherwise the behaviour is undefined.  Elements and XML trees
  76 that were created or modified 'by hand' are not supported.</p>
  77
  78 <!-- ==================== INSTANCE METHODS ==================== -->
  79 <a name="section-InstanceMethods"></a>
  80 <table class="summary" border="1" cellpadding="3"
  81        cellspacing="0" width="100%" bgcolor="white">
  82 <tr bgcolor="#70b0f0" class="table-header">
  83   <td colspan="2" class="table-header">
  84     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  85       <tr valign="top">
  86         <td align="left"><span class="table-header">Instance Methods</span></td>
  87         <td align="right" valign="top"
  88          ><span class="options">[<a href="#section-InstanceMethods"
  89          class="privatelink" onclick="toggle_private();"
  90          >hide private</a>]</span></td>
  91       </tr>
  92     </table>
  93   </td>
  94 </tr>
  95 <tr>
  96     <td width="15%" align="right" valign="top" class="summary">
  97       <span class="summary-type">&nbsp;</span>
  98     </td><td class="summary">
  99       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 100         <tr>
 101           <td><span class="summary-sig"><a name="__contains__"></a><span class="summary-sig-name">__contains__</span>(<span class="summary-sig-arg">x</span>,
 102         <span class="summary-sig-arg">y</span>)</span><br />
 103       y in x</td>
 104           <td align="right" valign="top">
 105
 106
 107           </td>
 108         </tr>
 109       </table>
 110
 111     </td>
 112   </tr>
 113 <tr>
 114     <td width="15%" align="right" valign="top" class="summary">
 115       <span class="summary-type">&nbsp;</span>
 116     </td><td class="summary">
 117       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 118         <tr>
 119           <td><span class="summary-sig"><a name="__getitem__"></a><span class="summary-sig-name">__getitem__</span>(<span class="summary-sig-arg">x</span>,
 120         <span class="summary-sig-arg">y</span>)</span><br />
 121       x[y]</td>
 122           <td align="right" valign="top">
 123
 124
 125           </td>
 126         </tr>
 127       </table>
 128
 129     </td>
 130   </tr>
 131 <tr>
 132     <td width="15%" align="right" valign="top" class="summary">
 133       <span class="summary-type">&nbsp;</span>
 134     </td><td class="summary">
 135       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 136         <tr>
 137           <td><span class="summary-sig"><a name="__iter__"></a><span class="summary-sig-name">__iter__</span>(<span class="summary-sig-arg">x</span>)</span><br />
 138       iter(x)</td>
 139           <td align="right" valign="top">
 140
 141
 142           </td>
 143         </tr>
 144       </table>
 145
 146     </td>
 147   </tr>
 148 <tr>
 149     <td width="15%" align="right" valign="top" class="summary">
 150       <span class="summary-type">&nbsp;</span>
 151     </td><td class="summary">
 152       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 153         <tr>
 154           <td><span class="summary-sig"><a name="__len__"></a><span class="summary-sig-name">__len__</span>(<span class="summary-sig-arg">x</span>)</span><br />
 155       len(x)</td>
 156           <td align="right" valign="top">
 157
 158
 159           </td>
 160         </tr>
 161       </table>
 162
 163     </td>
 164   </tr>
 165 <tr>
 166     <td width="15%" align="right" valign="top" class="summary">
 167       <span class="summary-type">a new object with type S, a subtype of T</span>
 168     </td><td class="summary">
 169       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 170         <tr>
 171           <td><span class="summary-sig"><a href="lxml.etree._IDDict-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 172         <span class="summary-sig-arg">S</span>,
 173         <span class="summary-sig-arg">...</span>)</span></td>
 174           <td align="right" valign="top">
 175
 176
 177           </td>
 178         </tr>
 179       </table>
 180
 181     </td>
 182   </tr>
 183 <tr>
 184     <td width="15%" align="right" valign="top" class="summary">
 185       <span class="summary-type">&nbsp;</span>
 186     </td><td class="summary">
 187       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 188         <tr>
 189           <td><span class="summary-sig"><a href="lxml.etree._IDDict-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">x</span>)</span><br />
 190       repr(x)</td>
 191           <td align="right" valign="top">
 192
 193
 194           </td>
 195         </tr>
 196       </table>
 197
 198     </td>
 199   </tr>
 200 <tr>
 201     <td width="15%" align="right" valign="top" class="summary">
 202       <span class="summary-type">&nbsp;</span>
 203     </td><td class="summary">
 204       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 205         <tr>
 206           <td><span class="summary-sig"><a name="copy"></a><span class="summary-sig-name">copy</span>(<span class="summary-sig-arg">...</span>)</span></td>
 207           <td align="right" valign="top">
 208
 209
 210           </td>
 211         </tr>
 212       </table>
 213
 214     </td>
 215   </tr>
 216 <tr>
 217     <td width="15%" align="right" valign="top" class="summary">
 218       <span class="summary-type">&nbsp;</span>
 219     </td><td class="summary">
 220       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 221         <tr>
 222           <td><span class="summary-sig"><a name="get"></a><span class="summary-sig-name">get</span>(<span class="summary-sig-arg">...</span>)</span></td>
 223           <td align="right" valign="top">
 224
 225
 226           </td>
 227         </tr>
 228       </table>
 229
 230     </td>
 231   </tr>
 232 <tr>
 233     <td width="15%" align="right" valign="top" class="summary">
 234       <span class="summary-type">&nbsp;</span>
 235     </td><td class="summary">
 236       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 237         <tr>
 238           <td><span class="summary-sig"><a name="has_key"></a><span class="summary-sig-name">has_key</span>(<span class="summary-sig-arg">...</span>)</span></td>
 239           <td align="right" valign="top">
 240
 241
 242           </td>
 243         </tr>
 244       </table>
 245
 246     </td>
 247   </tr>
 248 <tr>
 249     <td width="15%" align="right" valign="top" class="summary">
 250       <span class="summary-type">&nbsp;</span>
 251     </td><td class="summary">
 252       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 253         <tr>
 254           <td><span class="summary-sig"><a name="items"></a><span class="summary-sig-name">items</span>(<span class="summary-sig-arg">...</span>)</span></td>
 255           <td align="right" valign="top">
 256
 257
 258           </td>
 259         </tr>
 260       </table>
 261
 262     </td>
 263   </tr>
 264 <tr>
 265     <td width="15%" align="right" valign="top" class="summary">
 266       <span class="summary-type">&nbsp;</span>
 267     </td><td class="summary">
 268       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 269         <tr>
 270           <td><span class="summary-sig"><a name="iteritems"></a><span class="summary-sig-name">iteritems</span>(<span class="summary-sig-arg">...</span>)</span></td>
 271           <td align="right" valign="top">
 272
 273
 274           </td>
 275         </tr>
 276       </table>
 277
 278     </td>
 279   </tr>
 280 <tr>
 281     <td width="15%" align="right" valign="top" class="summary">
 282       <span class="summary-type">&nbsp;</span>
 283     </td><td class="summary">
 284       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 285         <tr>
 286           <td><span class="summary-sig"><a name="iterkeys"></a><span class="summary-sig-name">iterkeys</span>(<span class="summary-sig-arg">...</span>)</span></td>
 287           <td align="right" valign="top">
 288
 289
 290           </td>
 291         </tr>
 292       </table>
 293
 294     </td>
 295   </tr>
 296 <tr>
 297     <td width="15%" align="right" valign="top" class="summary">
 298       <span class="summary-type">&nbsp;</span>
 299     </td><td class="summary">
 300       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 301         <tr>
 302           <td><span class="summary-sig"><a name="itervalues"></a><span class="summary-sig-name">itervalues</span>(<span class="summary-sig-arg">...</span>)</span></td>
 303           <td align="right" valign="top">
 304
 305
 306           </td>
 307         </tr>
 308       </table>
 309
 310     </td>
 311   </tr>
 312 <tr>
 313     <td width="15%" align="right" valign="top" class="summary">
 314       <span class="summary-type">&nbsp;</span>
 315     </td><td class="summary">
 316       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 317         <tr>
 318           <td><span class="summary-sig"><a name="keys"></a><span class="summary-sig-name">keys</span>(<span class="summary-sig-arg">...</span>)</span></td>
 319           <td align="right" valign="top">
 320
 321
 322           </td>
 323         </tr>
 324       </table>
 325
 326     </td>
 327   </tr>
 328 <tr>
 329     <td width="15%" align="right" valign="top" class="summary">
 330       <span class="summary-type">&nbsp;</span>
 331     </td><td class="summary">
 332       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 333         <tr>
 334           <td><span class="summary-sig"><a name="values"></a><span class="summary-sig-name">values</span>(<span class="summary-sig-arg">...</span>)</span></td>
 335           <td align="right" valign="top">
 336
 337
 338           </td>
 339         </tr>
 340       </table>
 341
 342     </td>
 343   </tr>
 344   <tr>
 345     <td colspan="2" class="summary">
 346     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 347       <code>__delattr__</code>,
 348       <code>__format__</code>,
 349       <code>__getattribute__</code>,
 350       <code>__hash__</code>,
 351       <code>__init__</code>,
 352       <code>__reduce__</code>,
 353       <code>__reduce_ex__</code>,
 354       <code>__setattr__</code>,
 355       <code>__sizeof__</code>,
 356       <code>__str__</code>,
 357       <code>__subclasshook__</code>
 358       </p>
 359     </td>
 360   </tr>
 361 </table>
 362 <!-- ==================== PROPERTIES ==================== -->
 363 <a name="section-Properties"></a>
 364 <table class="summary" border="1" cellpadding="3"
 365        cellspacing="0" width="100%" bgcolor="white">
 366 <tr bgcolor="#70b0f0" class="table-header">
 367   <td colspan="2" class="table-header">
 368     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 369       <tr valign="top">
 370         <td align="left"><span class="table-header">Properties</span></td>
 371         <td align="right" valign="top"
 372          ><span class="options">[<a href="#section-Properties"
 373          class="privatelink" onclick="toggle_private();"
 374          >hide private</a>]</span></td>
 375       </tr>
 376     </table>
 377   </td>
 378 </tr>
 379   <tr>
 380     <td colspan="2" class="summary">
 381     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 382       <code>__class__</code>
 383       </p>
 384     </td>
 385   </tr>
 386 </table>
 387 <!-- ==================== METHOD DETAILS ==================== -->
 388 <a name="section-MethodDetails"></a>
 389 <table class="details" border="1" cellpadding="3"
 390        cellspacing="0" width="100%" bgcolor="white">
 391 <tr bgcolor="#70b0f0" class="table-header">
 392   <td colspan="2" class="table-header">
 393     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 394       <tr valign="top">
 395         <td align="left"><span class="table-header">Method Details</span></td>
 396         <td align="right" valign="top"
 397          ><span class="options">[<a href="#section-MethodDetails"
 398          class="privatelink" onclick="toggle_private();"
 399          >hide private</a>]</span></td>
 400       </tr>
 401     </table>
 402   </td>
 403 </tr>
 404 </table>
 405 <a name="__new__"></a>
 406 <div>
 407 <table class="details" border="1" cellpadding="3"
 408        cellspacing="0" width="100%" bgcolor="white">
 409 <tr><td>
 410   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 411   <tr valign="top"><td>
 412   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 413         <span class="sig-arg">S</span>,
 414         <span class="sig-arg">...</span>)</span>
 415   </h3>
 416   </td><td align="right" valign="top"
 417     >&nbsp;
 418     </td>
 419   </tr></table>
 420
 421
 422   <dl class="fields">
 423     <dt>Returns: a new object with type S, a subtype of T</dt>
 424     <dt>Overrides:
 425         object.__new__
 426     </dt>
 427   </dl>
 428 </td></tr></table>
 429 </div>
 430 <a name="__repr__"></a>
 431 <div>
 432 <table class="details" border="1" cellpadding="3"
 433        cellspacing="0" width="100%" bgcolor="white">
 434 <tr><td>
 435   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 436   <tr valign="top"><td>
 437   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">x</span>)</span>
 438     <br /><em class="fname">(Representation operator)</em>
 439   </h3>
 440   </td><td align="right" valign="top"
 441     >&nbsp;
 442     </td>
 443   </tr></table>
 444
 445   repr(x)
 446   <dl class="fields">
 447     <dt>Overrides:
 448         object.__repr__
 449     </dt>
 450   </dl>
 451 </td></tr></table>
 452 </div>
 453 <br />
 454 <!-- ==================== NAVIGATION BAR ==================== -->
 455 <table class="navbar" border="0" width="100%" cellpadding="0"
 456        bgcolor="#a0c0ff" cellspacing="0">
 457   <tr valign="middle">
 458   <!-- Home link -->
 459       <th>&nbsp;&nbsp;&nbsp;<a
 460         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 461
 462   <!-- Tree link -->
 463       <th>&nbsp;&nbsp;&nbsp;<a
 464         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 465
 466   <!-- Index link -->
 467       <th>&nbsp;&nbsp;&nbsp;<a
 468         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 469
 470   <!-- Help link -->
 471       <th>&nbsp;&nbsp;&nbsp;<a
 472         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 473
 474   <!-- Project homepage -->
 475       <th class="navbar" align="right" width="100%">
 476         <table border="0" cellpadding="0" cellspacing="0">
 477           <tr><th class="navbar" align="center"
 478             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 479           </tr></table></th>
 480   </tr>
 481 </table>
 482 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 483   <tr>
 484     <td align="left" class="footer">
 485     Generated by Epydoc 3.0.1
 486     on Thu Jul  9 18:29:53 2020
 487     </td>
 488     <td align="right" class="footer">
 489       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 490         >http://epydoc.sourceforge.net</a>
 491     </td>
 492   </tr>
 493 </table>
 494
 495 <script type="text/javascript">
 496   <!--
 497   // Private objects are initially displayed (because if
 498   // javascript is turned off then we want them to be
 499   // visible); but by default, we want to hide them.  So hide
 500   // them unless we have a cookie that says to show them.
 501   checkCookie();
 502   // -->
 503 </script>
 504 </body>
 505 </html>