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">
6 <title>lxml.etree.XMLPullParser</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
18 <th> <a
19 href="lxml-module.html">Home</a> </th>
22 <th> <a
23 href="module-tree.html">Trees</a> </th>
26 <th> <a
27 href="identifier-index.html">Indices</a> </th>
30 <th> <a
31 href="help.html">Help</a> </th>
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>
41 <table width="100%" cellpadding="0" cellspacing="0">
44 <span class="breadcrumbs">
45 <a href="lxml-module.html">Package lxml</a> ::
46 <a href="lxml.etree-module.html">Module etree</a> ::
47 Class XMLPullParser
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 private</a>]</span></td></tr>
55 <tr><td align="right"><span class="options"
56 >[<a href="frames.html" target="_top">frames</a
57 >] | <a href="lxml.etree.XMLPullParser-class.html"
58 target="_top">no frames</a>]</span></td></tr>
63 <!-- ==================== CLASS DESCRIPTION ==================== -->
64 <h1 class="epydoc">Class XMLPullParser</h1><p class="nomargin-top"></p>
65 <pre class="base-tree">
70 <a href="lxml.etree._FeedParser-class.html" onclick="show_private();">_FeedParser</a> --+
72 <a href="lxml.etree.XMLParser-class.html">XMLParser</a> --+
74 <strong class="uidshort">XMLPullParser</strong>
78 <p>XMLPullParser(self, events=None, <a href="#id1"><span class="rst-problematic" id="rst-rst-rst-id2">*</span></a>, tag=None, <a href="#id3"><span class="rst-problematic" id="rst-rst-rst-id4">**</span></a>kwargs)</p>
79 <p>XML parser that collects parse events in an iterator.</p>
80 <p>The collected events are the same as for iterparse(), but the
81 parser itself is non-blocking in the sense that it receives
82 data chunks incrementally through its .feed() method, instead
83 of reading them directly from a file(-like) object all by itself.</p>
84 <p>By default, it collects Element end events. To change that,
85 pass any subset of the available events into the <tt class="rst-docutils literal">events</tt>
86 argument: <tt class="rst-docutils literal">'start'</tt>, <tt class="rst-docutils literal">'end'</tt>, <tt class="rst-docutils literal"><span class="pre">'start-ns'</span></tt>,
87 <tt class="rst-docutils literal"><span class="pre">'end-ns'</span></tt>, <tt class="rst-docutils literal">'comment'</tt>, <tt class="rst-docutils literal">'pi'</tt>.</p>
88 <p>To support loading external dependencies relative to the input
89 source, you can pass the <tt class="rst-docutils literal">base_url</tt>.</p>
91 <!-- ==================== INSTANCE METHODS ==================== -->
92 <a name="section-InstanceMethods"></a>
93 <table class="summary" border="1" cellpadding="3"
94 cellspacing="0" width="100%" bgcolor="white">
95 <tr bgcolor="#70b0f0" class="table-header">
96 <td colspan="2" class="table-header">
97 <table border="0" cellpadding="0" cellspacing="0" width="100%">
99 <td align="left"><span class="table-header">Instance Methods</span></td>
100 <td align="right" valign="top"
101 ><span class="options">[<a href="#section-InstanceMethods"
102 class="privatelink" onclick="toggle_private();"
103 >hide private</a>]</span></td>
109 <td width="15%" align="right" valign="top" class="summary">
110 <span class="summary-type"> </span>
111 </td><td class="summary">
112 <table width="100%" cellpadding="0" cellspacing="0" border="0">
114 <td><span class="summary-sig"><a href="lxml.etree.XMLPullParser-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
115 <span class="summary-sig-arg">events</span>=<span class="summary-sig-default">None</span>,
116 <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">None</span>,
117 <span class="summary-sig-arg">*</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">
130 <td width="15%" align="right" valign="top" class="summary">
131 <span class="summary-type">a new object with type S, a subtype of T</span>
132 </td><td class="summary">
133 <table width="100%" cellpadding="0" cellspacing="0" border="0">
135 <td><span class="summary-sig"><a href="lxml.etree.XMLPullParser-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
136 <span class="summary-sig-arg">S</span>,
137 <span class="summary-sig-arg">...</span>)</span></td>
138 <td align="right" valign="top">
148 <td width="15%" align="right" valign="top" class="summary">
149 <span class="summary-type"> </span>
150 </td><td class="summary">
151 <table width="100%" cellpadding="0" cellspacing="0" border="0">
153 <td><span class="summary-sig"><a name="read_events"></a><span class="summary-sig-name">read_events</span>(<span class="summary-sig-arg">...</span>)</span></td>
154 <td align="right" valign="top">
164 <td colspan="2" class="summary">
165 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._FeedParser-class.html" onclick="show_private();">_FeedParser</a></code></b>:
166 <code><a href="lxml.etree._FeedParser-class.html#close">close</a></code>,
167 <code><a href="lxml.etree._FeedParser-class.html#feed">feed</a></code>
169 <p class="indent-wrapped-lines"><b>Inherited from <code><i>unreachable</i>._BaseParser</code></b>:
171 <code>makeelement</code>,
172 <code>setElementClassLookup</code>,
173 <code>set_element_class_lookup</code>
175 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
176 <code>__delattr__</code>,
177 <code>__format__</code>,
178 <code>__getattribute__</code>,
179 <code>__hash__</code>,
180 <code>__reduce__</code>,
181 <code>__reduce_ex__</code>,
182 <code>__repr__</code>,
183 <code>__setattr__</code>,
184 <code>__sizeof__</code>,
185 <code>__str__</code>,
186 <code>__subclasshook__</code>
191 <!-- ==================== PROPERTIES ==================== -->
192 <a name="section-Properties"></a>
193 <table class="summary" border="1" cellpadding="3"
194 cellspacing="0" width="100%" bgcolor="white">
195 <tr bgcolor="#70b0f0" class="table-header">
196 <td colspan="2" class="table-header">
197 <table border="0" cellpadding="0" cellspacing="0" width="100%">
199 <td align="left"><span class="table-header">Properties</span></td>
200 <td align="right" valign="top"
201 ><span class="options">[<a href="#section-Properties"
202 class="privatelink" onclick="toggle_private();"
203 >hide private</a>]</span></td>
209 <td colspan="2" class="summary">
210 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._FeedParser-class.html" onclick="show_private();">_FeedParser</a></code></b>:
211 <code><a href="lxml.etree._FeedParser-class.html#feed_error_log">feed_error_log</a></code>
213 <p class="indent-wrapped-lines"><b>Inherited from <code><i>unreachable</i>._BaseParser</code></b>:
214 <code>error_log</code>,
215 <code>resolvers</code>,
219 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
220 <code>__class__</code>
225 <!-- ==================== METHOD DETAILS ==================== -->
226 <a name="section-MethodDetails"></a>
227 <table class="details" border="1" cellpadding="3"
228 cellspacing="0" width="100%" bgcolor="white">
229 <tr bgcolor="#70b0f0" class="table-header">
230 <td colspan="2" class="table-header">
231 <table border="0" cellpadding="0" cellspacing="0" width="100%">
233 <td align="left"><span class="table-header">Method Details</span></td>
234 <td align="right" valign="top"
235 ><span class="options">[<a href="#section-MethodDetails"
236 class="privatelink" onclick="toggle_private();"
237 >hide private</a>]</span></td>
243 <a name="__init__"></a>
245 <table class="details" border="1" cellpadding="3"
246 cellspacing="0" width="100%" bgcolor="white">
248 <table width="100%" cellpadding="0" cellspacing="0" border="0">
249 <tr valign="top"><td>
250 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
251 <span class="sig-arg">events</span>=<span class="sig-default">None</span>,
252 <span class="sig-arg">tag</span>=<span class="sig-default">None</span>,
253 <span class="sig-arg">*</span>,
254 <span class="sig-arg">**kwargs</span>)</span>
255 <br /><em class="fname">(Constructor)</em>
257 </td><td align="right" valign="top"
262 x.__init__(...) initializes x; see help(type(x)) for signature
270 <a name="__new__"></a>
272 <table class="details" border="1" cellpadding="3"
273 cellspacing="0" width="100%" bgcolor="white">
275 <table width="100%" cellpadding="0" cellspacing="0" border="0">
276 <tr valign="top"><td>
277 <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
278 <span class="sig-arg">S</span>,
279 <span class="sig-arg">...</span>)</span>
281 </td><td align="right" valign="top"
288 <dt>Returns: a new object with type S, a subtype of T</dt>
296 <!-- ==================== NAVIGATION BAR ==================== -->
297 <table class="navbar" border="0" width="100%" cellpadding="0"
298 bgcolor="#a0c0ff" cellspacing="0">
301 <th> <a
302 href="lxml-module.html">Home</a> </th>
305 <th> <a
306 href="module-tree.html">Trees</a> </th>
309 <th> <a
310 href="identifier-index.html">Indices</a> </th>
313 <th> <a
314 href="help.html">Help</a> </th>
316 <!-- Project homepage -->
317 <th class="navbar" align="right" width="100%">
318 <table border="0" cellpadding="0" cellspacing="0">
319 <tr><th class="navbar" align="center"
320 ><a class="navbar" target="_top" href="/">lxml API</a></th>
324 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
326 <td align="left" class="footer">
327 Generated by Epydoc 3.0.1
328 on Thu Jul 9 18:29:53 2020
330 <td align="right" class="footer">
331 <a target="mainFrame" href="http://epydoc.sourceforge.net"
332 >http://epydoc.sourceforge.net</a>
337 <script type="text/javascript">
339 // Private objects are initially displayed (because if
340 // javascript is turned off then we want them to be
341 // visible); but by default, we want to hide them. So hide
342 // them unless we have a cookie that says to show them.