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