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