4520c9ce682caa4dff6dbad82734bec33b5c6d73
[platform/upstream/python-lxml.git] / doc / html / api / lxml.html.XHTMLParser-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.html.XHTMLParser</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         lxml ::
46         html ::
47         XHTMLParser ::
48         Class&nbsp;XHTMLParser
49       </span>
50     </td>
51     <td>
52       <table cellpadding="0" cellspacing="0">
53         <!-- hide/show private -->
54         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
55     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
56         <tr><td align="right"><span class="options"
57             >[<a href="frames.html" target="_top">frames</a
58             >]&nbsp;|&nbsp;<a href="lxml.html.XHTMLParser-class.html"
59             target="_top">no&nbsp;frames</a>]</span></td></tr>
60       </table>
61     </td>
62   </tr>
63 </table>
64 <!-- ==================== CLASS DESCRIPTION ==================== -->
65 <h1 class="epydoc">Class XHTMLParser</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.html-pysrc.html#XHTMLParser">source&nbsp;code</a></span></p>
66 <pre class="base-tree">
67     object --+            
68              |            
69 ??._BaseParser --+        
70                  |        
71  <a href="lxml.etree._FeedParser-class.html" onclick="show_private();">etree._FeedParser</a> --+    
72                      |    
73        <a href="lxml.etree.XMLParser-class.html">etree.XMLParser</a> --+
74                          |
75                         <strong class="uidshort">XHTMLParser</strong>
76 </pre>
77
78 <hr />
79 <p>An XML parser that is configured to return lxml.html Element
80 objects.</p>
81 <p>Note that this parser is not really XHTML aware unless you let it
82 load a DTD that declares the HTML entities.  To do this, make sure
83 you have the XHTML DTDs installed in your catalogs, and create the
84 parser like this:</p>
85 <pre class="rst-literal-block">
86 &gt;&gt;&gt; parser = XHTMLParser(load_dtd=True)
87 </pre>
88 <p>If you additionally want to validate the document, use this:</p>
89 <pre class="rst-literal-block">
90 &gt;&gt;&gt; parser = XHTMLParser(dtd_validation=True)
91 </pre>
92 <p>For catalog support, see <a class="rst-reference external" href="http://www.xmlsoft.org/catalog.html" target="_top">http://www.xmlsoft.org/catalog.html</a>.</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.html.XHTMLParser-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
118         <span class="summary-sig-arg">**kwargs</span>)</span><br />
119       x.__init__(...) initializes x; see help(type(x)) for signature</td>
120           <td align="right" valign="top">
121             <span class="codelink"><a href="lxml.html-pysrc.html#XHTMLParser.__init__">source&nbsp;code</a></span>
122             
123           </td>
124         </tr>
125       </table>
126       
127     </td>
128   </tr>
129   <tr>
130     <td colspan="2" class="summary">
131     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.XMLParser-class.html">etree.XMLParser</a></code></b>:
132       <code><a href="lxml.etree.XMLParser-class.html#__new__">__new__</a></code>
133       </p>
134     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._FeedParser-class.html" onclick="show_private();">etree._FeedParser</a></code></b>:
135       <code><a href="lxml.etree._FeedParser-class.html#close">close</a></code>,
136       <code><a href="lxml.etree._FeedParser-class.html#feed">feed</a></code>
137       </p>
138     <p class="indent-wrapped-lines"><b>Inherited from <code><i>unreachable</i>._BaseParser</code></b>:
139       <code>copy</code>,
140       <code>makeelement</code>,
141       <code>setElementClassLookup</code>,
142       <code>set_element_class_lookup</code>
143       </p>
144     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
145       <code>__delattr__</code>,
146       <code>__format__</code>,
147       <code>__getattribute__</code>,
148       <code>__hash__</code>,
149       <code>__reduce__</code>,
150       <code>__reduce_ex__</code>,
151       <code>__repr__</code>,
152       <code>__setattr__</code>,
153       <code>__sizeof__</code>,
154       <code>__str__</code>,
155       <code>__subclasshook__</code>
156       </p>
157     </td>
158   </tr>
159 </table>
160 <!-- ==================== PROPERTIES ==================== -->
161 <a name="section-Properties"></a>
162 <table class="summary" border="1" cellpadding="3"
163        cellspacing="0" width="100%" bgcolor="white">
164 <tr bgcolor="#70b0f0" class="table-header">
165   <td colspan="2" class="table-header">
166     <table border="0" cellpadding="0" cellspacing="0" width="100%">
167       <tr valign="top">
168         <td align="left"><span class="table-header">Properties</span></td>
169         <td align="right" valign="top"
170          ><span class="options">[<a href="#section-Properties"
171          class="privatelink" onclick="toggle_private();"
172          >hide private</a>]</span></td>
173       </tr>
174     </table>
175   </td>
176 </tr>
177   <tr>
178     <td colspan="2" class="summary">
179     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._FeedParser-class.html" onclick="show_private();">etree._FeedParser</a></code></b>:
180       <code><a href="lxml.etree._FeedParser-class.html#feed_error_log">feed_error_log</a></code>
181       </p>
182     <p class="indent-wrapped-lines"><b>Inherited from <code><i>unreachable</i>._BaseParser</code></b>:
183       <code>error_log</code>,
184       <code>resolvers</code>,
185       <code>target</code>,
186       <code>version</code>
187       </p>
188     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
189       <code>__class__</code>
190       </p>
191     </td>
192   </tr>
193 </table>
194 <!-- ==================== METHOD DETAILS ==================== -->
195 <a name="section-MethodDetails"></a>
196 <table class="details" border="1" cellpadding="3"
197        cellspacing="0" width="100%" bgcolor="white">
198 <tr bgcolor="#70b0f0" class="table-header">
199   <td colspan="2" class="table-header">
200     <table border="0" cellpadding="0" cellspacing="0" width="100%">
201       <tr valign="top">
202         <td align="left"><span class="table-header">Method Details</span></td>
203         <td align="right" valign="top"
204          ><span class="options">[<a href="#section-MethodDetails"
205          class="privatelink" onclick="toggle_private();"
206          >hide private</a>]</span></td>
207       </tr>
208     </table>
209   </td>
210 </tr>
211 </table>
212 <a name="__init__"></a>
213 <div>
214 <table class="details" border="1" cellpadding="3"
215        cellspacing="0" width="100%" bgcolor="white">
216 <tr><td>
217   <table width="100%" cellpadding="0" cellspacing="0" border="0">
218   <tr valign="top"><td>
219   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
220         <span class="sig-arg">**kwargs</span>)</span>
221     <br /><em class="fname">(Constructor)</em>
222   </h3>
223   </td><td align="right" valign="top"
224     ><span class="codelink"><a href="lxml.html-pysrc.html#XHTMLParser.__init__">source&nbsp;code</a></span>&nbsp;
225     </td>
226   </tr></table>
227   
228   x.__init__(...) initializes x; see help(type(x)) for signature
229   <dl class="fields">
230     <dt>Overrides:
231         object.__init__
232         <dd><em class="note">(inherited documentation)</em></dd>
233     </dt>
234   </dl>
235 </td></tr></table>
236 </div>
237 <br />
238 <!-- ==================== NAVIGATION BAR ==================== -->
239 <table class="navbar" border="0" width="100%" cellpadding="0"
240        bgcolor="#a0c0ff" cellspacing="0">
241   <tr valign="middle">
242   <!-- Home link -->
243       <th>&nbsp;&nbsp;&nbsp;<a
244         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
245
246   <!-- Tree link -->
247       <th>&nbsp;&nbsp;&nbsp;<a
248         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
249
250   <!-- Index link -->
251       <th>&nbsp;&nbsp;&nbsp;<a
252         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
253
254   <!-- Help link -->
255       <th>&nbsp;&nbsp;&nbsp;<a
256         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
257
258   <!-- Project homepage -->
259       <th class="navbar" align="right" width="100%">
260         <table border="0" cellpadding="0" cellspacing="0">
261           <tr><th class="navbar" align="center"
262             ><a class="navbar" target="_top" href="/">lxml API</a></th>
263           </tr></table></th>
264   </tr>
265 </table>
266 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
267   <tr>
268     <td align="left" class="footer">
269     Generated by Epydoc 3.0.1
270     on Wed Jan 29 12:26:21 2020
271     </td>
272     <td align="right" class="footer">
273       <a target="mainFrame" href="http://epydoc.sourceforge.net"
274         >http://epydoc.sourceforge.net</a>
275     </td>
276   </tr>
277 </table>
278
279 <script type="text/javascript">
280   <!--
281   // Private objects are initially displayed (because if
282   // javascript is turned off then we want them to be
283   // visible); but by default, we want to hide them.  So hide
284   // them unless we have a cookie that says to show them.
285   checkCookie();
286   // -->
287 </script>
288 </body>
289 </html>