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