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