doc/html/api/lxml.etree._XSLTResultTree-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._XSLTResultTree</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;_XSLTResultTree
  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._XSLTResultTree-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 _XSLTResultTree</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66   object --+
  67            |
  68 <a href="lxml.etree._ElementTree-class.html" onclick="show_private();">_ElementTree</a> --+
  69                |
  70               <strong class="uidshort">_XSLTResultTree</strong>
  71 </pre>
  72
  73 <hr />
  74 <p>The result of an XSLT evaluation.</p>
  75 <p>Use <tt class="rst-docutils literal">str()</tt> or <tt class="rst-docutils literal">bytes()</tt> (or <tt class="rst-docutils literal">unicode()</tt> in Python 2.x) to serialise to a string,
  76 and the <tt class="rst-docutils literal">.write_output()</tt> method to write serialise to a file.</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">a new object with type S, a subtype of T</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 href="lxml.etree._XSLTResultTree-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 102         <span class="summary-sig-arg">S</span>,
 103         <span class="summary-sig-arg">...</span>)</span></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 href="lxml.etree._XSLTResultTree-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">x</span>)</span><br />
 120       str(x)</td>
 121           <td align="right" valign="top">
 122
 123
 124           </td>
 125         </tr>
 126       </table>
 127
 128     </td>
 129   </tr>
 130 <tr>
 131     <td width="15%" align="right" valign="top" class="summary">
 132       <span class="summary-type">&nbsp;</span>
 133     </td><td class="summary">
 134       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 135         <tr>
 136           <td><span class="summary-sig"><a name="__unicode__"></a><span class="summary-sig-name">__unicode__</span>(<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 width="15%" align="right" valign="top" class="summary">
 148       <span class="summary-type">&nbsp;</span>
 149     </td><td class="summary">
 150       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 151         <tr>
 152           <td><span class="summary-sig"><a href="lxml.etree._XSLTResultTree-class.html#write_output" class="summary-sig-name">write_output</a>(<span class="summary-sig-arg">...</span>)</span><br />
 153       write_output(self, file, <a href="#id1"><span class="rst-problematic" id="rst-id2">*</span></a>, compression=0)</td>
 154           <td align="right" valign="top">
 155
 156
 157           </td>
 158         </tr>
 159       </table>
 160
 161     </td>
 162   </tr>
 163   <tr>
 164     <td colspan="2" class="summary">
 165     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._ElementTree-class.html" onclick="show_private();">_ElementTree</a></code></b>:
 166       <code><a href="lxml.etree._ElementTree-class.html#__copy__">__copy__</a></code>,
 167       <code><a href="lxml.etree._ElementTree-class.html#__deepcopy__">__deepcopy__</a></code>,
 168       <code><a href="lxml.etree._ElementTree-class.html#find">find</a></code>,
 169       <code><a href="lxml.etree._ElementTree-class.html#findall">findall</a></code>,
 170       <code><a href="lxml.etree._ElementTree-class.html#findtext">findtext</a></code>,
 171       <code><a href="lxml.etree._ElementTree-class.html#getelementpath">getelementpath</a></code>,
 172       <code><a href="lxml.etree._ElementTree-class.html#getiterator">getiterator</a></code>,
 173       <code><a href="lxml.etree._ElementTree-class.html#getpath">getpath</a></code>,
 174       <code><a href="lxml.etree._ElementTree-class.html#getroot">getroot</a></code>,
 175       <code><a href="lxml.etree._ElementTree-class.html#iter">iter</a></code>,
 176       <code><a href="lxml.etree._ElementTree-class.html#iterfind">iterfind</a></code>,
 177       <code><a href="lxml.etree._ElementTree-class.html#parse">parse</a></code>,
 178       <code><a href="lxml.etree._ElementTree-class.html#relaxng">relaxng</a></code>,
 179       <code><a href="lxml.etree._ElementTree-class.html#write">write</a></code>,
 180       <code><a href="lxml.etree._ElementTree-class.html#write_c14n">write_c14n</a></code>,
 181       <code><a href="lxml.etree._ElementTree-class.html#xinclude">xinclude</a></code>,
 182       <code><a href="lxml.etree._ElementTree-class.html#xmlschema">xmlschema</a></code>,
 183       <code><a href="lxml.etree._ElementTree-class.html#xpath">xpath</a></code>,
 184       <code><a href="lxml.etree._ElementTree-class.html#xslt">xslt</a></code>
 185       </p>
 186     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._ElementTree-class.html" onclick="show_private();">_ElementTree</a></code></b> (private):
 187       <code><a href="lxml.etree._ElementTree-class.html#_setroot" onclick="show_private();">_setroot</a></code>
 188       </p></div>
 189     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 190       <code>__delattr__</code>,
 191       <code>__format__</code>,
 192       <code>__getattribute__</code>,
 193       <code>__hash__</code>,
 194       <code>__init__</code>,
 195       <code>__reduce__</code>,
 196       <code>__reduce_ex__</code>,
 197       <code>__repr__</code>,
 198       <code>__setattr__</code>,
 199       <code>__sizeof__</code>,
 200       <code>__subclasshook__</code>
 201       </p>
 202     </td>
 203   </tr>
 204 </table>
 205 <!-- ==================== PROPERTIES ==================== -->
 206 <a name="section-Properties"></a>
 207 <table class="summary" border="1" cellpadding="3"
 208        cellspacing="0" width="100%" bgcolor="white">
 209 <tr bgcolor="#70b0f0" class="table-header">
 210   <td colspan="2" class="table-header">
 211     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 212       <tr valign="top">
 213         <td align="left"><span class="table-header">Properties</span></td>
 214         <td align="right" valign="top"
 215          ><span class="options">[<a href="#section-Properties"
 216          class="privatelink" onclick="toggle_private();"
 217          >hide private</a>]</span></td>
 218       </tr>
 219     </table>
 220   </td>
 221 </tr>
 222 <tr>
 223     <td width="15%" align="right" valign="top" class="summary">
 224       <span class="summary-type">&nbsp;</span>
 225     </td><td class="summary">
 226         <a name="xslt_profile"></a><span class="summary-name">xslt_profile</span><br />
 227       Return an ElementTree with profiling data for the stylesheet run.
 228     </td>
 229   </tr>
 230   <tr>
 231     <td colspan="2" class="summary">
 232     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._ElementTree-class.html" onclick="show_private();">_ElementTree</a></code></b>:
 233       <code><a href="lxml.etree._ElementTree-class.html#docinfo">docinfo</a></code>,
 234       <code><a href="lxml.etree._ElementTree-class.html#parser">parser</a></code>
 235       </p>
 236     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 237       <code>__class__</code>
 238       </p>
 239     </td>
 240   </tr>
 241 </table>
 242 <!-- ==================== METHOD DETAILS ==================== -->
 243 <a name="section-MethodDetails"></a>
 244 <table class="details" border="1" cellpadding="3"
 245        cellspacing="0" width="100%" bgcolor="white">
 246 <tr bgcolor="#70b0f0" class="table-header">
 247   <td colspan="2" class="table-header">
 248     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 249       <tr valign="top">
 250         <td align="left"><span class="table-header">Method Details</span></td>
 251         <td align="right" valign="top"
 252          ><span class="options">[<a href="#section-MethodDetails"
 253          class="privatelink" onclick="toggle_private();"
 254          >hide private</a>]</span></td>
 255       </tr>
 256     </table>
 257   </td>
 258 </tr>
 259 </table>
 260 <a name="__new__"></a>
 261 <div>
 262 <table class="details" border="1" cellpadding="3"
 263        cellspacing="0" width="100%" bgcolor="white">
 264 <tr><td>
 265   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 266   <tr valign="top"><td>
 267   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 268         <span class="sig-arg">S</span>,
 269         <span class="sig-arg">...</span>)</span>
 270   </h3>
 271   </td><td align="right" valign="top"
 272     >&nbsp;
 273     </td>
 274   </tr></table>
 275
 276
 277   <dl class="fields">
 278     <dt>Returns: a new object with type S, a subtype of T</dt>
 279     <dt>Overrides:
 280         object.__new__
 281     </dt>
 282   </dl>
 283 </td></tr></table>
 284 </div>
 285 <a name="__str__"></a>
 286 <div>
 287 <table class="details" border="1" cellpadding="3"
 288        cellspacing="0" width="100%" bgcolor="white">
 289 <tr><td>
 290   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 291   <tr valign="top"><td>
 292   <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">x</span>)</span>
 293     <br /><em class="fname">(Informal representation operator)</em>
 294   </h3>
 295   </td><td align="right" valign="top"
 296     >&nbsp;
 297     </td>
 298   </tr></table>
 299
 300   str(x)
 301   <dl class="fields">
 302     <dt>Overrides:
 303         object.__str__
 304     </dt>
 305   </dl>
 306 </td></tr></table>
 307 </div>
 308 <a name="write_output"></a>
 309 <div>
 310 <table class="details" border="1" cellpadding="3"
 311        cellspacing="0" width="100%" bgcolor="white">
 312 <tr><td>
 313   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 314   <tr valign="top"><td>
 315   <h3 class="epydoc"><span class="sig"><span class="sig-name">write_output</span>(<span class="sig-arg">...</span>)</span>
 316   </h3>
 317   </td><td align="right" valign="top"
 318     >&nbsp;
 319     </td>
 320   </tr></table>
 321
 322   <p>write_output(self, file, <a href="#id1"><span class="rst-problematic" id="rst-rst-id2">*</span></a>, compression=0)</p>
 323 <p>Serialise the XSLT output to a file or file-like object.</p>
 324 <p>As opposed to the generic <tt class="rst-docutils literal">.write()</tt> method, <tt class="rst-docutils literal">.write_output()</tt> serialises
 325 the result as defined by the <tt class="rst-docutils literal">&lt;xsl:output&gt;</tt> tag.</p>
 326   <dl class="fields">
 327   </dl>
 328 </td></tr></table>
 329 </div>
 330 <br />
 331 <!-- ==================== NAVIGATION BAR ==================== -->
 332 <table class="navbar" border="0" width="100%" cellpadding="0"
 333        bgcolor="#a0c0ff" cellspacing="0">
 334   <tr valign="middle">
 335   <!-- Home link -->
 336       <th>&nbsp;&nbsp;&nbsp;<a
 337         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 338
 339   <!-- Tree link -->
 340       <th>&nbsp;&nbsp;&nbsp;<a
 341         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 342
 343   <!-- Index link -->
 344       <th>&nbsp;&nbsp;&nbsp;<a
 345         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 346
 347   <!-- Help link -->
 348       <th>&nbsp;&nbsp;&nbsp;<a
 349         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 350
 351   <!-- Project homepage -->
 352       <th class="navbar" align="right" width="100%">
 353         <table border="0" cellpadding="0" cellspacing="0">
 354           <tr><th class="navbar" align="center"
 355             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 356           </tr></table></th>
 357   </tr>
 358 </table>
 359 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 360   <tr>
 361     <td align="left" class="footer">
 362     Generated by Epydoc 3.0.1
 363     on Wed Jan 29 12:26:21 2020
 364     </td>
 365     <td align="right" class="footer">
 366       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 367         >http://epydoc.sourceforge.net</a>
 368     </td>
 369   </tr>
 370 </table>
 371
 372 <script type="text/javascript">
 373   <!--
 374   // Private objects are initially displayed (because if
 375   // javascript is turned off then we want them to be
 376   // visible); but by default, we want to hide them.  So hide
 377   // them unless we have a cookie that says to show them.
 378   checkCookie();
 379   // -->
 380 </script>
 381 </body>
 382 </html>