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