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.ElementTextIterator</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 ElementTextIterator
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.ElementTextIterator-class.html"
58 target="_top">no frames</a>]</span></td></tr>
63 <!-- ==================== CLASS DESCRIPTION ==================== -->
64 <h1 class="epydoc">Class ElementTextIterator</h1><p class="nomargin-top"></p>
65 <pre class="base-tree">
68 <strong class="uidshort">ElementTextIterator</strong>
72 <p>ElementTextIterator(self, element, tag=None, with_tail=True)
73 Iterates over the text content of a subtree.</p>
74 <p>You can pass the <tt class="rst-docutils literal">tag</tt> keyword argument to restrict text content to a
75 specific tag name.</p>
76 <p>You can set the <tt class="rst-docutils literal">with_tail</tt> keyword argument to <tt class="rst-docutils literal">False</tt> to skip over
77 tail text (e.g. if you know that it's only whitespace from pretty-printing).</p>
79 <!-- ==================== INSTANCE METHODS ==================== -->
80 <a name="section-InstanceMethods"></a>
81 <table class="summary" border="1" cellpadding="3"
82 cellspacing="0" width="100%" bgcolor="white">
83 <tr bgcolor="#70b0f0" class="table-header">
84 <td colspan="2" class="table-header">
85 <table border="0" cellpadding="0" cellspacing="0" width="100%">
87 <td align="left"><span class="table-header">Instance Methods</span></td>
88 <td align="right" valign="top"
89 ><span class="options">[<a href="#section-InstanceMethods"
90 class="privatelink" onclick="toggle_private();"
91 >hide private</a>]</span></td>
97 <td width="15%" align="right" valign="top" class="summary">
98 <span class="summary-type"> </span>
99 </td><td class="summary">
100 <table width="100%" cellpadding="0" cellspacing="0" border="0">
102 <td><span class="summary-sig"><a name="__iter__"></a><span class="summary-sig-name">__iter__</span>(<span class="summary-sig-arg">x</span>)</span><br />
104 <td align="right" valign="top">
114 <td width="15%" align="right" valign="top" class="summary">
115 <span class="summary-type">a new object with type S, a subtype of T</span>
116 </td><td class="summary">
117 <table width="100%" cellpadding="0" cellspacing="0" border="0">
119 <td><span class="summary-sig"><a href="lxml.etree.ElementTextIterator-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
120 <span class="summary-sig-arg">S</span>,
121 <span class="summary-sig-arg">...</span>)</span></td>
122 <td align="right" valign="top">
132 <td width="15%" align="right" valign="top" class="summary">
133 <span class="summary-type"> </span>
134 </td><td class="summary">
135 <table width="100%" cellpadding="0" cellspacing="0" border="0">
137 <td><span class="summary-sig"><a name="__next__"></a><span class="summary-sig-name">__next__</span>(<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">the next value, or raise StopIteration</span>
150 </td><td class="summary">
151 <table width="100%" cellpadding="0" cellspacing="0" border="0">
153 <td><span class="summary-sig"><a name="next"></a><span class="summary-sig-name">next</span>(<span class="summary-sig-arg">x</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>object</code></b>:
166 <code>__delattr__</code>,
167 <code>__format__</code>,
168 <code>__getattribute__</code>,
169 <code>__hash__</code>,
170 <code>__init__</code>,
171 <code>__reduce__</code>,
172 <code>__reduce_ex__</code>,
173 <code>__repr__</code>,
174 <code>__setattr__</code>,
175 <code>__sizeof__</code>,
176 <code>__str__</code>,
177 <code>__subclasshook__</code>
182 <!-- ==================== PROPERTIES ==================== -->
183 <a name="section-Properties"></a>
184 <table class="summary" border="1" cellpadding="3"
185 cellspacing="0" width="100%" bgcolor="white">
186 <tr bgcolor="#70b0f0" class="table-header">
187 <td colspan="2" class="table-header">
188 <table border="0" cellpadding="0" cellspacing="0" width="100%">
190 <td align="left"><span class="table-header">Properties</span></td>
191 <td align="right" valign="top"
192 ><span class="options">[<a href="#section-Properties"
193 class="privatelink" onclick="toggle_private();"
194 >hide private</a>]</span></td>
200 <td colspan="2" class="summary">
201 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
202 <code>__class__</code>
207 <!-- ==================== METHOD DETAILS ==================== -->
208 <a name="section-MethodDetails"></a>
209 <table class="details" border="1" cellpadding="3"
210 cellspacing="0" width="100%" bgcolor="white">
211 <tr bgcolor="#70b0f0" class="table-header">
212 <td colspan="2" class="table-header">
213 <table border="0" cellpadding="0" cellspacing="0" width="100%">
215 <td align="left"><span class="table-header">Method Details</span></td>
216 <td align="right" valign="top"
217 ><span class="options">[<a href="#section-MethodDetails"
218 class="privatelink" onclick="toggle_private();"
219 >hide private</a>]</span></td>
225 <a name="__new__"></a>
227 <table class="details" border="1" cellpadding="3"
228 cellspacing="0" width="100%" bgcolor="white">
230 <table width="100%" cellpadding="0" cellspacing="0" border="0">
231 <tr valign="top"><td>
232 <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
233 <span class="sig-arg">S</span>,
234 <span class="sig-arg">...</span>)</span>
236 </td><td align="right" valign="top"
243 <dt>Returns: a new object with type S, a subtype of T</dt>
251 <!-- ==================== NAVIGATION BAR ==================== -->
252 <table class="navbar" border="0" width="100%" cellpadding="0"
253 bgcolor="#a0c0ff" cellspacing="0">
256 <th> <a
257 href="lxml-module.html">Home</a> </th>
260 <th> <a
261 href="module-tree.html">Trees</a> </th>
264 <th> <a
265 href="identifier-index.html">Indices</a> </th>
268 <th> <a
269 href="help.html">Help</a> </th>
271 <!-- Project homepage -->
272 <th class="navbar" align="right" width="100%">
273 <table border="0" cellpadding="0" cellspacing="0">
274 <tr><th class="navbar" align="center"
275 ><a class="navbar" target="_top" href="/">lxml API</a></th>
279 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
281 <td align="left" class="footer">
282 Generated by Epydoc 3.0.1
283 on Thu Jul 9 18:29:53 2020
285 <td align="right" class="footer">
286 <a target="mainFrame" href="http://epydoc.sourceforge.net"
287 >http://epydoc.sourceforge.net</a>
292 <script type="text/javascript">
294 // Private objects are initially displayed (because if
295 // javascript is turned off then we want them to be
296 // visible); but by default, we want to hide them. So hide
297 // them unless we have a cookie that says to show them.