doc/html/api/lxml.etree.CDATA-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.CDATA</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;CDATA
  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.CDATA-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 CDATA</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">CDATA</strong>
  69 </pre>
  70
  71 <hr />
  72 <p>CDATA(data)</p>
  73 <p>CDATA factory.  This factory creates an opaque data object that
  74 can be used to set Element text.  The usual way to use it is:</p>
  75 <pre class="rst-literal-block">
  76 &gt;&gt;&gt; from lxml import etree
  77 &gt;&gt;&gt; el = etree.Element('content')
  78 &gt;&gt;&gt; el.text = etree.CDATA('a string')
  79 </pre>
  80
  81 <!-- ==================== INSTANCE METHODS ==================== -->
  82 <a name="section-InstanceMethods"></a>
  83 <table class="summary" border="1" cellpadding="3"
  84        cellspacing="0" width="100%" bgcolor="white">
  85 <tr bgcolor="#70b0f0" class="table-header">
  86   <td colspan="2" class="table-header">
  87     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  88       <tr valign="top">
  89         <td align="left"><span class="table-header">Instance Methods</span></td>
  90         <td align="right" valign="top"
  91          ><span class="options">[<a href="#section-InstanceMethods"
  92          class="privatelink" onclick="toggle_private();"
  93          >hide private</a>]</span></td>
  94       </tr>
  95     </table>
  96   </td>
  97 </tr>
  98 <tr>
  99     <td width="15%" align="right" valign="top" class="summary">
 100       <span class="summary-type">&nbsp;</span>
 101     </td><td class="summary">
 102       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 103         <tr>
 104           <td><span class="summary-sig"><a href="lxml.etree.CDATA-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">data</span>)</span><br />
 105       x.__init__(...) initializes x; see help(type(x)) for signature</td>
 106           <td align="right" valign="top">
 107
 108
 109           </td>
 110         </tr>
 111       </table>
 112
 113     </td>
 114   </tr>
 115 <tr>
 116     <td width="15%" align="right" valign="top" class="summary">
 117       <span class="summary-type">a new object with type S, a subtype of T</span>
 118     </td><td class="summary">
 119       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 120         <tr>
 121           <td><span class="summary-sig"><a href="lxml.etree.CDATA-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 122         <span class="summary-sig-arg">S</span>,
 123         <span class="summary-sig-arg">...</span>)</span></td>
 124           <td align="right" valign="top">
 125
 126
 127           </td>
 128         </tr>
 129       </table>
 130
 131     </td>
 132   </tr>
 133   <tr>
 134     <td colspan="2" class="summary">
 135     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 136       <code>__delattr__</code>,
 137       <code>__format__</code>,
 138       <code>__getattribute__</code>,
 139       <code>__hash__</code>,
 140       <code>__reduce__</code>,
 141       <code>__reduce_ex__</code>,
 142       <code>__repr__</code>,
 143       <code>__setattr__</code>,
 144       <code>__sizeof__</code>,
 145       <code>__str__</code>,
 146       <code>__subclasshook__</code>
 147       </p>
 148     </td>
 149   </tr>
 150 </table>
 151 <!-- ==================== PROPERTIES ==================== -->
 152 <a name="section-Properties"></a>
 153 <table class="summary" border="1" cellpadding="3"
 154        cellspacing="0" width="100%" bgcolor="white">
 155 <tr bgcolor="#70b0f0" class="table-header">
 156   <td colspan="2" class="table-header">
 157     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 158       <tr valign="top">
 159         <td align="left"><span class="table-header">Properties</span></td>
 160         <td align="right" valign="top"
 161          ><span class="options">[<a href="#section-Properties"
 162          class="privatelink" onclick="toggle_private();"
 163          >hide private</a>]</span></td>
 164       </tr>
 165     </table>
 166   </td>
 167 </tr>
 168   <tr>
 169     <td colspan="2" class="summary">
 170     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 171       <code>__class__</code>
 172       </p>
 173     </td>
 174   </tr>
 175 </table>
 176 <!-- ==================== METHOD DETAILS ==================== -->
 177 <a name="section-MethodDetails"></a>
 178 <table class="details" border="1" cellpadding="3"
 179        cellspacing="0" width="100%" bgcolor="white">
 180 <tr bgcolor="#70b0f0" class="table-header">
 181   <td colspan="2" class="table-header">
 182     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 183       <tr valign="top">
 184         <td align="left"><span class="table-header">Method Details</span></td>
 185         <td align="right" valign="top"
 186          ><span class="options">[<a href="#section-MethodDetails"
 187          class="privatelink" onclick="toggle_private();"
 188          >hide private</a>]</span></td>
 189       </tr>
 190     </table>
 191   </td>
 192 </tr>
 193 </table>
 194 <a name="__init__"></a>
 195 <div>
 196 <table class="details" border="1" cellpadding="3"
 197        cellspacing="0" width="100%" bgcolor="white">
 198 <tr><td>
 199   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 200   <tr valign="top"><td>
 201   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">data</span>)</span>
 202     <br /><em class="fname">(Constructor)</em>
 203   </h3>
 204   </td><td align="right" valign="top"
 205     >&nbsp;
 206     </td>
 207   </tr></table>
 208
 209   x.__init__(...) initializes x; see help(type(x)) for signature
 210   <dl class="fields">
 211     <dt>Overrides:
 212         object.__init__
 213     </dt>
 214   </dl>
 215 </td></tr></table>
 216 </div>
 217 <a name="__new__"></a>
 218 <div>
 219 <table class="details" border="1" cellpadding="3"
 220        cellspacing="0" width="100%" bgcolor="white">
 221 <tr><td>
 222   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 223   <tr valign="top"><td>
 224   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 225         <span class="sig-arg">S</span>,
 226         <span class="sig-arg">...</span>)</span>
 227   </h3>
 228   </td><td align="right" valign="top"
 229     >&nbsp;
 230     </td>
 231   </tr></table>
 232
 233
 234   <dl class="fields">
 235     <dt>Returns: a new object with type S, a subtype of T</dt>
 236     <dt>Overrides:
 237         object.__new__
 238     </dt>
 239   </dl>
 240 </td></tr></table>
 241 </div>
 242 <br />
 243 <!-- ==================== NAVIGATION BAR ==================== -->
 244 <table class="navbar" border="0" width="100%" cellpadding="0"
 245        bgcolor="#a0c0ff" cellspacing="0">
 246   <tr valign="middle">
 247   <!-- Home link -->
 248       <th>&nbsp;&nbsp;&nbsp;<a
 249         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 250
 251   <!-- Tree link -->
 252       <th>&nbsp;&nbsp;&nbsp;<a
 253         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 254
 255   <!-- Index link -->
 256       <th>&nbsp;&nbsp;&nbsp;<a
 257         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 258
 259   <!-- Help link -->
 260       <th>&nbsp;&nbsp;&nbsp;<a
 261         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 262
 263   <!-- Project homepage -->
 264       <th class="navbar" align="right" width="100%">
 265         <table border="0" cellpadding="0" cellspacing="0">
 266           <tr><th class="navbar" align="center"
 267             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 268           </tr></table></th>
 269   </tr>
 270 </table>
 271 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 272   <tr>
 273     <td align="left" class="footer">
 274     Generated by Epydoc 3.0.1 on Tue Jul 31 10:14:18 2012
 275     </td>
 276     <td align="right" class="footer">
 277       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 278         >http://epydoc.sourceforge.net</a>
 279     </td>
 280   </tr>
 281 </table>
 282
 283 <script type="text/javascript">
 284   <!--
 285   // Private objects are initially displayed (because if
 286   // javascript is turned off then we want them to be
 287   // visible); but by default, we want to hide them.  So hide
 288   // them unless we have a cookie that says to show them.
 289   checkCookie();
 290   // -->
 291 </script>
 292 </body>
 293 </html>