doc/html/api/lxml.cssselect.CSSSelector-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.CSSSelector</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;CSSSelector
  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.CSSSelector-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 CSSSelector</h1><p class="nomargin-top"><span class="codelink"><a href="lxml.cssselect-pysrc.html#CSSSelector">source&nbsp;code</a></span></p>
  65 <pre class="base-tree">
  66                object --+
  67                         |
  68 <a href="lxml.etree._XPathEvaluatorBase-class.html" onclick="show_private();">etree._XPathEvaluatorBase</a> --+
  69                             |
  70                   <a href="lxml.etree.XPath-class.html">etree.XPath</a> --+
  71                                 |
  72                                <strong class="uidshort">CSSSelector</strong>
  73 </pre>
  74
  75 <hr />
  76 <p>A CSS selector.</p>
  77 <p>Usage:</p>
  78 <pre class="rst-literal-block">
  79 &gt;&gt;&gt; from lxml import etree, cssselect
  80 &gt;&gt;&gt; select = cssselect.CSSSelector(&quot;a tag &gt; child&quot;)
  81
  82 &gt;&gt;&gt; root = etree.XML(&quot;&lt;a&gt;&lt;b&gt;&lt;c/&gt;&lt;tag&gt;&lt;child&gt;TEXT&lt;/child&gt;&lt;/tag&gt;&lt;/b&gt;&lt;/a&gt;&quot;)
  83 &gt;&gt;&gt; [ el.tag for el in select(root) ]
  84 ['child']
  85 </pre>
  86 <p>To use CSS namespaces, you need to pass a prefix-to-namespace
  87 mapping as <tt class="rst-docutils literal">namespaces</tt> keyword argument:</p>
  88 <pre class="rst-literal-block">
  89 &gt;&gt;&gt; rdfns = 'http://www.w3.org/1999/02/22-rdf-syntax-ns#'
  90 &gt;&gt;&gt; select_ns = cssselect.CSSSelector('root &gt; rdf|Description',
  91 ...                                   namespaces={'rdf': rdfns})
  92
  93 &gt;&gt;&gt; rdf = etree.XML((
  94 ...     '&lt;root xmlns:rdf=&quot;%s&quot;&gt;'
  95 ...       '&lt;rdf:Description&gt;blah&lt;/rdf:Description&gt;'
  96 ...     '&lt;/root&gt;') % rdfns)
  97 &gt;&gt;&gt; [(el.tag, el.text) for el in select_ns(rdf)]
  98 [('{http://www.w3.org/1999/02/22-rdf-syntax-ns#}Description', 'blah')]
  99 </pre>
 100
 101 <!-- ==================== INSTANCE METHODS ==================== -->
 102 <a name="section-InstanceMethods"></a>
 103 <table class="summary" border="1" cellpadding="3"
 104        cellspacing="0" width="100%" bgcolor="white">
 105 <tr bgcolor="#70b0f0" class="table-header">
 106   <td colspan="2" class="table-header">
 107     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 108       <tr valign="top">
 109         <td align="left"><span class="table-header">Instance Methods</span></td>
 110         <td align="right" valign="top"
 111          ><span class="options">[<a href="#section-InstanceMethods"
 112          class="privatelink" onclick="toggle_private();"
 113          >hide private</a>]</span></td>
 114       </tr>
 115     </table>
 116   </td>
 117 </tr>
 118 <tr>
 119     <td width="15%" align="right" valign="top" class="summary">
 120       <span class="summary-type">&nbsp;</span>
 121     </td><td class="summary">
 122       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 123         <tr>
 124           <td><span class="summary-sig"><a href="lxml.cssselect.CSSSelector-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 125         <span class="summary-sig-arg">css</span>,
 126         <span class="summary-sig-arg">namespaces</span>=<span class="summary-sig-default">None</span>,
 127         <span class="summary-sig-arg">translator</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">xml</code><code class="variable-quote">'</code></span>)</span><br />
 128       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 129           <td align="right" valign="top">
 130             <span class="codelink"><a href="lxml.cssselect-pysrc.html#CSSSelector.__init__">source&nbsp;code</a></span>
 131
 132           </td>
 133         </tr>
 134       </table>
 135
 136     </td>
 137   </tr>
 138 <tr>
 139     <td width="15%" align="right" valign="top" class="summary">
 140       <span class="summary-type">&nbsp;</span>
 141     </td><td class="summary">
 142       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 143         <tr>
 144           <td><span class="summary-sig"><a href="lxml.cssselect.CSSSelector-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
 145       repr(x)</td>
 146           <td align="right" valign="top">
 147             <span class="codelink"><a href="lxml.cssselect-pysrc.html#CSSSelector.__repr__">source&nbsp;code</a></span>
 148
 149           </td>
 150         </tr>
 151       </table>
 152
 153     </td>
 154   </tr>
 155   <tr>
 156     <td colspan="2" class="summary">
 157     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.XPath-class.html">etree.XPath</a></code></b>:
 158       <code><a href="lxml.etree.XPath-class.html#__call__">__call__</a></code>,
 159       <code><a href="lxml.etree.XPath-class.html#__new__">__new__</a></code>
 160       </p>
 161     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._XPathEvaluatorBase-class.html" onclick="show_private();">etree._XPathEvaluatorBase</a></code></b>:
 162       <code><a href="lxml.etree._XPathEvaluatorBase-class.html#evaluate">evaluate</a></code>
 163       </p>
 164     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 165       <code>__delattr__</code>,
 166       <code>__format__</code>,
 167       <code>__getattribute__</code>,
 168       <code>__hash__</code>,
 169       <code>__reduce__</code>,
 170       <code>__reduce_ex__</code>,
 171       <code>__setattr__</code>,
 172       <code>__sizeof__</code>,
 173       <code>__str__</code>,
 174       <code>__subclasshook__</code>
 175       </p>
 176     </td>
 177   </tr>
 178 </table>
 179 <!-- ==================== PROPERTIES ==================== -->
 180 <a name="section-Properties"></a>
 181 <table class="summary" border="1" cellpadding="3"
 182        cellspacing="0" width="100%" bgcolor="white">
 183 <tr bgcolor="#70b0f0" class="table-header">
 184   <td colspan="2" class="table-header">
 185     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 186       <tr valign="top">
 187         <td align="left"><span class="table-header">Properties</span></td>
 188         <td align="right" valign="top"
 189          ><span class="options">[<a href="#section-Properties"
 190          class="privatelink" onclick="toggle_private();"
 191          >hide private</a>]</span></td>
 192       </tr>
 193     </table>
 194   </td>
 195 </tr>
 196   <tr>
 197     <td colspan="2" class="summary">
 198     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.XPath-class.html">etree.XPath</a></code></b>:
 199       <code><a href="lxml.etree.XPath-class.html#path">path</a></code>
 200       </p>
 201     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._XPathEvaluatorBase-class.html" onclick="show_private();">etree._XPathEvaluatorBase</a></code></b>:
 202       <code><a href="lxml.etree._XPathEvaluatorBase-class.html#error_log">error_log</a></code>
 203       </p>
 204     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 205       <code>__class__</code>
 206       </p>
 207     </td>
 208   </tr>
 209 </table>
 210 <!-- ==================== METHOD DETAILS ==================== -->
 211 <a name="section-MethodDetails"></a>
 212 <table class="details" border="1" cellpadding="3"
 213        cellspacing="0" width="100%" bgcolor="white">
 214 <tr bgcolor="#70b0f0" class="table-header">
 215   <td colspan="2" class="table-header">
 216     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 217       <tr valign="top">
 218         <td align="left"><span class="table-header">Method Details</span></td>
 219         <td align="right" valign="top"
 220          ><span class="options">[<a href="#section-MethodDetails"
 221          class="privatelink" onclick="toggle_private();"
 222          >hide private</a>]</span></td>
 223       </tr>
 224     </table>
 225   </td>
 226 </tr>
 227 </table>
 228 <a name="__init__"></a>
 229 <div>
 230 <table class="details" border="1" cellpadding="3"
 231        cellspacing="0" width="100%" bgcolor="white">
 232 <tr><td>
 233   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 234   <tr valign="top"><td>
 235   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 236         <span class="sig-arg">css</span>,
 237         <span class="sig-arg">namespaces</span>=<span class="sig-default">None</span>,
 238         <span class="sig-arg">translator</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">xml</code><code class="variable-quote">'</code></span>)</span>
 239     <br /><em class="fname">(Constructor)</em>
 240   </h3>
 241   </td><td align="right" valign="top"
 242     ><span class="codelink"><a href="lxml.cssselect-pysrc.html#CSSSelector.__init__">source&nbsp;code</a></span>&nbsp;
 243     </td>
 244   </tr></table>
 245
 246   x.__init__(...) initializes x; see help(type(x)) for signature
 247   <dl class="fields">
 248     <dt>Overrides:
 249         object.__init__
 250         <dd><em class="note">(inherited documentation)</em></dd>
 251     </dt>
 252   </dl>
 253 </td></tr></table>
 254 </div>
 255 <a name="__repr__"></a>
 256 <div>
 257 <table class="details" border="1" cellpadding="3"
 258        cellspacing="0" width="100%" bgcolor="white">
 259 <tr><td>
 260   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 261   <tr valign="top"><td>
 262   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
 263     <br /><em class="fname">(Representation operator)</em>
 264   </h3>
 265   </td><td align="right" valign="top"
 266     ><span class="codelink"><a href="lxml.cssselect-pysrc.html#CSSSelector.__repr__">source&nbsp;code</a></span>&nbsp;
 267     </td>
 268   </tr></table>
 269
 270   repr(x)
 271   <dl class="fields">
 272     <dt>Overrides:
 273         object.__repr__
 274         <dd><em class="note">(inherited documentation)</em></dd>
 275     </dt>
 276   </dl>
 277 </td></tr></table>
 278 </div>
 279 <br />
 280 <!-- ==================== NAVIGATION BAR ==================== -->
 281 <table class="navbar" border="0" width="100%" cellpadding="0"
 282        bgcolor="#a0c0ff" cellspacing="0">
 283   <tr valign="middle">
 284   <!-- Home link -->
 285       <th>&nbsp;&nbsp;&nbsp;<a
 286         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 287
 288   <!-- Tree link -->
 289       <th>&nbsp;&nbsp;&nbsp;<a
 290         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 291
 292   <!-- Index link -->
 293       <th>&nbsp;&nbsp;&nbsp;<a
 294         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 295
 296   <!-- Help link -->
 297       <th>&nbsp;&nbsp;&nbsp;<a
 298         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 299
 300   <!-- Project homepage -->
 301       <th class="navbar" align="right" width="100%">
 302         <table border="0" cellpadding="0" cellspacing="0">
 303           <tr><th class="navbar" align="center"
 304             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 305           </tr></table></th>
 306   </tr>
 307 </table>
 308 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 309   <tr>
 310     <td align="left" class="footer">
 311     Generated by Epydoc 3.0.1
 312     on Wed Jan 29 12:26:21 2020
 313     </td>
 314     <td align="right" class="footer">
 315       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 316         >http://epydoc.sourceforge.net</a>
 317     </td>
 318   </tr>
 319 </table>
 320
 321 <script type="text/javascript">
 322   <!--
 323   // Private objects are initially displayed (because if
 324   // javascript is turned off then we want them to be
 325   // visible); but by default, we want to hide them.  So hide
 326   // them unless we have a cookie that says to show them.
 327   checkCookie();
 328   // -->
 329 </script>
 330 </body>
 331 </html>