Imported Upstream version 4.5.2
[platform/upstream/python-lxml.git] / doc / html / api / lxml.etree._XPathEvaluatorBase-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._XPathEvaluatorBase</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;_XPathEvaluatorBase
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._XPathEvaluatorBase-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 _XPathEvaluatorBase</h1><p class="nomargin-top"></p>
65 <pre class="base-tree">
66 object --+
67          |
68         <strong class="uidshort">_XPathEvaluatorBase</strong>
69 </pre>
70
71 <dl><dt>Known Subclasses:</dt>
72 <dd>
73       <ul class="subclass-list">
74 <li><a href="lxml.etree.XPath-class.html">XPath</a></li><li class="private">, <a href="lxml.etree.XPathElementEvaluator-class.html" onclick="show_private();">XPathElementEvaluator</a></li>  </ul>
75 </dd></dl>
76
77 <hr />
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._XPathEvaluatorBase-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">...</span>)</span><br />
102       x.__init__(...) initializes x; see help(type(x)) for signature</td>
103           <td align="right" valign="top">
104             
105             
106           </td>
107         </tr>
108       </table>
109       
110     </td>
111   </tr>
112 <tr>
113     <td width="15%" align="right" valign="top" class="summary">
114       <span class="summary-type">a new object with type S, a subtype of T</span>
115     </td><td class="summary">
116       <table width="100%" cellpadding="0" cellspacing="0" border="0">
117         <tr>
118           <td><span class="summary-sig"><a href="lxml.etree._XPathEvaluatorBase-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
119         <span class="summary-sig-arg">S</span>,
120         <span class="summary-sig-arg">...</span>)</span></td>
121           <td align="right" valign="top">
122             
123             
124           </td>
125         </tr>
126       </table>
127       
128     </td>
129   </tr>
130 <tr>
131     <td width="15%" align="right" valign="top" class="summary">
132       <span class="summary-type">&nbsp;</span>
133     </td><td class="summary">
134       <table width="100%" cellpadding="0" cellspacing="0" border="0">
135         <tr>
136           <td><span class="summary-sig"><a href="lxml.etree._XPathEvaluatorBase-class.html#evaluate" class="summary-sig-name">evaluate</a>(<span class="summary-sig-arg">self</span>,
137         <span class="summary-sig-arg">_eval_arg</span>,
138         <span class="summary-sig-arg">**_variables</span>)</span><br />
139       Evaluate an XPath expression.</td>
140           <td align="right" valign="top">
141             
142             
143           </td>
144         </tr>
145       </table>
146       
147     </td>
148   </tr>
149   <tr>
150     <td colspan="2" class="summary">
151     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
152       <code>__delattr__</code>,
153       <code>__format__</code>,
154       <code>__getattribute__</code>,
155       <code>__hash__</code>,
156       <code>__reduce__</code>,
157       <code>__reduce_ex__</code>,
158       <code>__repr__</code>,
159       <code>__setattr__</code>,
160       <code>__sizeof__</code>,
161       <code>__str__</code>,
162       <code>__subclasshook__</code>
163       </p>
164     </td>
165   </tr>
166 </table>
167 <!-- ==================== PROPERTIES ==================== -->
168 <a name="section-Properties"></a>
169 <table class="summary" border="1" cellpadding="3"
170        cellspacing="0" width="100%" bgcolor="white">
171 <tr bgcolor="#70b0f0" class="table-header">
172   <td colspan="2" class="table-header">
173     <table border="0" cellpadding="0" cellspacing="0" width="100%">
174       <tr valign="top">
175         <td align="left"><span class="table-header">Properties</span></td>
176         <td align="right" valign="top"
177          ><span class="options">[<a href="#section-Properties"
178          class="privatelink" onclick="toggle_private();"
179          >hide private</a>]</span></td>
180       </tr>
181     </table>
182   </td>
183 </tr>
184 <tr>
185     <td width="15%" align="right" valign="top" class="summary">
186       <span class="summary-type">&nbsp;</span>
187     </td><td class="summary">
188         <a name="error_log"></a><span class="summary-name">error_log</span>
189     </td>
190   </tr>
191   <tr>
192     <td colspan="2" class="summary">
193     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
194       <code>__class__</code>
195       </p>
196     </td>
197   </tr>
198 </table>
199 <!-- ==================== METHOD DETAILS ==================== -->
200 <a name="section-MethodDetails"></a>
201 <table class="details" border="1" cellpadding="3"
202        cellspacing="0" width="100%" bgcolor="white">
203 <tr bgcolor="#70b0f0" class="table-header">
204   <td colspan="2" class="table-header">
205     <table border="0" cellpadding="0" cellspacing="0" width="100%">
206       <tr valign="top">
207         <td align="left"><span class="table-header">Method Details</span></td>
208         <td align="right" valign="top"
209          ><span class="options">[<a href="#section-MethodDetails"
210          class="privatelink" onclick="toggle_private();"
211          >hide private</a>]</span></td>
212       </tr>
213     </table>
214   </td>
215 </tr>
216 </table>
217 <a name="__init__"></a>
218 <div>
219 <table class="details" border="1" cellpadding="3"
220        cellspacing="0" width="100%" bgcolor="white">
221 <tr><td>
222   <table width="100%" cellpadding="0" cellspacing="0" border="0">
223   <tr valign="top"><td>
224   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">...</span>)</span>
225     <br /><em class="fname">(Constructor)</em>
226   </h3>
227   </td><td align="right" valign="top"
228     >&nbsp;
229     </td>
230   </tr></table>
231   
232   x.__init__(...) initializes x; see help(type(x)) for signature
233   <dl class="fields">
234     <dt>Overrides:
235         object.__init__
236     </dt>
237   </dl>
238 </td></tr></table>
239 </div>
240 <a name="__new__"></a>
241 <div>
242 <table class="details" border="1" cellpadding="3"
243        cellspacing="0" width="100%" bgcolor="white">
244 <tr><td>
245   <table width="100%" cellpadding="0" cellspacing="0" border="0">
246   <tr valign="top"><td>
247   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
248         <span class="sig-arg">S</span>,
249         <span class="sig-arg">...</span>)</span>
250   </h3>
251   </td><td align="right" valign="top"
252     >&nbsp;
253     </td>
254   </tr></table>
255   
256   
257   <dl class="fields">
258     <dt>Returns: a new object with type S, a subtype of T</dt>
259     <dt>Overrides:
260         object.__new__
261     </dt>
262   </dl>
263 </td></tr></table>
264 </div>
265 <a name="evaluate"></a>
266 <div>
267 <table class="details" border="1" cellpadding="3"
268        cellspacing="0" width="100%" bgcolor="white">
269 <tr><td>
270   <table width="100%" cellpadding="0" cellspacing="0" border="0">
271   <tr valign="top"><td>
272   <h3 class="epydoc"><span class="sig"><span class="sig-name">evaluate</span>(<span class="sig-arg">self</span>,
273         <span class="sig-arg">_eval_arg</span>,
274         <span class="sig-arg">**_variables</span>)</span>
275   </h3>
276   </td><td align="right" valign="top"
277     >&nbsp;
278     </td>
279   </tr></table>
280   
281   <p>Evaluate an XPath expression.</p>
282 <p>Instead of calling this method, you can also call the evaluator object
283 itself.</p>
284 <p>Variables may be provided as keyword arguments.  Note that namespaces
285 are currently not supported for variables.</p>
286   <dl class="fields">
287   </dl>
288 <div class="fields">      <p><strong>Deprecated:</strong>
289         call the object, not its method.
290       </p>
291 </div></td></tr></table>
292 </div>
293 <br />
294 <!-- ==================== NAVIGATION BAR ==================== -->
295 <table class="navbar" border="0" width="100%" cellpadding="0"
296        bgcolor="#a0c0ff" cellspacing="0">
297   <tr valign="middle">
298   <!-- Home link -->
299       <th>&nbsp;&nbsp;&nbsp;<a
300         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
301
302   <!-- Tree link -->
303       <th>&nbsp;&nbsp;&nbsp;<a
304         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
305
306   <!-- Index link -->
307       <th>&nbsp;&nbsp;&nbsp;<a
308         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
309
310   <!-- Help link -->
311       <th>&nbsp;&nbsp;&nbsp;<a
312         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
313
314   <!-- Project homepage -->
315       <th class="navbar" align="right" width="100%">
316         <table border="0" cellpadding="0" cellspacing="0">
317           <tr><th class="navbar" align="center"
318             ><a class="navbar" target="_top" href="/">lxml API</a></th>
319           </tr></table></th>
320   </tr>
321 </table>
322 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
323   <tr>
324     <td align="left" class="footer">
325     Generated by Epydoc 3.0.1
326     on Thu Jul  9 18:29:53 2020
327     </td>
328     <td align="right" class="footer">
329       <a target="mainFrame" href="http://epydoc.sourceforge.net"
330         >http://epydoc.sourceforge.net</a>
331     </td>
332   </tr>
333 </table>
334
335 <script type="text/javascript">
336   <!--
337   // Private objects are initially displayed (because if
338   // javascript is turned off then we want them to be
339   // visible); but by default, we want to hide them.  So hide
340   // them unless we have a cookie that says to show them.
341   checkCookie();
342   // -->
343 </script>
344 </body>
345 </html>