doc/html/api/lxml.objectify.ObjectifiedDataElement-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.ObjectifiedDataElement</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;ObjectifiedDataElement
  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.ObjectifiedDataElement-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 ObjectifiedDataElement</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66     object --+
  67              |
  68 <a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a> --+
  69                  |
  70  <a href="lxml.etree.ElementBase-class.html">etree.ElementBase</a> --+
  71                      |
  72     <a href="lxml.objectify.ObjectifiedElement-class.html">ObjectifiedElement</a> --+
  73                          |
  74                         <strong class="uidshort">ObjectifiedDataElement</strong>
  75 </pre>
  76
  77 <dl><dt>Known Subclasses:</dt>
  78 <dd>
  79       <ul class="subclass-list">
  80 <li><a href="lxml.objectify.NoneElement-class.html">NoneElement</a></li><li>, <a href="lxml.objectify.NumberElement-class.html">NumberElement</a></li><li>, <a href="lxml.objectify.StringElement-class.html">StringElement</a></li>  </ul>
  81 </dd></dl>
  82
  83 <hr />
  84 This is the base class for all data type Elements.  Subclasses should
  85 override the 'pyval' property and possibly the __str__ method.
  86
  87 <!-- ==================== INSTANCE METHODS ==================== -->
  88 <a name="section-InstanceMethods"></a>
  89 <table class="summary" border="1" cellpadding="3"
  90        cellspacing="0" width="100%" bgcolor="white">
  91 <tr bgcolor="#70b0f0" class="table-header">
  92   <td colspan="2" class="table-header">
  93     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  94       <tr valign="top">
  95         <td align="left"><span class="table-header">Instance Methods</span></td>
  96         <td align="right" valign="top"
  97          ><span class="options">[<a href="#section-InstanceMethods"
  98          class="privatelink" onclick="toggle_private();"
  99          >hide private</a>]</span></td>
 100       </tr>
 101     </table>
 102   </td>
 103 </tr>
 104 <tr>
 105     <td width="15%" align="right" valign="top" class="summary">
 106       <span class="summary-type">a new object with type S, a subtype of T</span>
 107     </td><td class="summary">
 108       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 109         <tr>
 110           <td><span class="summary-sig"><a href="lxml.objectify.ObjectifiedDataElement-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 111         <span class="summary-sig-arg">S</span>,
 112         <span class="summary-sig-arg">...</span>)</span></td>
 113           <td align="right" valign="top">
 114
 115
 116           </td>
 117         </tr>
 118       </table>
 119
 120     </td>
 121   </tr>
 122 <tr>
 123     <td width="15%" align="right" valign="top" class="summary">
 124       <span class="summary-type">&nbsp;</span>
 125     </td><td class="summary">
 126       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 127         <tr>
 128           <td><span class="summary-sig"><a href="lxml.objectify.ObjectifiedDataElement-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">x</span>)</span><br />
 129       repr(x)</td>
 130           <td align="right" valign="top">
 131
 132
 133           </td>
 134         </tr>
 135       </table>
 136
 137     </td>
 138   </tr>
 139 <tr>
 140     <td width="15%" align="right" valign="top" class="summary">
 141       <span class="summary-type">&nbsp;</span>
 142     </td><td class="summary">
 143       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 144         <tr>
 145           <td><span class="summary-sig"><a href="lxml.objectify.ObjectifiedDataElement-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">x</span>)</span><br />
 146       str(x)</td>
 147           <td align="right" valign="top">
 148
 149
 150           </td>
 151         </tr>
 152       </table>
 153
 154     </td>
 155   </tr>
 156 <tr class="private">
 157     <td width="15%" align="right" valign="top" class="summary">
 158       <span class="summary-type">&nbsp;</span>
 159     </td><td class="summary">
 160       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 161         <tr>
 162           <td><span class="summary-sig"><a name="_setText"></a><span class="summary-sig-name">_setText</span>(<span class="summary-sig-arg">...</span>)</span><br />
 163       For use in subclasses only. Don't use unless you know what you are
 164 doing.</td>
 165           <td align="right" valign="top">
 166
 167
 168           </td>
 169         </tr>
 170       </table>
 171
 172     </td>
 173   </tr>
 174   <tr>
 175     <td colspan="2" class="summary">
 176     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.objectify.ObjectifiedElement-class.html">ObjectifiedElement</a></code></b>:
 177       <code><a href="lxml.objectify.ObjectifiedElement-class.html#__delattr__">__delattr__</a></code>,
 178       <code><a href="lxml.objectify.ObjectifiedElement-class.html#__delitem__">__delitem__</a></code>,
 179       <code><a href="lxml.objectify.ObjectifiedElement-class.html#__getattr__">__getattr__</a></code>,
 180       <code><a href="lxml.objectify.ObjectifiedElement-class.html#__getattribute__">__getattribute__</a></code>,
 181       <code><a href="lxml.objectify.ObjectifiedElement-class.html#__getitem__">__getitem__</a></code>,
 182       <code><a href="lxml.objectify.ObjectifiedElement-class.html#__iter__">__iter__</a></code>,
 183       <code><a href="lxml.objectify.ObjectifiedElement-class.html#__len__">__len__</a></code>,
 184       <code><a href="lxml.objectify.ObjectifiedElement-class.html#__reduce__">__reduce__</a></code>,
 185       <code><a href="lxml.objectify.ObjectifiedElement-class.html#__setattr__">__setattr__</a></code>,
 186       <code><a href="lxml.objectify.ObjectifiedElement-class.html#__setitem__">__setitem__</a></code>,
 187       <code><a href="lxml.objectify.ObjectifiedElement-class.html#addattr">addattr</a></code>,
 188       <code><a href="lxml.objectify.ObjectifiedElement-class.html#countchildren">countchildren</a></code>,
 189       <code><a href="lxml.objectify.ObjectifiedElement-class.html#descendantpaths">descendantpaths</a></code>,
 190       <code><a href="lxml.objectify.ObjectifiedElement-class.html#getchildren">getchildren</a></code>
 191       </p>
 192     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.ElementBase-class.html">etree.ElementBase</a></code></b>:
 193       <code><a href="lxml.etree.ElementBase-class.html#__init__">__init__</a></code>
 194       </p>
 195     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a></code></b>:
 196       <code><a href="lxml.etree._Element-class.html#__contains__">__contains__</a></code>,
 197       <code><a href="lxml.etree._Element-class.html#__copy__">__copy__</a></code>,
 198       <code><a href="lxml.etree._Element-class.html#__deepcopy__">__deepcopy__</a></code>,
 199       <code><a href="lxml.etree._Element-class.html#__nonzero__">__nonzero__</a></code>,
 200       <code><a href="lxml.etree._Element-class.html#__reversed__">__reversed__</a></code>,
 201       <code><a href="lxml.etree._Element-class.html#addnext">addnext</a></code>,
 202       <code><a href="lxml.etree._Element-class.html#addprevious">addprevious</a></code>,
 203       <code><a href="lxml.etree._Element-class.html#append">append</a></code>,
 204       <code><a href="lxml.etree._Element-class.html#clear">clear</a></code>,
 205       <code><a href="lxml.etree._Element-class.html#cssselect">cssselect</a></code>,
 206       <code><a href="lxml.etree._Element-class.html#extend">extend</a></code>,
 207       <code><a href="lxml.etree._Element-class.html#find">find</a></code>,
 208       <code><a href="lxml.etree._Element-class.html#findall">findall</a></code>,
 209       <code><a href="lxml.etree._Element-class.html#findtext">findtext</a></code>,
 210       <code><a href="lxml.etree._Element-class.html#get">get</a></code>,
 211       <code><a href="lxml.etree._Element-class.html#getiterator">getiterator</a></code>,
 212       <code><a href="lxml.etree._Element-class.html#getnext">getnext</a></code>,
 213       <code><a href="lxml.etree._Element-class.html#getparent">getparent</a></code>,
 214       <code><a href="lxml.etree._Element-class.html#getprevious">getprevious</a></code>,
 215       <code><a href="lxml.etree._Element-class.html#getroottree">getroottree</a></code>,
 216       <code><a href="lxml.etree._Element-class.html#index">index</a></code>,
 217       <code><a href="lxml.etree._Element-class.html#insert">insert</a></code>,
 218       <code><a href="lxml.etree._Element-class.html#items">items</a></code>,
 219       <code><a href="lxml.etree._Element-class.html#iter">iter</a></code>,
 220       <code><a href="lxml.etree._Element-class.html#iterancestors">iterancestors</a></code>,
 221       <code><a href="lxml.etree._Element-class.html#iterchildren">iterchildren</a></code>,
 222       <code><a href="lxml.etree._Element-class.html#iterdescendants">iterdescendants</a></code>,
 223       <code><a href="lxml.etree._Element-class.html#iterfind">iterfind</a></code>,
 224       <code><a href="lxml.etree._Element-class.html#itersiblings">itersiblings</a></code>,
 225       <code><a href="lxml.etree._Element-class.html#itertext">itertext</a></code>,
 226       <code><a href="lxml.etree._Element-class.html#keys">keys</a></code>,
 227       <code><a href="lxml.etree._Element-class.html#makeelement">makeelement</a></code>,
 228       <code><a href="lxml.etree._Element-class.html#remove">remove</a></code>,
 229       <code><a href="lxml.etree._Element-class.html#replace">replace</a></code>,
 230       <code><a href="lxml.etree._Element-class.html#set">set</a></code>,
 231       <code><a href="lxml.etree._Element-class.html#values">values</a></code>,
 232       <code><a href="lxml.etree._Element-class.html#xpath">xpath</a></code>
 233       </p>
 234     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a></code></b> (private):
 235       <code><a href="lxml.etree._Element-class.html#_init" onclick="show_private();">_init</a></code>
 236       </p></div>
 237     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 238       <code>__format__</code>,
 239       <code>__hash__</code>,
 240       <code>__reduce_ex__</code>,
 241       <code>__sizeof__</code>,
 242       <code>__subclasshook__</code>
 243       </p>
 244     </td>
 245   </tr>
 246 </table>
 247 <!-- ==================== PROPERTIES ==================== -->
 248 <a name="section-Properties"></a>
 249 <table class="summary" border="1" cellpadding="3"
 250        cellspacing="0" width="100%" bgcolor="white">
 251 <tr bgcolor="#70b0f0" class="table-header">
 252   <td colspan="2" class="table-header">
 253     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 254       <tr valign="top">
 255         <td align="left"><span class="table-header">Properties</span></td>
 256         <td align="right" valign="top"
 257          ><span class="options">[<a href="#section-Properties"
 258          class="privatelink" onclick="toggle_private();"
 259          >hide private</a>]</span></td>
 260       </tr>
 261     </table>
 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         <a name="pyval"></a><span class="summary-name">pyval</span>
 269     </td>
 270   </tr>
 271   <tr>
 272     <td colspan="2" class="summary">
 273     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.objectify.ObjectifiedElement-class.html">ObjectifiedElement</a></code></b>:
 274       <code><a href="lxml.objectify.ObjectifiedElement-class.html#text">text</a></code>
 275       </p>
 276     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">etree._Element</a></code></b>:
 277       <code><a href="lxml.etree._Element-class.html#attrib">attrib</a></code>,
 278       <code><a href="lxml.etree._Element-class.html#base">base</a></code>,
 279       <code><a href="lxml.etree._Element-class.html#nsmap">nsmap</a></code>,
 280       <code><a href="lxml.etree._Element-class.html#prefix">prefix</a></code>,
 281       <code><a href="lxml.etree._Element-class.html#sourceline">sourceline</a></code>,
 282       <code><a href="lxml.etree._Element-class.html#tag">tag</a></code>,
 283       <code><a href="lxml.etree._Element-class.html#tail">tail</a></code>
 284       </p>
 285     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 286       <code>__class__</code>
 287       </p>
 288     </td>
 289   </tr>
 290 </table>
 291 <!-- ==================== METHOD DETAILS ==================== -->
 292 <a name="section-MethodDetails"></a>
 293 <table class="details" border="1" cellpadding="3"
 294        cellspacing="0" width="100%" bgcolor="white">
 295 <tr bgcolor="#70b0f0" class="table-header">
 296   <td colspan="2" class="table-header">
 297     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 298       <tr valign="top">
 299         <td align="left"><span class="table-header">Method Details</span></td>
 300         <td align="right" valign="top"
 301          ><span class="options">[<a href="#section-MethodDetails"
 302          class="privatelink" onclick="toggle_private();"
 303          >hide private</a>]</span></td>
 304       </tr>
 305     </table>
 306   </td>
 307 </tr>
 308 </table>
 309 <a name="__new__"></a>
 310 <div>
 311 <table class="details" border="1" cellpadding="3"
 312        cellspacing="0" width="100%" bgcolor="white">
 313 <tr><td>
 314   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 315   <tr valign="top"><td>
 316   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 317         <span class="sig-arg">S</span>,
 318         <span class="sig-arg">...</span>)</span>
 319   </h3>
 320   </td><td align="right" valign="top"
 321     >&nbsp;
 322     </td>
 323   </tr></table>
 324
 325
 326   <dl class="fields">
 327     <dt>Returns: a new object with type S, a subtype of T</dt>
 328     <dt>Overrides:
 329         object.__new__
 330     </dt>
 331   </dl>
 332 </td></tr></table>
 333 </div>
 334 <a name="__repr__"></a>
 335 <div>
 336 <table class="details" border="1" cellpadding="3"
 337        cellspacing="0" width="100%" bgcolor="white">
 338 <tr><td>
 339   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 340   <tr valign="top"><td>
 341   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">x</span>)</span>
 342     <br /><em class="fname">(Representation operator)</em>
 343   </h3>
 344   </td><td align="right" valign="top"
 345     >&nbsp;
 346     </td>
 347   </tr></table>
 348
 349   repr(x)
 350   <dl class="fields">
 351     <dt>Overrides:
 352         object.__repr__
 353     </dt>
 354   </dl>
 355 </td></tr></table>
 356 </div>
 357 <a name="__str__"></a>
 358 <div>
 359 <table class="details" border="1" cellpadding="3"
 360        cellspacing="0" width="100%" bgcolor="white">
 361 <tr><td>
 362   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 363   <tr valign="top"><td>
 364   <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">x</span>)</span>
 365     <br /><em class="fname">(Informal representation operator)</em>
 366   </h3>
 367   </td><td align="right" valign="top"
 368     >&nbsp;
 369     </td>
 370   </tr></table>
 371
 372   str(x)
 373   <dl class="fields">
 374     <dt>Overrides:
 375         object.__str__
 376     </dt>
 377   </dl>
 378 </td></tr></table>
 379 </div>
 380 <br />
 381 <!-- ==================== NAVIGATION BAR ==================== -->
 382 <table class="navbar" border="0" width="100%" cellpadding="0"
 383        bgcolor="#a0c0ff" cellspacing="0">
 384   <tr valign="middle">
 385   <!-- Home link -->
 386       <th>&nbsp;&nbsp;&nbsp;<a
 387         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 388
 389   <!-- Tree link -->
 390       <th>&nbsp;&nbsp;&nbsp;<a
 391         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 392
 393   <!-- Index link -->
 394       <th>&nbsp;&nbsp;&nbsp;<a
 395         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 396
 397   <!-- Help link -->
 398       <th>&nbsp;&nbsp;&nbsp;<a
 399         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 400
 401   <!-- Project homepage -->
 402       <th class="navbar" align="right" width="100%">
 403         <table border="0" cellpadding="0" cellspacing="0">
 404           <tr><th class="navbar" align="center"
 405             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 406           </tr></table></th>
 407   </tr>
 408 </table>
 409 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 410   <tr>
 411     <td align="left" class="footer">
 412     Generated by Epydoc 3.0.1
 413     on Thu Jul  9 18:29:53 2020
 414     </td>
 415     <td align="right" class="footer">
 416       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 417         >http://epydoc.sourceforge.net</a>
 418     </td>
 419   </tr>
 420 </table>
 421
 422 <script type="text/javascript">
 423   <!--
 424   // Private objects are initially displayed (because if
 425   // javascript is turned off then we want them to be
 426   // visible); but by default, we want to hide them.  So hide
 427   // them unless we have a cookie that says to show them.
 428   checkCookie();
 429   // -->
 430 </script>
 431 </body>
 432 </html>