doc/html/api/lxml.etree.PIBase-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.PIBase</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;PIBase
  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.PIBase-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 PIBase</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();">_Element</a> --+
  69                       |
  70 ??.__ContentOnlyElement --+
  71                           |
  72      <a href="lxml.etree._ProcessingInstruction-class.html" onclick="show_private();">_ProcessingInstruction</a> --+
  73                               |
  74                              <strong class="uidshort">PIBase</strong>
  75 </pre>
  76
  77 <dl><dt>Known Subclasses:</dt>
  78 <dd>
  79       <ul class="subclass-list">
  80 <li><a href="lxml.html.HtmlProcessingInstruction-class.html">html.HtmlProcessingInstruction</a></li><li class="private">, <a href="lxml.etree._XSLTProcessingInstruction-class.html" onclick="show_private();">_XSLTProcessingInstruction</a></li>  </ul>
  81 </dd></dl>
  82
  83 <hr />
  84 <p>All custom Processing Instruction classes must inherit from this one.</p>
  85 <p>To create an XML ProcessingInstruction instance, use the <tt class="rst-docutils literal">PI()</tt>
  86 factory.</p>
  87 <p>Subclasses <em>must not</em> override __init__ or __new__ as it is
  88 absolutely undefined when these objects will be created or
  89 destroyed.  All persistent state of PIs must be stored in the
  90 underlying XML.  If you really need to initialize the object after
  91 creation, you can implement an <tt class="rst-docutils literal">_init(self)</tt> method that will be
  92 called after object creation.</p>
  93
  94 <!-- ==================== INSTANCE METHODS ==================== -->
  95 <a name="section-InstanceMethods"></a>
  96 <table class="summary" border="1" cellpadding="3"
  97        cellspacing="0" width="100%" bgcolor="white">
  98 <tr bgcolor="#70b0f0" class="table-header">
  99   <td colspan="2" class="table-header">
 100     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 101       <tr valign="top">
 102         <td align="left"><span class="table-header">Instance Methods</span></td>
 103         <td align="right" valign="top"
 104          ><span class="options">[<a href="#section-InstanceMethods"
 105          class="privatelink" onclick="toggle_private();"
 106          >hide private</a>]</span></td>
 107       </tr>
 108     </table>
 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.etree.PIBase-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">...</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.etree.PIBase-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 colspan="2" class="summary">
 148     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._ProcessingInstruction-class.html" onclick="show_private();">_ProcessingInstruction</a></code></b>:
 149       <code><a href="lxml.etree._ProcessingInstruction-class.html#__repr__">__repr__</a></code>,
 150       <code><a href="lxml.etree._ProcessingInstruction-class.html#get">get</a></code>
 151       </p>
 152     <p class="indent-wrapped-lines"><b>Inherited from <code><i>unreachable</i>.__ContentOnlyElement</code></b>:
 153       <code>__delitem__</code>,
 154       <code>__getitem__</code>,
 155       <code>__len__</code>,
 156       <code>__setitem__</code>,
 157       <code>append</code>,
 158       <code>insert</code>,
 159       <code>items</code>,
 160       <code>keys</code>,
 161       <code>set</code>,
 162       <code>values</code>
 163       </p>
 164     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
 165       <code><a href="lxml.etree._Element-class.html#__contains__">__contains__</a></code>,
 166       <code><a href="lxml.etree._Element-class.html#__copy__">__copy__</a></code>,
 167       <code><a href="lxml.etree._Element-class.html#__deepcopy__">__deepcopy__</a></code>,
 168       <code><a href="lxml.etree._Element-class.html#__iter__">__iter__</a></code>,
 169       <code><a href="lxml.etree._Element-class.html#__nonzero__">__nonzero__</a></code>,
 170       <code><a href="lxml.etree._Element-class.html#__reversed__">__reversed__</a></code>,
 171       <code><a href="lxml.etree._Element-class.html#addnext">addnext</a></code>,
 172       <code><a href="lxml.etree._Element-class.html#addprevious">addprevious</a></code>,
 173       <code><a href="lxml.etree._Element-class.html#clear">clear</a></code>,
 174       <code><a href="lxml.etree._Element-class.html#cssselect">cssselect</a></code>,
 175       <code><a href="lxml.etree._Element-class.html#extend">extend</a></code>,
 176       <code><a href="lxml.etree._Element-class.html#find">find</a></code>,
 177       <code><a href="lxml.etree._Element-class.html#findall">findall</a></code>,
 178       <code><a href="lxml.etree._Element-class.html#findtext">findtext</a></code>,
 179       <code><a href="lxml.etree._Element-class.html#getchildren">getchildren</a></code>,
 180       <code><a href="lxml.etree._Element-class.html#getiterator">getiterator</a></code>,
 181       <code><a href="lxml.etree._Element-class.html#getnext">getnext</a></code>,
 182       <code><a href="lxml.etree._Element-class.html#getparent">getparent</a></code>,
 183       <code><a href="lxml.etree._Element-class.html#getprevious">getprevious</a></code>,
 184       <code><a href="lxml.etree._Element-class.html#getroottree">getroottree</a></code>,
 185       <code><a href="lxml.etree._Element-class.html#index">index</a></code>,
 186       <code><a href="lxml.etree._Element-class.html#iter">iter</a></code>,
 187       <code><a href="lxml.etree._Element-class.html#iterancestors">iterancestors</a></code>,
 188       <code><a href="lxml.etree._Element-class.html#iterchildren">iterchildren</a></code>,
 189       <code><a href="lxml.etree._Element-class.html#iterdescendants">iterdescendants</a></code>,
 190       <code><a href="lxml.etree._Element-class.html#iterfind">iterfind</a></code>,
 191       <code><a href="lxml.etree._Element-class.html#itersiblings">itersiblings</a></code>,
 192       <code><a href="lxml.etree._Element-class.html#itertext">itertext</a></code>,
 193       <code><a href="lxml.etree._Element-class.html#makeelement">makeelement</a></code>,
 194       <code><a href="lxml.etree._Element-class.html#remove">remove</a></code>,
 195       <code><a href="lxml.etree._Element-class.html#replace">replace</a></code>,
 196       <code><a href="lxml.etree._Element-class.html#xpath">xpath</a></code>
 197       </p>
 198     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b> (private):
 199       <code><a href="lxml.etree._Element-class.html#_init" onclick="show_private();">_init</a></code>
 200       </p></div>
 201     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 202       <code>__delattr__</code>,
 203       <code>__format__</code>,
 204       <code>__getattribute__</code>,
 205       <code>__hash__</code>,
 206       <code>__reduce__</code>,
 207       <code>__reduce_ex__</code>,
 208       <code>__setattr__</code>,
 209       <code>__sizeof__</code>,
 210       <code>__str__</code>,
 211       <code>__subclasshook__</code>
 212       </p>
 213     </td>
 214   </tr>
 215 </table>
 216 <!-- ==================== PROPERTIES ==================== -->
 217 <a name="section-Properties"></a>
 218 <table class="summary" border="1" cellpadding="3"
 219        cellspacing="0" width="100%" bgcolor="white">
 220 <tr bgcolor="#70b0f0" class="table-header">
 221   <td colspan="2" class="table-header">
 222     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 223       <tr valign="top">
 224         <td align="left"><span class="table-header">Properties</span></td>
 225         <td align="right" valign="top"
 226          ><span class="options">[<a href="#section-Properties"
 227          class="privatelink" onclick="toggle_private();"
 228          >hide private</a>]</span></td>
 229       </tr>
 230     </table>
 231   </td>
 232 </tr>
 233   <tr>
 234     <td colspan="2" class="summary">
 235     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._ProcessingInstruction-class.html" onclick="show_private();">_ProcessingInstruction</a></code></b>:
 236       <code><a href="lxml.etree._ProcessingInstruction-class.html#attrib">attrib</a></code>,
 237       <code><a href="lxml.etree._ProcessingInstruction-class.html#tag">tag</a></code>,
 238       <code><a href="lxml.etree._ProcessingInstruction-class.html#target">target</a></code>
 239       </p>
 240     <p class="indent-wrapped-lines"><b>Inherited from <code><i>unreachable</i>.__ContentOnlyElement</code></b>:
 241       <code>text</code>
 242       </p>
 243     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
 244       <code><a href="lxml.etree._Element-class.html#base">base</a></code>,
 245       <code><a href="lxml.etree._Element-class.html#nsmap">nsmap</a></code>,
 246       <code><a href="lxml.etree._Element-class.html#prefix">prefix</a></code>,
 247       <code><a href="lxml.etree._Element-class.html#sourceline">sourceline</a></code>,
 248       <code><a href="lxml.etree._Element-class.html#tail">tail</a></code>
 249       </p>
 250     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 251       <code>__class__</code>
 252       </p>
 253     </td>
 254   </tr>
 255 </table>
 256 <!-- ==================== METHOD DETAILS ==================== -->
 257 <a name="section-MethodDetails"></a>
 258 <table class="details" border="1" cellpadding="3"
 259        cellspacing="0" width="100%" bgcolor="white">
 260 <tr bgcolor="#70b0f0" class="table-header">
 261   <td colspan="2" class="table-header">
 262     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 263       <tr valign="top">
 264         <td align="left"><span class="table-header">Method Details</span></td>
 265         <td align="right" valign="top"
 266          ><span class="options">[<a href="#section-MethodDetails"
 267          class="privatelink" onclick="toggle_private();"
 268          >hide private</a>]</span></td>
 269       </tr>
 270     </table>
 271   </td>
 272 </tr>
 273 </table>
 274 <a name="__init__"></a>
 275 <div>
 276 <table class="details" border="1" cellpadding="3"
 277        cellspacing="0" width="100%" bgcolor="white">
 278 <tr><td>
 279   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 280   <tr valign="top"><td>
 281   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">...</span>)</span>
 282     <br /><em class="fname">(Constructor)</em>
 283   </h3>
 284   </td><td align="right" valign="top"
 285     >&nbsp;
 286     </td>
 287   </tr></table>
 288
 289   x.__init__(...) initializes x; see help(type(x)) for signature
 290   <dl class="fields">
 291     <dt>Overrides:
 292         object.__init__
 293     </dt>
 294   </dl>
 295 </td></tr></table>
 296 </div>
 297 <a name="__new__"></a>
 298 <div>
 299 <table class="details" border="1" cellpadding="3"
 300        cellspacing="0" width="100%" bgcolor="white">
 301 <tr><td>
 302   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 303   <tr valign="top"><td>
 304   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 305         <span class="sig-arg">S</span>,
 306         <span class="sig-arg">...</span>)</span>
 307   </h3>
 308   </td><td align="right" valign="top"
 309     >&nbsp;
 310     </td>
 311   </tr></table>
 312
 313
 314   <dl class="fields">
 315     <dt>Returns: a new object with type S, a subtype of T</dt>
 316     <dt>Overrides:
 317         object.__new__
 318     </dt>
 319   </dl>
 320 </td></tr></table>
 321 </div>
 322 <br />
 323 <!-- ==================== NAVIGATION BAR ==================== -->
 324 <table class="navbar" border="0" width="100%" cellpadding="0"
 325        bgcolor="#a0c0ff" cellspacing="0">
 326   <tr valign="middle">
 327   <!-- Home link -->
 328       <th>&nbsp;&nbsp;&nbsp;<a
 329         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 330
 331   <!-- Tree link -->
 332       <th>&nbsp;&nbsp;&nbsp;<a
 333         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 334
 335   <!-- Index link -->
 336       <th>&nbsp;&nbsp;&nbsp;<a
 337         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 338
 339   <!-- Help link -->
 340       <th>&nbsp;&nbsp;&nbsp;<a
 341         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 342
 343   <!-- Project homepage -->
 344       <th class="navbar" align="right" width="100%">
 345         <table border="0" cellpadding="0" cellspacing="0">
 346           <tr><th class="navbar" align="center"
 347             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 348           </tr></table></th>
 349   </tr>
 350 </table>
 351 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 352   <tr>
 353     <td align="left" class="footer">
 354     Generated by Epydoc 3.0.1
 355     on Wed Jan 29 12:26:21 2020
 356     </td>
 357     <td align="right" class="footer">
 358       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 359         >http://epydoc.sourceforge.net</a>
 360     </td>
 361   </tr>
 362 </table>
 363
 364 <script type="text/javascript">
 365   <!--
 366   // Private objects are initially displayed (because if
 367   // javascript is turned off then we want them to be
 368   // visible); but by default, we want to hide them.  So hide
 369   // them unless we have a cookie that says to show them.
 370   checkCookie();
 371   // -->
 372 </script>
 373 </body>
 374 </html>