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