doc/html/api/lxml.etree.SiblingsIterator-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.SiblingsIterator</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;SiblingsIterator
  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.SiblingsIterator-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 SiblingsIterator</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66            object --+
  67                     |
  68 <a href="lxml.etree._ElementMatchIterator-class.html" onclick="show_private();">_ElementMatchIterator</a> --+
  69                         |
  70                        <strong class="uidshort">SiblingsIterator</strong>
  71 </pre>
  72
  73 <hr />
  74 <p>SiblingsIterator(self, node, tag=None, preceding=False)
  75 Iterates over the siblings of an element.</p>
  76 <p>You can pass the boolean keyword <tt class="rst-docutils literal">preceding</tt> to specify the direction.</p>
  77
  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">a new object with type S, a subtype of T</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.etree.SiblingsIterator-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 102         <span class="summary-sig-arg">S</span>,
 103         <span class="summary-sig-arg">...</span>)</span></td>
 104           <td align="right" valign="top">
 105
 106
 107           </td>
 108         </tr>
 109       </table>
 110
 111     </td>
 112   </tr>
 113   <tr>
 114     <td colspan="2" class="summary">
 115     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._ElementMatchIterator-class.html" onclick="show_private();">_ElementMatchIterator</a></code></b>:
 116       <code><a href="lxml.etree._ElementMatchIterator-class.html#__iter__">__iter__</a></code>,
 117       <code><a href="lxml.etree._ElementMatchIterator-class.html#__next__">__next__</a></code>,
 118       <code><a href="lxml.etree._ElementMatchIterator-class.html#next">next</a></code>
 119       </p>
 120     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 121       <code>__delattr__</code>,
 122       <code>__format__</code>,
 123       <code>__getattribute__</code>,
 124       <code>__hash__</code>,
 125       <code>__init__</code>,
 126       <code>__reduce__</code>,
 127       <code>__reduce_ex__</code>,
 128       <code>__repr__</code>,
 129       <code>__setattr__</code>,
 130       <code>__sizeof__</code>,
 131       <code>__str__</code>,
 132       <code>__subclasshook__</code>
 133       </p>
 134     </td>
 135   </tr>
 136 </table>
 137 <!-- ==================== PROPERTIES ==================== -->
 138 <a name="section-Properties"></a>
 139 <table class="summary" border="1" cellpadding="3"
 140        cellspacing="0" width="100%" bgcolor="white">
 141 <tr bgcolor="#70b0f0" class="table-header">
 142   <td colspan="2" class="table-header">
 143     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 144       <tr valign="top">
 145         <td align="left"><span class="table-header">Properties</span></td>
 146         <td align="right" valign="top"
 147          ><span class="options">[<a href="#section-Properties"
 148          class="privatelink" onclick="toggle_private();"
 149          >hide private</a>]</span></td>
 150       </tr>
 151     </table>
 152   </td>
 153 </tr>
 154   <tr>
 155     <td colspan="2" class="summary">
 156     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 157       <code>__class__</code>
 158       </p>
 159     </td>
 160   </tr>
 161 </table>
 162 <!-- ==================== METHOD DETAILS ==================== -->
 163 <a name="section-MethodDetails"></a>
 164 <table class="details" border="1" cellpadding="3"
 165        cellspacing="0" width="100%" bgcolor="white">
 166 <tr bgcolor="#70b0f0" class="table-header">
 167   <td colspan="2" class="table-header">
 168     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 169       <tr valign="top">
 170         <td align="left"><span class="table-header">Method Details</span></td>
 171         <td align="right" valign="top"
 172          ><span class="options">[<a href="#section-MethodDetails"
 173          class="privatelink" onclick="toggle_private();"
 174          >hide private</a>]</span></td>
 175       </tr>
 176     </table>
 177   </td>
 178 </tr>
 179 </table>
 180 <a name="__new__"></a>
 181 <div>
 182 <table class="details" border="1" cellpadding="3"
 183        cellspacing="0" width="100%" bgcolor="white">
 184 <tr><td>
 185   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 186   <tr valign="top"><td>
 187   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 188         <span class="sig-arg">S</span>,
 189         <span class="sig-arg">...</span>)</span>
 190   </h3>
 191   </td><td align="right" valign="top"
 192     >&nbsp;
 193     </td>
 194   </tr></table>
 195
 196
 197   <dl class="fields">
 198     <dt>Returns: a new object with type S, a subtype of T</dt>
 199     <dt>Overrides:
 200         object.__new__
 201     </dt>
 202   </dl>
 203 </td></tr></table>
 204 </div>
 205 <br />
 206 <!-- ==================== NAVIGATION BAR ==================== -->
 207 <table class="navbar" border="0" width="100%" cellpadding="0"
 208        bgcolor="#a0c0ff" cellspacing="0">
 209   <tr valign="middle">
 210   <!-- Home link -->
 211       <th>&nbsp;&nbsp;&nbsp;<a
 212         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 213
 214   <!-- Tree link -->
 215       <th>&nbsp;&nbsp;&nbsp;<a
 216         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 217
 218   <!-- Index link -->
 219       <th>&nbsp;&nbsp;&nbsp;<a
 220         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 221
 222   <!-- Help link -->
 223       <th>&nbsp;&nbsp;&nbsp;<a
 224         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 225
 226   <!-- Project homepage -->
 227       <th class="navbar" align="right" width="100%">
 228         <table border="0" cellpadding="0" cellspacing="0">
 229           <tr><th class="navbar" align="center"
 230             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 231           </tr></table></th>
 232   </tr>
 233 </table>
 234 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 235   <tr>
 236     <td align="left" class="footer">
 237     Generated by Epydoc 3.0.1
 238     on Wed Jan 29 12:26:21 2020
 239     </td>
 240     <td align="right" class="footer">
 241       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 242         >http://epydoc.sourceforge.net</a>
 243     </td>
 244   </tr>
 245 </table>
 246
 247 <script type="text/javascript">
 248   <!--
 249   // Private objects are initially displayed (because if
 250   // javascript is turned off then we want them to be
 251   // visible); but by default, we want to hide them.  So hide
 252   // them unless we have a cookie that says to show them.
 253   checkCookie();
 254   // -->
 255 </script>
 256 </body>
 257 </html>