doc/html/api/lxml.etree._Comment-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._Comment</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;_Comment
  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._Comment-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 _Comment</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66       object --+
  67                |
  68         <a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a> --+
  69                    |
  70 <a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a> --+
  71                        |
  72                       <strong class="uidshort">_Comment</strong>
  73 </pre>
  74
  75 <dl><dt>Known Subclasses:</dt>
  76 <dd>
  77       <ul class="subclass-list">
  78 <li><a href="lxml.etree.CommentBase-class.html">CommentBase</a></li>  </ul>
  79 </dd></dl>
  80
  81 <hr />
  82 <!-- ==================== INSTANCE METHODS ==================== -->
  83 <a name="section-InstanceMethods"></a>
  84 <table class="summary" border="1" cellpadding="3"
  85        cellspacing="0" width="100%" bgcolor="white">
  86 <tr bgcolor="#70b0f0" class="table-header">
  87   <td colspan="2" class="table-header">
  88     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  89       <tr valign="top">
  90         <td align="left"><span class="table-header">Instance Methods</span></td>
  91         <td align="right" valign="top"
  92          ><span class="options">[<a href="#section-InstanceMethods"
  93          class="privatelink" onclick="toggle_private();"
  94          >hide private</a>]</span></td>
  95       </tr>
  96     </table>
  97   </td>
  98 </tr>
  99 <tr>
 100     <td width="15%" align="right" valign="top" class="summary">
 101       <span class="summary-type">a new object with type S, a subtype of T</span>
 102     </td><td class="summary">
 103       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 104         <tr>
 105           <td><span class="summary-sig"><a href="lxml.etree._Comment-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 106         <span class="summary-sig-arg">S</span>,
 107         <span class="summary-sig-arg">...</span>)</span></td>
 108           <td align="right" valign="top">
 109
 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.etree._Comment-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">x</span>)</span><br />
 124       repr(x)</td>
 125           <td align="right" valign="top">
 126
 127
 128           </td>
 129         </tr>
 130       </table>
 131
 132     </td>
 133   </tr>
 134   <tr>
 135     <td colspan="2" class="summary">
 136     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></code></b>:
 137       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__delitem__">__delitem__</a></code>,
 138       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__getitem__">__getitem__</a></code>,
 139       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__len__">__len__</a></code>,
 140       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__setitem__">__setitem__</a></code>,
 141       <code><a href="lxml.etree.__ContentOnlyElement-class.html#append">append</a></code>,
 142       <code><a href="lxml.etree.__ContentOnlyElement-class.html#get">get</a></code>,
 143       <code><a href="lxml.etree.__ContentOnlyElement-class.html#insert">insert</a></code>,
 144       <code><a href="lxml.etree.__ContentOnlyElement-class.html#items">items</a></code>,
 145       <code><a href="lxml.etree.__ContentOnlyElement-class.html#keys">keys</a></code>,
 146       <code><a href="lxml.etree.__ContentOnlyElement-class.html#set">set</a></code>,
 147       <code><a href="lxml.etree.__ContentOnlyElement-class.html#values">values</a></code>
 148       </p>
 149     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
 150       <code><a href="lxml.etree._Element-class.html#__contains__">__contains__</a></code>,
 151       <code><a href="lxml.etree._Element-class.html#__copy__">__copy__</a></code>,
 152       <code><a href="lxml.etree._Element-class.html#__deepcopy__">__deepcopy__</a></code>,
 153       <code><a href="lxml.etree._Element-class.html#__iter__">__iter__</a></code>,
 154       <code><a href="lxml.etree._Element-class.html#__nonzero__">__nonzero__</a></code>,
 155       <code><a href="lxml.etree._Element-class.html#__reversed__">__reversed__</a></code>,
 156       <code><a href="lxml.etree._Element-class.html#addnext">addnext</a></code>,
 157       <code><a href="lxml.etree._Element-class.html#addprevious">addprevious</a></code>,
 158       <code><a href="lxml.etree._Element-class.html#clear">clear</a></code>,
 159       <code><a href="lxml.etree._Element-class.html#extend">extend</a></code>,
 160       <code><a href="lxml.etree._Element-class.html#find">find</a></code>,
 161       <code><a href="lxml.etree._Element-class.html#findall">findall</a></code>,
 162       <code><a href="lxml.etree._Element-class.html#findtext">findtext</a></code>,
 163       <code><a href="lxml.etree._Element-class.html#getchildren">getchildren</a></code>,
 164       <code><a href="lxml.etree._Element-class.html#getiterator">getiterator</a></code>,
 165       <code><a href="lxml.etree._Element-class.html#getnext">getnext</a></code>,
 166       <code><a href="lxml.etree._Element-class.html#getparent">getparent</a></code>,
 167       <code><a href="lxml.etree._Element-class.html#getprevious">getprevious</a></code>,
 168       <code><a href="lxml.etree._Element-class.html#getroottree">getroottree</a></code>,
 169       <code><a href="lxml.etree._Element-class.html#index">index</a></code>,
 170       <code><a href="lxml.etree._Element-class.html#iter">iter</a></code>,
 171       <code><a href="lxml.etree._Element-class.html#iterancestors">iterancestors</a></code>,
 172       <code><a href="lxml.etree._Element-class.html#iterchildren">iterchildren</a></code>,
 173       <code><a href="lxml.etree._Element-class.html#iterdescendants">iterdescendants</a></code>,
 174       <code><a href="lxml.etree._Element-class.html#iterfind">iterfind</a></code>,
 175       <code><a href="lxml.etree._Element-class.html#itersiblings">itersiblings</a></code>,
 176       <code><a href="lxml.etree._Element-class.html#itertext">itertext</a></code>,
 177       <code><a href="lxml.etree._Element-class.html#makeelement">makeelement</a></code>,
 178       <code><a href="lxml.etree._Element-class.html#remove">remove</a></code>,
 179       <code><a href="lxml.etree._Element-class.html#replace">replace</a></code>,
 180       <code><a href="lxml.etree._Element-class.html#xpath">xpath</a></code>
 181       </p>
 182     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b> (private):
 183       <code><a href="lxml.etree._Element-class.html#_init" onclick="show_private();">_init</a></code>
 184       </p></div>
 185     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 186       <code>__delattr__</code>,
 187       <code>__format__</code>,
 188       <code>__getattribute__</code>,
 189       <code>__hash__</code>,
 190       <code>__init__</code>,
 191       <code>__reduce__</code>,
 192       <code>__reduce_ex__</code>,
 193       <code>__setattr__</code>,
 194       <code>__sizeof__</code>,
 195       <code>__str__</code>,
 196       <code>__subclasshook__</code>
 197       </p>
 198     </td>
 199   </tr>
 200 </table>
 201 <!-- ==================== PROPERTIES ==================== -->
 202 <a name="section-Properties"></a>
 203 <table class="summary" border="1" cellpadding="3"
 204        cellspacing="0" width="100%" bgcolor="white">
 205 <tr bgcolor="#70b0f0" class="table-header">
 206   <td colspan="2" class="table-header">
 207     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 208       <tr valign="top">
 209         <td align="left"><span class="table-header">Properties</span></td>
 210         <td align="right" valign="top"
 211          ><span class="options">[<a href="#section-Properties"
 212          class="privatelink" onclick="toggle_private();"
 213          >hide private</a>]</span></td>
 214       </tr>
 215     </table>
 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         <a name="tag"></a><span class="summary-name">tag</span><br />
 223       Element tag
 224     </td>
 225   </tr>
 226   <tr>
 227     <td colspan="2" class="summary">
 228     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></code></b>:
 229       <code><a href="lxml.etree.__ContentOnlyElement-class.html#attrib">attrib</a></code>,
 230       <code><a href="lxml.etree.__ContentOnlyElement-class.html#text">text</a></code>
 231       </p>
 232     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
 233       <code><a href="lxml.etree._Element-class.html#base">base</a></code>,
 234       <code><a href="lxml.etree._Element-class.html#nsmap">nsmap</a></code>,
 235       <code><a href="lxml.etree._Element-class.html#prefix">prefix</a></code>,
 236       <code><a href="lxml.etree._Element-class.html#sourceline">sourceline</a></code>,
 237       <code><a href="lxml.etree._Element-class.html#tail">tail</a></code>
 238       </p>
 239     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 240       <code>__class__</code>
 241       </p>
 242     </td>
 243   </tr>
 244 </table>
 245 <!-- ==================== METHOD DETAILS ==================== -->
 246 <a name="section-MethodDetails"></a>
 247 <table class="details" border="1" cellpadding="3"
 248        cellspacing="0" width="100%" bgcolor="white">
 249 <tr bgcolor="#70b0f0" class="table-header">
 250   <td colspan="2" class="table-header">
 251     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 252       <tr valign="top">
 253         <td align="left"><span class="table-header">Method Details</span></td>
 254         <td align="right" valign="top"
 255          ><span class="options">[<a href="#section-MethodDetails"
 256          class="privatelink" onclick="toggle_private();"
 257          >hide private</a>]</span></td>
 258       </tr>
 259     </table>
 260   </td>
 261 </tr>
 262 </table>
 263 <a name="__new__"></a>
 264 <div>
 265 <table class="details" border="1" cellpadding="3"
 266        cellspacing="0" width="100%" bgcolor="white">
 267 <tr><td>
 268   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 269   <tr valign="top"><td>
 270   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 271         <span class="sig-arg">S</span>,
 272         <span class="sig-arg">...</span>)</span>
 273   </h3>
 274   </td><td align="right" valign="top"
 275     >&nbsp;
 276     </td>
 277   </tr></table>
 278
 279
 280   <dl class="fields">
 281     <dt>Returns: a new object with type S, a subtype of T</dt>
 282     <dt>Overrides:
 283         object.__new__
 284     </dt>
 285   </dl>
 286 </td></tr></table>
 287 </div>
 288 <a name="__repr__"></a>
 289 <div>
 290 <table class="details" border="1" cellpadding="3"
 291        cellspacing="0" width="100%" bgcolor="white">
 292 <tr><td>
 293   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 294   <tr valign="top"><td>
 295   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">x</span>)</span>
 296     <br /><em class="fname">(Representation operator)</em>
 297   </h3>
 298   </td><td align="right" valign="top"
 299     >&nbsp;
 300     </td>
 301   </tr></table>
 302
 303   repr(x)
 304   <dl class="fields">
 305     <dt>Overrides:
 306         object.__repr__
 307     </dt>
 308   </dl>
 309 </td></tr></table>
 310 </div>
 311 <br />
 312 <!-- ==================== NAVIGATION BAR ==================== -->
 313 <table class="navbar" border="0" width="100%" cellpadding="0"
 314        bgcolor="#a0c0ff" cellspacing="0">
 315   <tr valign="middle">
 316   <!-- Home link -->
 317       <th>&nbsp;&nbsp;&nbsp;<a
 318         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 319
 320   <!-- Tree link -->
 321       <th>&nbsp;&nbsp;&nbsp;<a
 322         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 323
 324   <!-- Index link -->
 325       <th>&nbsp;&nbsp;&nbsp;<a
 326         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 327
 328   <!-- Help link -->
 329       <th>&nbsp;&nbsp;&nbsp;<a
 330         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 331
 332   <!-- Project homepage -->
 333       <th class="navbar" align="right" width="100%">
 334         <table border="0" cellpadding="0" cellspacing="0">
 335           <tr><th class="navbar" align="center"
 336             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 337           </tr></table></th>
 338   </tr>
 339 </table>
 340 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 341   <tr>
 342     <td align="left" class="footer">
 343     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 344     </td>
 345     <td align="right" class="footer">
 346       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 347         >http://epydoc.sourceforge.net</a>
 348     </td>
 349   </tr>
 350 </table>
 351
 352 <script type="text/javascript">
 353   <!--
 354   // Private objects are initially displayed (because if
 355   // javascript is turned off then we want them to be
 356   // visible); but by default, we want to hide them.  So hide
 357   // them unless we have a cookie that says to show them.
 358   checkCookie();
 359   // -->
 360 </script>
 361 </body>
 362 </html>