doc/html/api/lxml.html.ElementSoup-module.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.html.ElementSoup</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.html-module.html">Package&nbsp;html</a> ::
  47         Module&nbsp;ElementSoup
  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.html.ElementSoup-module.html"
  58             target="_top">no&nbsp;frames</a>]</span></td></tr>
  59       </table>
  60     </td>
  61   </tr>
  62 </table>
  63 <!-- ==================== MODULE DESCRIPTION ==================== -->
  64 <h1 class="epydoc">Module ElementSoup</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.html.ElementSoup-pysrc.html">source&nbsp;code</a></span></p>
  65 Legacy interface to the BeautifulSoup HTML parser.
  66
  67 <!-- ==================== FUNCTIONS ==================== -->
  68 <a name="section-Functions"></a>
  69 <table class="summary" border="1" cellpadding="3"
  70        cellspacing="0" width="100%" bgcolor="white">
  71 <tr bgcolor="#70b0f0" class="table-header">
  72   <td colspan="2" class="table-header">
  73     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  74       <tr valign="top">
  75         <td align="left"><span class="table-header">Functions</span></td>
  76         <td align="right" valign="top"
  77          ><span class="options">[<a href="#section-Functions"
  78          class="privatelink" onclick="toggle_private();"
  79          >hide private</a>]</span></td>
  80       </tr>
  81     </table>
  82   </td>
  83 </tr>
  84 <tr>
  85     <td width="15%" align="right" valign="top" class="summary">
  86       <span class="summary-type">&nbsp;</span>
  87     </td><td class="summary">
  88       <table width="100%" cellpadding="0" cellspacing="0" border="0">
  89         <tr>
  90           <td><span class="summary-sig"><a href="lxml.html.ElementSoup-module.html#convert_tree" class="summary-sig-name">convert_tree</a>(<span class="summary-sig-arg">beautiful_soup_tree</span>,
  91         <span class="summary-sig-arg">makeelement</span>=<span class="summary-sig-default">None</span>)</span><br />
  92       Convert a BeautifulSoup tree to a list of Element trees.</td>
  93           <td align="right" valign="top">
  94             <span class="codelink"><a href="lxml.html.soupparser-pysrc.html#convert_tree">source&nbsp;code</a></span>
  95
  96           </td>
  97         </tr>
  98       </table>
  99
 100     </td>
 101   </tr>
 102 <tr>
 103     <td width="15%" align="right" valign="top" class="summary">
 104       <span class="summary-type">&nbsp;</span>
 105     </td><td class="summary">
 106       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 107         <tr>
 108           <td><span class="summary-sig"><a name="parse"></a><span class="summary-sig-name">parse</span>(<span class="summary-sig-arg">file</span>,
 109         <span class="summary-sig-arg">beautifulsoup</span>=<span class="summary-sig-default">None</span>,
 110         <span class="summary-sig-arg">makeelement</span>=<span class="summary-sig-default">None</span>)</span></td>
 111           <td align="right" valign="top">
 112             <span class="codelink"><a href="lxml.html.ElementSoup-pysrc.html#parse">source&nbsp;code</a></span>
 113
 114           </td>
 115         </tr>
 116       </table>
 117
 118     </td>
 119   </tr>
 120 </table>
 121 <!-- ==================== VARIABLES ==================== -->
 122 <a name="section-Variables"></a>
 123 <table class="summary" border="1" cellpadding="3"
 124        cellspacing="0" width="100%" bgcolor="white">
 125 <tr bgcolor="#70b0f0" class="table-header">
 126   <td colspan="2" class="table-header">
 127     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 128       <tr valign="top">
 129         <td align="left"><span class="table-header">Variables</span></td>
 130         <td align="right" valign="top"
 131          ><span class="options">[<a href="#section-Variables"
 132          class="privatelink" onclick="toggle_private();"
 133          >hide private</a>]</span></td>
 134       </tr>
 135     </table>
 136   </td>
 137 </tr>
 138 <tr class="private">
 139     <td width="15%" align="right" valign="top" class="summary">
 140       <span class="summary-type">&nbsp;</span>
 141     </td><td class="summary">
 142         <a href="lxml.html.ElementSoup-module.html#__doc__" class="summary-name" onclick="show_private();">__doc__</a> = <code title="&quot;&quot;&quot;Legacy interface to the BeautifulSoup HTML parser.
 143 &quot;&quot;&quot;">&quot;&quot;&quot;Legacy interface to the BeautifulSoup HTML pars<code class="variable-ellipsis">...</code></code>
 144     </td>
 145   </tr>
 146 <tr class="private">
 147     <td width="15%" align="right" valign="top" class="summary">
 148       <span class="summary-type">&nbsp;</span>
 149     </td><td class="summary">
 150         <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'lxml.html'"><code class="variable-quote">'</code><code class="variable-string">lxml.html</code><code class="variable-quote">'</code></code>
 151     </td>
 152   </tr>
 153 </table>
 154 <!-- ==================== FUNCTION DETAILS ==================== -->
 155 <a name="section-FunctionDetails"></a>
 156 <table class="details" border="1" cellpadding="3"
 157        cellspacing="0" width="100%" bgcolor="white">
 158 <tr bgcolor="#70b0f0" class="table-header">
 159   <td colspan="2" class="table-header">
 160     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 161       <tr valign="top">
 162         <td align="left"><span class="table-header">Function Details</span></td>
 163         <td align="right" valign="top"
 164          ><span class="options">[<a href="#section-FunctionDetails"
 165          class="privatelink" onclick="toggle_private();"
 166          >hide private</a>]</span></td>
 167       </tr>
 168     </table>
 169   </td>
 170 </tr>
 171 </table>
 172 <a name="convert_tree"></a>
 173 <div>
 174 <table class="details" border="1" cellpadding="3"
 175        cellspacing="0" width="100%" bgcolor="white">
 176 <tr><td>
 177   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 178   <tr valign="top"><td>
 179   <h3 class="epydoc"><span class="sig"><span class="sig-name">convert_tree</span>(<span class="sig-arg">beautiful_soup_tree</span>,
 180         <span class="sig-arg">makeelement</span>=<span class="sig-default">None</span>)</span>
 181   </h3>
 182   </td><td align="right" valign="top"
 183     ><span class="codelink"><a href="lxml.html.soupparser-pysrc.html#convert_tree">source&nbsp;code</a></span>&nbsp;
 184     </td>
 185   </tr></table>
 186
 187   <p>Convert a BeautifulSoup tree to a list of Element trees.</p>
 188 <p>Returns a list instead of a single root Element to support
 189 HTML-like soup with more than one root element.</p>
 190 <p>You can pass a different Element factory through the <code class="link">makeelement</code>
 191 keyword.</p>
 192   <dl class="fields">
 193   </dl>
 194 </td></tr></table>
 195 </div>
 196 <br />
 197 <!-- ==================== VARIABLES DETAILS ==================== -->
 198 <a name="section-VariablesDetails"></a>
 199 <table class="details" border="1" cellpadding="3"
 200        cellspacing="0" width="100%" bgcolor="white">
 201 <tr bgcolor="#70b0f0" class="table-header">
 202   <td colspan="2" class="table-header">
 203     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 204       <tr valign="top">
 205         <td align="left"><span class="table-header">Variables Details</span></td>
 206         <td align="right" valign="top"
 207          ><span class="options">[<a href="#section-VariablesDetails"
 208          class="privatelink" onclick="toggle_private();"
 209          >hide private</a>]</span></td>
 210       </tr>
 211     </table>
 212   </td>
 213 </tr>
 214 </table>
 215 <a name="__doc__"></a>
 216 <div class="private">
 217 <table class="details" border="1" cellpadding="3"
 218        cellspacing="0" width="100%" bgcolor="white">
 219 <tr><td>
 220   <h3 class="epydoc">__doc__</h3>
 221
 222   <dl class="fields">
 223   </dl>
 224   <dl class="fields">
 225     <dt>Value:</dt>
 226       <dd><table><tr><td><pre class="variable">
 227 &quot;&quot;&quot;Legacy interface to the BeautifulSoup HTML parser.
 228 &quot;&quot;&quot;
 229 </pre></td></tr></table>
 230 </dd>
 231   </dl>
 232 </td></tr></table>
 233 </div>
 234 <br />
 235 <!-- ==================== NAVIGATION BAR ==================== -->
 236 <table class="navbar" border="0" width="100%" cellpadding="0"
 237        bgcolor="#a0c0ff" cellspacing="0">
 238   <tr valign="middle">
 239   <!-- Home link -->
 240       <th>&nbsp;&nbsp;&nbsp;<a
 241         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 242
 243   <!-- Tree link -->
 244       <th>&nbsp;&nbsp;&nbsp;<a
 245         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 246
 247   <!-- Index link -->
 248       <th>&nbsp;&nbsp;&nbsp;<a
 249         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 250
 251   <!-- Help link -->
 252       <th>&nbsp;&nbsp;&nbsp;<a
 253         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 254
 255   <!-- Project homepage -->
 256       <th class="navbar" align="right" width="100%">
 257         <table border="0" cellpadding="0" cellspacing="0">
 258           <tr><th class="navbar" align="center"
 259             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 260           </tr></table></th>
 261   </tr>
 262 </table>
 263 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 264   <tr>
 265     <td align="left" class="footer">
 266     Generated by Epydoc 3.0.1
 267     on Thu Jul  9 18:29:53 2020
 268     </td>
 269     <td align="right" class="footer">
 270       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 271         >http://epydoc.sourceforge.net</a>
 272     </td>
 273   </tr>
 274 </table>
 275
 276 <script type="text/javascript">
 277   <!--
 278   // Private objects are initially displayed (because if
 279   // javascript is turned off then we want them to be
 280   // visible); but by default, we want to hide them.  So hide
 281   // them unless we have a cookie that says to show them.
 282   checkCookie();
 283   // -->
 284 </script>
 285 </body>
 286 </html>