doc/html/api/lxml.cssselect.XPathExpr-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.cssselect.XPathExpr</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.cssselect-module.html">Module&nbsp;cssselect</a> ::
  47         Class&nbsp;XPathExpr
  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.cssselect.XPathExpr-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 XPathExpr</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.cssselect-pysrc.html#XPathExpr">source&nbsp;code</a></span></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">XPathExpr</strong>
  69 </pre>
  70
  71 <dl><dt>Known Subclasses:</dt>
  72 <dd>
  73       <ul class="subclass-list">
  74 <li class="private"><a href="lxml.cssselect.XPathExprOr-class.html" onclick="show_private();">XPathExprOr</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.cssselect.XPathExpr-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 102         <span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default">None</span>,
 103         <span class="summary-sig-arg">path</span>=<span class="summary-sig-default">None</span>,
 104         <span class="summary-sig-arg">element</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">*</code><code class="variable-quote">'</code></span>,
 105         <span class="summary-sig-arg">condition</span>=<span class="summary-sig-default">None</span>,
 106         <span class="summary-sig-arg">star_prefix</span>=<span class="summary-sig-default">False</span>)</span><br />
 107       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 108           <td align="right" valign="top">
 109             <span class="codelink"><a href="lxml.cssselect-pysrc.html#XPathExpr.__init__">source&nbsp;code</a></span>
 110
 111           </td>
 112         </tr>
 113       </table>
 114
 115     </td>
 116   </tr>
 117 <tr>
 118     <td width="15%" align="right" valign="top" class="summary">
 119       <span class="summary-type">&nbsp;</span>
 120     </td><td class="summary">
 121       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 122         <tr>
 123           <td><span class="summary-sig"><a href="lxml.cssselect.XPathExpr-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
 124       str(x)</td>
 125           <td align="right" valign="top">
 126             <span class="codelink"><a href="lxml.cssselect-pysrc.html#XPathExpr.__str__">source&nbsp;code</a></span>
 127
 128           </td>
 129         </tr>
 130       </table>
 131
 132     </td>
 133   </tr>
 134 <tr>
 135     <td width="15%" align="right" valign="top" class="summary">
 136       <span class="summary-type">&nbsp;</span>
 137     </td><td class="summary">
 138       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 139         <tr>
 140           <td><span class="summary-sig"><a href="lxml.cssselect.XPathExpr-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
 141       repr(x)</td>
 142           <td align="right" valign="top">
 143             <span class="codelink"><a href="lxml.cssselect-pysrc.html#XPathExpr.__repr__">source&nbsp;code</a></span>
 144
 145           </td>
 146         </tr>
 147       </table>
 148
 149     </td>
 150   </tr>
 151 <tr>
 152     <td width="15%" align="right" valign="top" class="summary">
 153       <span class="summary-type">&nbsp;</span>
 154     </td><td class="summary">
 155       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 156         <tr>
 157           <td><span class="summary-sig"><a name="add_condition"></a><span class="summary-sig-name">add_condition</span>(<span class="summary-sig-arg">self</span>,
 158         <span class="summary-sig-arg">condition</span>)</span></td>
 159           <td align="right" valign="top">
 160             <span class="codelink"><a href="lxml.cssselect-pysrc.html#XPathExpr.add_condition">source&nbsp;code</a></span>
 161
 162           </td>
 163         </tr>
 164       </table>
 165
 166     </td>
 167   </tr>
 168 <tr>
 169     <td width="15%" align="right" valign="top" class="summary">
 170       <span class="summary-type">&nbsp;</span>
 171     </td><td class="summary">
 172       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 173         <tr>
 174           <td><span class="summary-sig"><a name="add_path"></a><span class="summary-sig-name">add_path</span>(<span class="summary-sig-arg">self</span>,
 175         <span class="summary-sig-arg">part</span>)</span></td>
 176           <td align="right" valign="top">
 177             <span class="codelink"><a href="lxml.cssselect-pysrc.html#XPathExpr.add_path">source&nbsp;code</a></span>
 178
 179           </td>
 180         </tr>
 181       </table>
 182
 183     </td>
 184   </tr>
 185 <tr>
 186     <td width="15%" align="right" valign="top" class="summary">
 187       <span class="summary-type">&nbsp;</span>
 188     </td><td class="summary">
 189       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 190         <tr>
 191           <td><span class="summary-sig"><a name="add_prefix"></a><span class="summary-sig-name">add_prefix</span>(<span class="summary-sig-arg">self</span>,
 192         <span class="summary-sig-arg">prefix</span>)</span></td>
 193           <td align="right" valign="top">
 194             <span class="codelink"><a href="lxml.cssselect-pysrc.html#XPathExpr.add_prefix">source&nbsp;code</a></span>
 195
 196           </td>
 197         </tr>
 198       </table>
 199
 200     </td>
 201   </tr>
 202 <tr>
 203     <td width="15%" align="right" valign="top" class="summary">
 204       <span class="summary-type">&nbsp;</span>
 205     </td><td class="summary">
 206       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 207         <tr>
 208           <td><span class="summary-sig"><a name="add_name_test"></a><span class="summary-sig-name">add_name_test</span>(<span class="summary-sig-arg">self</span>)</span></td>
 209           <td align="right" valign="top">
 210             <span class="codelink"><a href="lxml.cssselect-pysrc.html#XPathExpr.add_name_test">source&nbsp;code</a></span>
 211
 212           </td>
 213         </tr>
 214       </table>
 215
 216     </td>
 217   </tr>
 218 <tr>
 219     <td width="15%" align="right" valign="top" class="summary">
 220       <span class="summary-type">&nbsp;</span>
 221     </td><td class="summary">
 222       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 223         <tr>
 224           <td><span class="summary-sig"><a name="add_star_prefix"></a><span class="summary-sig-name">add_star_prefix</span>(<span class="summary-sig-arg">self</span>)</span><br />
 225       Adds a /* prefix if there is no prefix.  This is when you need
 226 to keep context's constrained to a single parent.</td>
 227           <td align="right" valign="top">
 228             <span class="codelink"><a href="lxml.cssselect-pysrc.html#XPathExpr.add_star_prefix">source&nbsp;code</a></span>
 229
 230           </td>
 231         </tr>
 232       </table>
 233
 234     </td>
 235   </tr>
 236 <tr>
 237     <td width="15%" align="right" valign="top" class="summary">
 238       <span class="summary-type">&nbsp;</span>
 239     </td><td class="summary">
 240       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 241         <tr>
 242           <td><span class="summary-sig"><a name="join"></a><span class="summary-sig-name">join</span>(<span class="summary-sig-arg">self</span>,
 243         <span class="summary-sig-arg">combiner</span>,
 244         <span class="summary-sig-arg">other</span>)</span></td>
 245           <td align="right" valign="top">
 246             <span class="codelink"><a href="lxml.cssselect-pysrc.html#XPathExpr.join">source&nbsp;code</a></span>
 247
 248           </td>
 249         </tr>
 250       </table>
 251
 252     </td>
 253   </tr>
 254   <tr>
 255     <td colspan="2" class="summary">
 256     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 257       <code>__delattr__</code>,
 258       <code>__format__</code>,
 259       <code>__getattribute__</code>,
 260       <code>__hash__</code>,
 261       <code>__new__</code>,
 262       <code>__reduce__</code>,
 263       <code>__reduce_ex__</code>,
 264       <code>__setattr__</code>,
 265       <code>__sizeof__</code>,
 266       <code>__subclasshook__</code>
 267       </p>
 268     </td>
 269   </tr>
 270 </table>
 271 <!-- ==================== PROPERTIES ==================== -->
 272 <a name="section-Properties"></a>
 273 <table class="summary" border="1" cellpadding="3"
 274        cellspacing="0" width="100%" bgcolor="white">
 275 <tr bgcolor="#70b0f0" class="table-header">
 276   <td colspan="2" class="table-header">
 277     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 278       <tr valign="top">
 279         <td align="left"><span class="table-header">Properties</span></td>
 280         <td align="right" valign="top"
 281          ><span class="options">[<a href="#section-Properties"
 282          class="privatelink" onclick="toggle_private();"
 283          >hide private</a>]</span></td>
 284       </tr>
 285     </table>
 286   </td>
 287 </tr>
 288   <tr>
 289     <td colspan="2" class="summary">
 290     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 291       <code>__class__</code>
 292       </p>
 293     </td>
 294   </tr>
 295 </table>
 296 <!-- ==================== METHOD DETAILS ==================== -->
 297 <a name="section-MethodDetails"></a>
 298 <table class="details" border="1" cellpadding="3"
 299        cellspacing="0" width="100%" bgcolor="white">
 300 <tr bgcolor="#70b0f0" class="table-header">
 301   <td colspan="2" class="table-header">
 302     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 303       <tr valign="top">
 304         <td align="left"><span class="table-header">Method Details</span></td>
 305         <td align="right" valign="top"
 306          ><span class="options">[<a href="#section-MethodDetails"
 307          class="privatelink" onclick="toggle_private();"
 308          >hide private</a>]</span></td>
 309       </tr>
 310     </table>
 311   </td>
 312 </tr>
 313 </table>
 314 <a name="__init__"></a>
 315 <div>
 316 <table class="details" border="1" cellpadding="3"
 317        cellspacing="0" width="100%" bgcolor="white">
 318 <tr><td>
 319   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 320   <tr valign="top"><td>
 321   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 322         <span class="sig-arg">prefix</span>=<span class="sig-default">None</span>,
 323         <span class="sig-arg">path</span>=<span class="sig-default">None</span>,
 324         <span class="sig-arg">element</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">*</code><code class="variable-quote">'</code></span>,
 325         <span class="sig-arg">condition</span>=<span class="sig-default">None</span>,
 326         <span class="sig-arg">star_prefix</span>=<span class="sig-default">False</span>)</span>
 327     <br /><em class="fname">(Constructor)</em>
 328   </h3>
 329   </td><td align="right" valign="top"
 330     ><span class="codelink"><a href="lxml.cssselect-pysrc.html#XPathExpr.__init__">source&nbsp;code</a></span>&nbsp;
 331     </td>
 332   </tr></table>
 333
 334   x.__init__(...) initializes x; see help(type(x)) for signature
 335   <dl class="fields">
 336     <dt>Overrides:
 337         object.__init__
 338         <dd><em class="note">(inherited documentation)</em></dd>
 339     </dt>
 340   </dl>
 341 </td></tr></table>
 342 </div>
 343 <a name="__str__"></a>
 344 <div>
 345 <table class="details" border="1" cellpadding="3"
 346        cellspacing="0" width="100%" bgcolor="white">
 347 <tr><td>
 348   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 349   <tr valign="top"><td>
 350   <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
 351     <br /><em class="fname">(Informal representation operator)</em>
 352   </h3>
 353   </td><td align="right" valign="top"
 354     ><span class="codelink"><a href="lxml.cssselect-pysrc.html#XPathExpr.__str__">source&nbsp;code</a></span>&nbsp;
 355     </td>
 356   </tr></table>
 357
 358   str(x)
 359   <dl class="fields">
 360     <dt>Overrides:
 361         object.__str__
 362         <dd><em class="note">(inherited documentation)</em></dd>
 363     </dt>
 364   </dl>
 365 </td></tr></table>
 366 </div>
 367 <a name="__repr__"></a>
 368 <div>
 369 <table class="details" border="1" cellpadding="3"
 370        cellspacing="0" width="100%" bgcolor="white">
 371 <tr><td>
 372   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 373   <tr valign="top"><td>
 374   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
 375     <br /><em class="fname">(Representation operator)</em>
 376   </h3>
 377   </td><td align="right" valign="top"
 378     ><span class="codelink"><a href="lxml.cssselect-pysrc.html#XPathExpr.__repr__">source&nbsp;code</a></span>&nbsp;
 379     </td>
 380   </tr></table>
 381
 382   repr(x)
 383   <dl class="fields">
 384     <dt>Overrides:
 385         object.__repr__
 386         <dd><em class="note">(inherited documentation)</em></dd>
 387     </dt>
 388   </dl>
 389 </td></tr></table>
 390 </div>
 391 <br />
 392 <!-- ==================== NAVIGATION BAR ==================== -->
 393 <table class="navbar" border="0" width="100%" cellpadding="0"
 394        bgcolor="#a0c0ff" cellspacing="0">
 395   <tr valign="middle">
 396   <!-- Home link -->
 397       <th>&nbsp;&nbsp;&nbsp;<a
 398         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 399
 400   <!-- Tree link -->
 401       <th>&nbsp;&nbsp;&nbsp;<a
 402         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 403
 404   <!-- Index link -->
 405       <th>&nbsp;&nbsp;&nbsp;<a
 406         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 407
 408   <!-- Help link -->
 409       <th>&nbsp;&nbsp;&nbsp;<a
 410         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 411
 412   <!-- Project homepage -->
 413       <th class="navbar" align="right" width="100%">
 414         <table border="0" cellpadding="0" cellspacing="0">
 415           <tr><th class="navbar" align="center"
 416             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 417           </tr></table></th>
 418   </tr>
 419 </table>
 420 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 421   <tr>
 422     <td align="left" class="footer">
 423     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 424     </td>
 425     <td align="right" class="footer">
 426       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 427         >http://epydoc.sourceforge.net</a>
 428     </td>
 429   </tr>
 430 </table>
 431
 432 <script type="text/javascript">
 433   <!--
 434   // Private objects are initially displayed (because if
 435   // javascript is turned off then we want them to be
 436   // visible); but by default, we want to hide them.  So hide
 437   // them unless we have a cookie that says to show them.
 438   checkCookie();
 439   // -->
 440 </script>
 441 </body>
 442 </html>