doc/html/api/lxml.etree.TreeBuilder-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.TreeBuilder</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;TreeBuilder
  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.TreeBuilder-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 TreeBuilder</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66       object --+
  67                |
  68 <a href="lxml.etree._SaxParserTarget-class.html" onclick="show_private();">_SaxParserTarget</a> --+
  69                    |
  70                   <strong class="uidshort">TreeBuilder</strong>
  71 </pre>
  72
  73 <hr />
  74 <p>TreeBuilder(self, element_factory=None, parser=None)
  75 Parser target that builds a tree.</p>
  76 <p>The final tree is returned by the <tt class="rst-docutils literal">close()</tt> method.</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">&nbsp;</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.TreeBuilder-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 102         <span class="summary-sig-arg">element_factory</span>=<span class="summary-sig-default">None</span>,
 103         <span class="summary-sig-arg">parser</span>=<span class="summary-sig-default">None</span>)</span><br />
 104       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 105           <td align="right" valign="top">
 106
 107
 108           </td>
 109         </tr>
 110       </table>
 111
 112     </td>
 113   </tr>
 114 <tr>
 115     <td width="15%" align="right" valign="top" class="summary">
 116       <span class="summary-type">a new object with type S, a subtype of T</span>
 117     </td><td class="summary">
 118       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 119         <tr>
 120           <td><span class="summary-sig"><a href="lxml.etree.TreeBuilder-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 121         <span class="summary-sig-arg">S</span>,
 122         <span class="summary-sig-arg">...</span>)</span></td>
 123           <td align="right" valign="top">
 124
 125
 126           </td>
 127         </tr>
 128       </table>
 129
 130     </td>
 131   </tr>
 132 <tr>
 133     <td width="15%" align="right" valign="top" class="summary">
 134       <span class="summary-type">&nbsp;</span>
 135     </td><td class="summary">
 136       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 137         <tr>
 138           <td><span class="summary-sig"><a name="close"></a><span class="summary-sig-name">close</span>(<span class="summary-sig-arg">self</span>)</span><br />
 139       Flushes the builder buffers, and returns the toplevel document
 140 element.</td>
 141           <td align="right" valign="top">
 142
 143
 144           </td>
 145         </tr>
 146       </table>
 147
 148     </td>
 149   </tr>
 150 <tr>
 151     <td width="15%" align="right" valign="top" class="summary">
 152       <span class="summary-type">&nbsp;</span>
 153     </td><td class="summary">
 154       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 155         <tr>
 156           <td><span class="summary-sig"><a name="comment"></a><span class="summary-sig-name">comment</span>(<span class="summary-sig-arg">self</span>,
 157         <span class="summary-sig-arg">comment</span>)</span></td>
 158           <td align="right" valign="top">
 159
 160
 161           </td>
 162         </tr>
 163       </table>
 164
 165     </td>
 166   </tr>
 167 <tr>
 168     <td width="15%" align="right" valign="top" class="summary">
 169       <span class="summary-type">&nbsp;</span>
 170     </td><td class="summary">
 171       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 172         <tr>
 173           <td><span class="summary-sig"><a name="data"></a><span class="summary-sig-name">data</span>(<span class="summary-sig-arg">self</span>,
 174         <span class="summary-sig-arg">data</span>)</span><br />
 175       Adds text to the current element.  The value should be either an
 176 8-bit string containing ASCII text, or a Unicode string.</td>
 177           <td align="right" valign="top">
 178
 179
 180           </td>
 181         </tr>
 182       </table>
 183
 184     </td>
 185   </tr>
 186 <tr>
 187     <td width="15%" align="right" valign="top" class="summary">
 188       <span class="summary-type">&nbsp;</span>
 189     </td><td class="summary">
 190       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 191         <tr>
 192           <td><span class="summary-sig"><a name="end"></a><span class="summary-sig-name">end</span>(<span class="summary-sig-arg">self</span>,
 193         <span class="summary-sig-arg">tag</span>)</span><br />
 194       Closes the current element.</td>
 195           <td align="right" valign="top">
 196
 197
 198           </td>
 199         </tr>
 200       </table>
 201
 202     </td>
 203   </tr>
 204 <tr>
 205     <td width="15%" align="right" valign="top" class="summary">
 206       <span class="summary-type">&nbsp;</span>
 207     </td><td class="summary">
 208       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 209         <tr>
 210           <td><span class="summary-sig"><a name="pi"></a><span class="summary-sig-name">pi</span>(<span class="summary-sig-arg">self</span>,
 211         <span class="summary-sig-arg">target</span>,
 212         <span class="summary-sig-arg">data</span>)</span></td>
 213           <td align="right" valign="top">
 214
 215
 216           </td>
 217         </tr>
 218       </table>
 219
 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       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 227         <tr>
 228           <td><span class="summary-sig"><a name="start"></a><span class="summary-sig-name">start</span>(<span class="summary-sig-arg">self</span>,
 229         <span class="summary-sig-arg">tag</span>,
 230         <span class="summary-sig-arg">attrs</span>,
 231         <span class="summary-sig-arg">nsmap</span>=<span class="summary-sig-default">None</span>)</span><br />
 232       Opens a new element.</td>
 233           <td align="right" valign="top">
 234
 235
 236           </td>
 237         </tr>
 238       </table>
 239
 240     </td>
 241   </tr>
 242   <tr>
 243     <td colspan="2" class="summary">
 244     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 245       <code>__delattr__</code>,
 246       <code>__format__</code>,
 247       <code>__getattribute__</code>,
 248       <code>__hash__</code>,
 249       <code>__reduce__</code>,
 250       <code>__reduce_ex__</code>,
 251       <code>__repr__</code>,
 252       <code>__setattr__</code>,
 253       <code>__sizeof__</code>,
 254       <code>__str__</code>,
 255       <code>__subclasshook__</code>
 256       </p>
 257     </td>
 258   </tr>
 259 </table>
 260 <!-- ==================== PROPERTIES ==================== -->
 261 <a name="section-Properties"></a>
 262 <table class="summary" border="1" cellpadding="3"
 263        cellspacing="0" width="100%" bgcolor="white">
 264 <tr bgcolor="#70b0f0" class="table-header">
 265   <td colspan="2" class="table-header">
 266     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 267       <tr valign="top">
 268         <td align="left"><span class="table-header">Properties</span></td>
 269         <td align="right" valign="top"
 270          ><span class="options">[<a href="#section-Properties"
 271          class="privatelink" onclick="toggle_private();"
 272          >hide private</a>]</span></td>
 273       </tr>
 274     </table>
 275   </td>
 276 </tr>
 277   <tr>
 278     <td colspan="2" class="summary">
 279     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 280       <code>__class__</code>
 281       </p>
 282     </td>
 283   </tr>
 284 </table>
 285 <!-- ==================== METHOD DETAILS ==================== -->
 286 <a name="section-MethodDetails"></a>
 287 <table class="details" border="1" cellpadding="3"
 288        cellspacing="0" width="100%" bgcolor="white">
 289 <tr bgcolor="#70b0f0" class="table-header">
 290   <td colspan="2" class="table-header">
 291     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 292       <tr valign="top">
 293         <td align="left"><span class="table-header">Method Details</span></td>
 294         <td align="right" valign="top"
 295          ><span class="options">[<a href="#section-MethodDetails"
 296          class="privatelink" onclick="toggle_private();"
 297          >hide private</a>]</span></td>
 298       </tr>
 299     </table>
 300   </td>
 301 </tr>
 302 </table>
 303 <a name="__init__"></a>
 304 <div>
 305 <table class="details" border="1" cellpadding="3"
 306        cellspacing="0" width="100%" bgcolor="white">
 307 <tr><td>
 308   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 309   <tr valign="top"><td>
 310   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 311         <span class="sig-arg">element_factory</span>=<span class="sig-default">None</span>,
 312         <span class="sig-arg">parser</span>=<span class="sig-default">None</span>)</span>
 313     <br /><em class="fname">(Constructor)</em>
 314   </h3>
 315   </td><td align="right" valign="top"
 316     >&nbsp;
 317     </td>
 318   </tr></table>
 319
 320   x.__init__(...) initializes x; see help(type(x)) for signature
 321   <dl class="fields">
 322     <dt>Overrides:
 323         object.__init__
 324     </dt>
 325   </dl>
 326 </td></tr></table>
 327 </div>
 328 <a name="__new__"></a>
 329 <div>
 330 <table class="details" border="1" cellpadding="3"
 331        cellspacing="0" width="100%" bgcolor="white">
 332 <tr><td>
 333   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 334   <tr valign="top"><td>
 335   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 336         <span class="sig-arg">S</span>,
 337         <span class="sig-arg">...</span>)</span>
 338   </h3>
 339   </td><td align="right" valign="top"
 340     >&nbsp;
 341     </td>
 342   </tr></table>
 343
 344
 345   <dl class="fields">
 346     <dt>Returns: a new object with type S, a subtype of T</dt>
 347     <dt>Overrides:
 348         object.__new__
 349     </dt>
 350   </dl>
 351 </td></tr></table>
 352 </div>
 353 <br />
 354 <!-- ==================== NAVIGATION BAR ==================== -->
 355 <table class="navbar" border="0" width="100%" cellpadding="0"
 356        bgcolor="#a0c0ff" cellspacing="0">
 357   <tr valign="middle">
 358   <!-- Home link -->
 359       <th>&nbsp;&nbsp;&nbsp;<a
 360         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 361
 362   <!-- Tree link -->
 363       <th>&nbsp;&nbsp;&nbsp;<a
 364         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 365
 366   <!-- Index link -->
 367       <th>&nbsp;&nbsp;&nbsp;<a
 368         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 369
 370   <!-- Help link -->
 371       <th>&nbsp;&nbsp;&nbsp;<a
 372         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 373
 374   <!-- Project homepage -->
 375       <th class="navbar" align="right" width="100%">
 376         <table border="0" cellpadding="0" cellspacing="0">
 377           <tr><th class="navbar" align="center"
 378             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 379           </tr></table></th>
 380   </tr>
 381 </table>
 382 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 383   <tr>
 384     <td align="left" class="footer">
 385     Generated by Epydoc 3.0.1 on Fri Sep 28 21:20:56 2012
 386     </td>
 387     <td align="right" class="footer">
 388       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 389         >http://epydoc.sourceforge.net</a>
 390     </td>
 391   </tr>
 392 </table>
 393
 394 <script type="text/javascript">
 395   <!--
 396   // Private objects are initially displayed (because if
 397   // javascript is turned off then we want them to be
 398   // visible); but by default, we want to hide them.  So hide
 399   // them unless we have a cookie that says to show them.
 400   checkCookie();
 401   // -->
 402 </script>
 403 </body>
 404 </html>