doc/html/api/lxml.etree.CommentBase-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.CommentBase</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="http://codespeak.net/lxml/">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;CommentBase
  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.CommentBase-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 CommentBase</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                 <a href="lxml.etree._Comment-class.html" onclick="show_private();">_Comment</a> --+
  73                            |
  74                           <strong class="uidshort">CommentBase</strong>
  75 </pre>
  76
  77 <dl><dt>Known Subclasses:</dt>
  78 <dd>
  79       <ul class="subclass-list">
  80 <li class="private"><a href="lxml.html.HtmlComment-class.html" onclick="show_private();">html.HtmlComment</a></li>  </ul>
  81 </dd></dl>
  82
  83 <hr />
  84 <p>All custom Comment classes must inherit from this one.</p>
  85 <p>Note that you cannot (and must not) instantiate this class or its
  86 subclasses.</p>
  87 <p>Subclasses <em>must not</em> override __init__ or __new__ as it is
  88 absolutely undefined when these objects will be created or
  89 destroyed.  All persistent state of Comments must be stored in the
  90 underlying XML.  If you really need to initialize the object after
  91 creation, you can implement an <tt class="rst-docutils literal"><span class="pre">_init(self)</span></tt> method that will be
  92 called after object creation.</p>
  93
  94 <!-- ==================== INSTANCE METHODS ==================== -->
  95 <a name="section-InstanceMethods"></a>
  96 <table class="summary" border="1" cellpadding="3"
  97        cellspacing="0" width="100%" bgcolor="white">
  98 <tr bgcolor="#70b0f0" class="table-header">
  99   <td colspan="2" class="table-header">
 100     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 101       <tr valign="top">
 102         <td align="left"><span class="table-header">Instance Methods</span></td>
 103         <td align="right" valign="top"
 104          ><span class="options">[<a href="#section-InstanceMethods"
 105          class="privatelink" onclick="toggle_private();"
 106          >hide private</a>]</span></td>
 107       </tr>
 108     </table>
 109   </td>
 110 </tr>
 111 <tr>
 112     <td width="15%" align="right" valign="top" class="summary">
 113       <span class="summary-type">a new object with type S, a subtype of T</span>
 114     </td><td class="summary">
 115       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 116         <tr>
 117           <td><span class="summary-sig"><a href="lxml.etree.CommentBase-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 118         <span class="summary-sig-arg">S</span>,
 119         <span class="summary-sig-arg">...</span>)</span></td>
 120           <td align="right" valign="top">
 121
 122
 123           </td>
 124         </tr>
 125       </table>
 126
 127     </td>
 128   </tr>
 129   <tr>
 130     <td colspan="2" class="summary">
 131     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Comment-class.html" onclick="show_private();">_Comment</a></code></b>:
 132       <code><a href="lxml.etree._Comment-class.html#__repr__">__repr__</a></code>
 133       </p>
 134     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></code></b>:
 135       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__delitem__">__delitem__</a></code>,
 136       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__getitem__">__getitem__</a></code>,
 137       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__len__">__len__</a></code>,
 138       <code><a href="lxml.etree.__ContentOnlyElement-class.html#__setitem__">__setitem__</a></code>,
 139       <code><a href="lxml.etree.__ContentOnlyElement-class.html#append">append</a></code>,
 140       <code><a href="lxml.etree.__ContentOnlyElement-class.html#get">get</a></code>,
 141       <code><a href="lxml.etree.__ContentOnlyElement-class.html#insert">insert</a></code>,
 142       <code><a href="lxml.etree.__ContentOnlyElement-class.html#items">items</a></code>,
 143       <code><a href="lxml.etree.__ContentOnlyElement-class.html#keys">keys</a></code>,
 144       <code><a href="lxml.etree.__ContentOnlyElement-class.html#set">set</a></code>,
 145       <code><a href="lxml.etree.__ContentOnlyElement-class.html#values">values</a></code>
 146       </p>
 147     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
 148       <code><a href="lxml.etree._Element-class.html#__contains__">__contains__</a></code>,
 149       <code><a href="lxml.etree._Element-class.html#__copy__">__copy__</a></code>,
 150       <code><a href="lxml.etree._Element-class.html#__deepcopy__">__deepcopy__</a></code>,
 151       <code><a href="lxml.etree._Element-class.html#__iter__">__iter__</a></code>,
 152       <code><a href="lxml.etree._Element-class.html#__nonzero__">__nonzero__</a></code>,
 153       <code><a href="lxml.etree._Element-class.html#__reversed__">__reversed__</a></code>,
 154       <code><a href="lxml.etree._Element-class.html#addnext">addnext</a></code>,
 155       <code><a href="lxml.etree._Element-class.html#addprevious">addprevious</a></code>,
 156       <code><a href="lxml.etree._Element-class.html#clear">clear</a></code>,
 157       <code><a href="lxml.etree._Element-class.html#extend">extend</a></code>,
 158       <code><a href="lxml.etree._Element-class.html#find">find</a></code>,
 159       <code><a href="lxml.etree._Element-class.html#findall">findall</a></code>,
 160       <code><a href="lxml.etree._Element-class.html#findtext">findtext</a></code>,
 161       <code><a href="lxml.etree._Element-class.html#getchildren">getchildren</a></code>,
 162       <code><a href="lxml.etree._Element-class.html#getiterator">getiterator</a></code>,
 163       <code><a href="lxml.etree._Element-class.html#getnext">getnext</a></code>,
 164       <code><a href="lxml.etree._Element-class.html#getparent">getparent</a></code>,
 165       <code><a href="lxml.etree._Element-class.html#getprevious">getprevious</a></code>,
 166       <code><a href="lxml.etree._Element-class.html#getroottree">getroottree</a></code>,
 167       <code><a href="lxml.etree._Element-class.html#index">index</a></code>,
 168       <code><a href="lxml.etree._Element-class.html#iter">iter</a></code>,
 169       <code><a href="lxml.etree._Element-class.html#iterancestors">iterancestors</a></code>,
 170       <code><a href="lxml.etree._Element-class.html#iterchildren">iterchildren</a></code>,
 171       <code><a href="lxml.etree._Element-class.html#iterdescendants">iterdescendants</a></code>,
 172       <code><a href="lxml.etree._Element-class.html#iterfind">iterfind</a></code>,
 173       <code><a href="lxml.etree._Element-class.html#itersiblings">itersiblings</a></code>,
 174       <code><a href="lxml.etree._Element-class.html#itertext">itertext</a></code>,
 175       <code><a href="lxml.etree._Element-class.html#makeelement">makeelement</a></code>,
 176       <code><a href="lxml.etree._Element-class.html#remove">remove</a></code>,
 177       <code><a href="lxml.etree._Element-class.html#replace">replace</a></code>,
 178       <code><a href="lxml.etree._Element-class.html#xpath">xpath</a></code>
 179       </p>
 180     <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):
 181       <code><a href="lxml.etree._Element-class.html#_init" onclick="show_private();">_init</a></code>
 182       </p></div>
 183     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 184       <code>__delattr__</code>,
 185       <code>__getattribute__</code>,
 186       <code>__hash__</code>,
 187       <code>__init__</code>,
 188       <code>__reduce__</code>,
 189       <code>__reduce_ex__</code>,
 190       <code>__setattr__</code>,
 191       <code>__str__</code>
 192       </p>
 193     </td>
 194   </tr>
 195 </table>
 196 <!-- ==================== PROPERTIES ==================== -->
 197 <a name="section-Properties"></a>
 198 <table class="summary" border="1" cellpadding="3"
 199        cellspacing="0" width="100%" bgcolor="white">
 200 <tr bgcolor="#70b0f0" class="table-header">
 201   <td colspan="2" class="table-header">
 202     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 203       <tr valign="top">
 204         <td align="left"><span class="table-header">Properties</span></td>
 205         <td align="right" valign="top"
 206          ><span class="options">[<a href="#section-Properties"
 207          class="privatelink" onclick="toggle_private();"
 208          >hide private</a>]</span></td>
 209       </tr>
 210     </table>
 211   </td>
 212 </tr>
 213   <tr>
 214     <td colspan="2" class="summary">
 215     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Comment-class.html" onclick="show_private();">_Comment</a></code></b>:
 216       <code><a href="lxml.etree._Comment-class.html#tag">tag</a></code>
 217       </p>
 218     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree.__ContentOnlyElement-class.html" onclick="show_private();">__ContentOnlyElement</a></code></b>:
 219       <code><a href="lxml.etree.__ContentOnlyElement-class.html#attrib">attrib</a></code>,
 220       <code><a href="lxml.etree.__ContentOnlyElement-class.html#text">text</a></code>
 221       </p>
 222     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lxml.etree._Element-class.html" onclick="show_private();">_Element</a></code></b>:
 223       <code><a href="lxml.etree._Element-class.html#base">base</a></code>,
 224       <code><a href="lxml.etree._Element-class.html#nsmap">nsmap</a></code>,
 225       <code><a href="lxml.etree._Element-class.html#prefix">prefix</a></code>,
 226       <code><a href="lxml.etree._Element-class.html#sourceline">sourceline</a></code>,
 227       <code><a href="lxml.etree._Element-class.html#tail">tail</a></code>
 228       </p>
 229     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 230       <code>__class__</code>
 231       </p>
 232     </td>
 233   </tr>
 234 </table>
 235 <!-- ==================== METHOD DETAILS ==================== -->
 236 <a name="section-MethodDetails"></a>
 237 <table class="details" border="1" cellpadding="3"
 238        cellspacing="0" width="100%" bgcolor="white">
 239 <tr bgcolor="#70b0f0" class="table-header">
 240   <td colspan="2" class="table-header">
 241     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 242       <tr valign="top">
 243         <td align="left"><span class="table-header">Method Details</span></td>
 244         <td align="right" valign="top"
 245          ><span class="options">[<a href="#section-MethodDetails"
 246          class="privatelink" onclick="toggle_private();"
 247          >hide private</a>]</span></td>
 248       </tr>
 249     </table>
 250   </td>
 251 </tr>
 252 </table>
 253 <a name="__new__"></a>
 254 <div>
 255 <table class="details" border="1" cellpadding="3"
 256        cellspacing="0" width="100%" bgcolor="white">
 257 <tr><td>
 258   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 259   <tr valign="top"><td>
 260   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 261         <span class="sig-arg">S</span>,
 262         <span class="sig-arg">...</span>)</span>
 263   </h3>
 264   </td><td align="right" valign="top"
 265     >&nbsp;
 266     </td>
 267   </tr></table>
 268
 269
 270   <dl class="fields">
 271     <dt>Returns: a new object with type S, a subtype of T</dt>
 272     <dt>Overrides:
 273         object.__new__
 274     </dt>
 275   </dl>
 276 </td></tr></table>
 277 </div>
 278 <br />
 279 <!-- ==================== NAVIGATION BAR ==================== -->
 280 <table class="navbar" border="0" width="100%" cellpadding="0"
 281        bgcolor="#a0c0ff" cellspacing="0">
 282   <tr valign="middle">
 283   <!-- Home link -->
 284       <th>&nbsp;&nbsp;&nbsp;<a
 285         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 286
 287   <!-- Tree link -->
 288       <th>&nbsp;&nbsp;&nbsp;<a
 289         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 290
 291   <!-- Index link -->
 292       <th>&nbsp;&nbsp;&nbsp;<a
 293         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 294
 295   <!-- Help link -->
 296       <th>&nbsp;&nbsp;&nbsp;<a
 297         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 298
 299   <!-- Project homepage -->
 300       <th class="navbar" align="right" width="100%">
 301         <table border="0" cellpadding="0" cellspacing="0">
 302           <tr><th class="navbar" align="center"
 303             ><a class="navbar" target="_top" href="http://codespeak.net/lxml/">lxml API</a></th>
 304           </tr></table></th>
 305   </tr>
 306 </table>
 307 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 308   <tr>
 309     <td align="left" class="footer">
 310     Generated by Epydoc 3.0 on Fri Oct 30 14:51:45 2009
 311     </td>
 312     <td align="right" class="footer">
 313       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 314         >http://epydoc.sourceforge.net</a>
 315     </td>
 316   </tr>
 317 </table>
 318
 319 <script type="text/javascript">
 320   <!--
 321   // Private objects are initially displayed (because if
 322   // javascript is turned off then we want them to be
 323   // visible); but by default, we want to hide them.  So hide
 324   // them unless we have a cookie that says to show them.
 325   checkCookie();
 326   // -->
 327 </script>
 328 </body>
 329 </html>