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 <a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a> --+
  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 class="private"><a href="lxml.etree._XSLTProcessingInstruction-class.html" onclick="show_private();">_XSLTProcessingInstruction</a></li><li class="private">, <a href="lxml.html.HtmlProcessingInstruction-class.html" onclick="show_private();">html.HtmlProcessingInstruction</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><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></code></b>:
 153       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__delitem__">__delitem__</a></code>,
 154       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__getitem__">__getitem__</a></code>,
 155       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__len__">__len__</a></code>,
 156       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__setitem__">__setitem__</a></code>,
 157       <code><a href="lxml.etree.__ContentOnlyElement-class.html#append">append</a></code>,
 158       <code><a href="lxml.etree.__ContentOnlyElement-class.html#insert">insert</a></code>,
 159       <code><a href="lxml.etree.__ContentOnlyElement-class.html#items">items</a></code>,
 160       <code><a href="lxml.etree.__ContentOnlyElement-class.html#keys">keys</a></code>,
 161       <code><a href="lxml.etree.__ContentOnlyElement-class.html#set">set</a></code>,
 162       <code><a href="lxml.etree.__ContentOnlyElement-class.html#values">values</a></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#extend">extend</a></code>,
 175       <code><a href="lxml.etree._Element-class.html#find">find</a></code>,
 176       <code><a href="lxml.etree._Element-class.html#findall">findall</a></code>,
 177       <code><a href="lxml.etree._Element-class.html#findtext">findtext</a></code>,
 178       <code><a href="lxml.etree._Element-class.html#getchildren">getchildren</a></code>,
 179       <code><a href="lxml.etree._Element-class.html#getiterator">getiterator</a></code>,
 180       <code><a href="lxml.etree._Element-class.html#getnext">getnext</a></code>,
 181       <code><a href="lxml.etree._Element-class.html#getparent">getparent</a></code>,
 182       <code><a href="lxml.etree._Element-class.html#getprevious">getprevious</a></code>,
 183       <code><a href="lxml.etree._Element-class.html#getroottree">getroottree</a></code>,
 184       <code><a href="lxml.etree._Element-class.html#index">index</a></code>,
 185       <code><a href="lxml.etree._Element-class.html#iter">iter</a></code>,
 186       <code><a href="lxml.etree._Element-class.html#iterancestors">iterancestors</a></code>,
 187       <code><a href="lxml.etree._Element-class.html#iterchildren">iterchildren</a></code>,
 188       <code><a href="lxml.etree._Element-class.html#iterdescendants">iterdescendants</a></code>,
 189       <code><a href="lxml.etree._Element-class.html#iterfind">iterfind</a></code>,
 190       <code><a href="lxml.etree._Element-class.html#itersiblings">itersiblings</a></code>,
 191       <code><a href="lxml.etree._Element-class.html#itertext">itertext</a></code>,
 192       <code><a href="lxml.etree._Element-class.html#makeelement">makeelement</a></code>,
 193       <code><a href="lxml.etree._Element-class.html#remove">remove</a></code>,
 194       <code><a href="lxml.etree._Element-class.html#replace">replace</a></code>,
 195       <code><a href="lxml.etree._Element-class.html#xpath">xpath</a></code>
 196       </p>
 197     <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):
 198       <code><a href="lxml.etree._Element-class.html#_init" onclick="show_private();">_init</a></code>
 199       </p></div>
 200     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 201       <code>__delattr__</code>,
 202       <code>__format__</code>,
 203       <code>__getattribute__</code>,
 204       <code>__hash__</code>,
 205       <code>__reduce__</code>,
 206       <code>__reduce_ex__</code>,
 207       <code>__setattr__</code>,
 208       <code>__sizeof__</code>,
 209       <code>__str__</code>,
 210       <code>__subclasshook__</code>
 211       </p>
 212     </td>
 213   </tr>
 214 </table>
 215 <!-- ==================== PROPERTIES ==================== -->
 216 <a name="section-Properties"></a>
 217 <table class="summary" border="1" cellpadding="3"
 218        cellspacing="0" width="100%" bgcolor="white">
 219 <tr bgcolor="#70b0f0" class="table-header">
 220   <td colspan="2" class="table-header">
 221     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 222       <tr valign="top">
 223         <td align="left"><span class="table-header">Properties</span></td>
 224         <td align="right" valign="top"
 225          ><span class="options">[<a href="#section-Properties"
 226          class="privatelink" onclick="toggle_private();"
 227          >hide private</a>]</span></td>
 228       </tr>
 229     </table>
 230   </td>
 231 </tr>
 232   <tr>
 233     <td colspan="2" class="summary">
 234     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._ProcessingInstruction-class.html" onclick="show_private();">_ProcessingInstruction</a></code></b>:
 235       <code><a href="lxml.etree._ProcessingInstruction-class.html#attrib">attrib</a></code>,
 236       <code><a href="lxml.etree._ProcessingInstruction-class.html#tag">tag</a></code>,
 237       <code><a href="lxml.etree._ProcessingInstruction-class.html#target">target</a></code>
 238       </p>
 239     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></code></b>:
 240       <code><a href="lxml.etree.__ContentOnlyElement-class.html#text">text</a></code>
 241       </p>
 242     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
 243       <code><a href="lxml.etree._Element-class.html#base">base</a></code>,
 244       <code><a href="lxml.etree._Element-class.html#nsmap">nsmap</a></code>,
 245       <code><a href="lxml.etree._Element-class.html#prefix">prefix</a></code>,
 246       <code><a href="lxml.etree._Element-class.html#sourceline">sourceline</a></code>,
 247       <code><a href="lxml.etree._Element-class.html#tail">tail</a></code>
 248       </p>
 249     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 250       <code>__class__</code>
 251       </p>
 252     </td>
 253   </tr>
 254 </table>
 255 <!-- ==================== METHOD DETAILS ==================== -->
 256 <a name="section-MethodDetails"></a>
 257 <table class="details" border="1" cellpadding="3"
 258        cellspacing="0" width="100%" bgcolor="white">
 259 <tr bgcolor="#70b0f0" class="table-header">
 260   <td colspan="2" class="table-header">
 261     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 262       <tr valign="top">
 263         <td align="left"><span class="table-header">Method Details</span></td>
 264         <td align="right" valign="top"
 265          ><span class="options">[<a href="#section-MethodDetails"
 266          class="privatelink" onclick="toggle_private();"
 267          >hide private</a>]</span></td>
 268       </tr>
 269     </table>
 270   </td>
 271 </tr>
 272 </table>
 273 <a name="__init__"></a>
 274 <div>
 275 <table class="details" border="1" cellpadding="3"
 276        cellspacing="0" width="100%" bgcolor="white">
 277 <tr><td>
 278   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 279   <tr valign="top"><td>
 280   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">...</span>)</span>
 281     <br /><em class="fname">(Constructor)</em>
 282   </h3>
 283   </td><td align="right" valign="top"
 284     >&nbsp;
 285     </td>
 286   </tr></table>
 287
 288   x.__init__(...) initializes x; see help(type(x)) for signature
 289   <dl class="fields">
 290     <dt>Overrides:
 291         object.__init__
 292     </dt>
 293   </dl>
 294 </td></tr></table>
 295 </div>
 296 <a name="__new__"></a>
 297 <div>
 298 <table class="details" border="1" cellpadding="3"
 299        cellspacing="0" width="100%" bgcolor="white">
 300 <tr><td>
 301   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 302   <tr valign="top"><td>
 303   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 304         <span class="sig-arg">S</span>,
 305         <span class="sig-arg">...</span>)</span>
 306   </h3>
 307   </td><td align="right" valign="top"
 308     >&nbsp;
 309     </td>
 310   </tr></table>
 311
 312
 313   <dl class="fields">
 314     <dt>Returns: a new object with type S, a subtype of T</dt>
 315     <dt>Overrides:
 316         object.__new__
 317     </dt>
 318   </dl>
 319 </td></tr></table>
 320 </div>
 321 <br />
 322 <!-- ==================== NAVIGATION BAR ==================== -->
 323 <table class="navbar" border="0" width="100%" cellpadding="0"
 324        bgcolor="#a0c0ff" cellspacing="0">
 325   <tr valign="middle">
 326   <!-- Home link -->
 327       <th>&nbsp;&nbsp;&nbsp;<a
 328         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 329
 330   <!-- Tree link -->
 331       <th>&nbsp;&nbsp;&nbsp;<a
 332         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 333
 334   <!-- Index link -->
 335       <th>&nbsp;&nbsp;&nbsp;<a
 336         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 337
 338   <!-- Help link -->
 339       <th>&nbsp;&nbsp;&nbsp;<a
 340         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 341
 342   <!-- Project homepage -->
 343       <th class="navbar" align="right" width="100%">
 344         <table border="0" cellpadding="0" cellspacing="0">
 345           <tr><th class="navbar" align="center"
 346             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 347           </tr></table></th>
 348   </tr>
 349 </table>
 350 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 351   <tr>
 352     <td align="left" class="footer">
 353     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 354     </td>
 355     <td align="right" class="footer">
 356       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 357         >http://epydoc.sourceforge.net</a>
 358     </td>
 359   </tr>
 360 </table>
 361
 362 <script type="text/javascript">
 363   <!--
 364   // Private objects are initially displayed (because if
 365   // javascript is turned off then we want them to be
 366   // visible); but by default, we want to hide them.  So hide
 367   // them unless we have a cookie that says to show them.
 368   checkCookie();
 369   // -->
 370 </script>
 371 </body>
 372 </html>