doc/html/api/lxml.objectify.ElementMaker-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.objectify.ElementMaker</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.objectify-module.html">Module&nbsp;objectify</a> ::
  47         Class&nbsp;ElementMaker
  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.objectify.ElementMaker-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 ElementMaker</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">ElementMaker</strong>
  69 </pre>
  70
  71 <hr />
  72 <p>ElementMaker(self, namespace=None, nsmap=None, annotate=True, makeelement=None)</p>
  73 <p>An ElementMaker that can be used for constructing trees.</p>
  74 <p>Example:</p>
  75 <pre class="rst-literal-block">
  76 &gt;&gt;&gt; M = ElementMaker(annotate=False)
  77 &gt;&gt;&gt; html = M.html( M.body( M.p('hello', M.br, 'objectify') ) )
  78
  79 &gt;&gt;&gt; from lxml.etree import tostring
  80 &gt;&gt;&gt; print(tostring(html, method='html').decode('ASCII'))
  81 &lt;html&gt;&lt;body&gt;&lt;p&gt;hello&lt;br&gt;objectify&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;
  82 </pre>
  83 <p>Note that this module has a predefined ElementMaker instance called <tt class="rst-docutils literal"><span class="pre">E</span></tt>.</p>
  84
  85 <!-- ==================== INSTANCE METHODS ==================== -->
  86 <a name="section-InstanceMethods"></a>
  87 <table class="summary" border="1" cellpadding="3"
  88        cellspacing="0" width="100%" bgcolor="white">
  89 <tr bgcolor="#70b0f0" class="table-header">
  90   <td colspan="2" class="table-header">
  91     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  92       <tr valign="top">
  93         <td align="left"><span class="table-header">Instance Methods</span></td>
  94         <td align="right" valign="top"
  95          ><span class="options">[<a href="#section-InstanceMethods"
  96          class="privatelink" onclick="toggle_private();"
  97          >hide private</a>]</span></td>
  98       </tr>
  99     </table>
 100   </td>
 101 </tr>
 102 <tr>
 103     <td width="15%" align="right" valign="top" class="summary">
 104       <span class="summary-type">&nbsp;</span>
 105     </td><td class="summary">
 106       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 107         <tr>
 108           <td><span class="summary-sig"><a name="__getattr__"></a><span class="summary-sig-name">__getattr__</span>(<span class="summary-sig-arg">...</span>)</span></td>
 109           <td align="right" valign="top">
 110
 111
 112           </td>
 113         </tr>
 114       </table>
 115
 116     </td>
 117   </tr>
 118 <tr>
 119     <td width="15%" align="right" valign="top" class="summary">
 120       <span class="summary-type">&nbsp;</span>
 121     </td><td class="summary">
 122       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 123         <tr>
 124           <td><span class="summary-sig"><a href="lxml.objectify.ElementMaker-class.html#__getattribute__" class="summary-sig-name">__getattribute__</a>(<span class="summary-sig-arg">...</span>)</span><br />
 125       x.__getattribute__('name') &lt;==&gt; x.name</td>
 126           <td align="right" valign="top">
 127
 128
 129           </td>
 130         </tr>
 131       </table>
 132
 133     </td>
 134   </tr>
 135 <tr>
 136     <td width="15%" align="right" valign="top" class="summary">
 137       <span class="summary-type">&nbsp;</span>
 138     </td><td class="summary">
 139       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 140         <tr>
 141           <td><span class="summary-sig"><a href="lxml.objectify.ElementMaker-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 142         <span class="summary-sig-arg">namespace</span>=<span class="summary-sig-default">None</span>,
 143         <span class="summary-sig-arg">nsmap</span>=<span class="summary-sig-default">None</span>,
 144         <span class="summary-sig-arg">annotate</span>=<span class="summary-sig-default">True</span>,
 145         <span class="summary-sig-arg">makeelement</span>=<span class="summary-sig-default">None</span>)</span><br />
 146       x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
 147           <td align="right" valign="top">
 148
 149
 150           </td>
 151         </tr>
 152       </table>
 153
 154     </td>
 155   </tr>
 156 <tr>
 157     <td width="15%" align="right" valign="top" class="summary">
 158       <span class="summary-type">a new object with type S, a subtype of T</span>
 159     </td><td class="summary">
 160       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 161         <tr>
 162           <td><span class="summary-sig"><a href="lxml.objectify.ElementMaker-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 163         <span class="summary-sig-arg">S</span>,
 164         <span class="summary-sig-arg">...</span>)</span></td>
 165           <td align="right" valign="top">
 166
 167
 168           </td>
 169         </tr>
 170       </table>
 171
 172     </td>
 173   </tr>
 174   <tr>
 175     <td colspan="2" class="summary">
 176     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 177       <code>__delattr__</code>,
 178       <code>__hash__</code>,
 179       <code>__reduce__</code>,
 180       <code>__reduce_ex__</code>,
 181       <code>__repr__</code>,
 182       <code>__setattr__</code>,
 183       <code>__str__</code>
 184       </p>
 185     </td>
 186   </tr>
 187 </table>
 188 <!-- ==================== PROPERTIES ==================== -->
 189 <a name="section-Properties"></a>
 190 <table class="summary" border="1" cellpadding="3"
 191        cellspacing="0" width="100%" bgcolor="white">
 192 <tr bgcolor="#70b0f0" class="table-header">
 193   <td colspan="2" class="table-header">
 194     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 195       <tr valign="top">
 196         <td align="left"><span class="table-header">Properties</span></td>
 197         <td align="right" valign="top"
 198          ><span class="options">[<a href="#section-Properties"
 199          class="privatelink" onclick="toggle_private();"
 200          >hide private</a>]</span></td>
 201       </tr>
 202     </table>
 203   </td>
 204 </tr>
 205   <tr>
 206     <td colspan="2" class="summary">
 207     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 208       <code>__class__</code>
 209       </p>
 210     </td>
 211   </tr>
 212 </table>
 213 <!-- ==================== METHOD DETAILS ==================== -->
 214 <a name="section-MethodDetails"></a>
 215 <table class="details" border="1" cellpadding="3"
 216        cellspacing="0" width="100%" bgcolor="white">
 217 <tr bgcolor="#70b0f0" class="table-header">
 218   <td colspan="2" class="table-header">
 219     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 220       <tr valign="top">
 221         <td align="left"><span class="table-header">Method Details</span></td>
 222         <td align="right" valign="top"
 223          ><span class="options">[<a href="#section-MethodDetails"
 224          class="privatelink" onclick="toggle_private();"
 225          >hide private</a>]</span></td>
 226       </tr>
 227     </table>
 228   </td>
 229 </tr>
 230 </table>
 231 <a name="__getattribute__"></a>
 232 <div>
 233 <table class="details" border="1" cellpadding="3"
 234        cellspacing="0" width="100%" bgcolor="white">
 235 <tr><td>
 236   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 237   <tr valign="top"><td>
 238   <h3 class="epydoc"><span class="sig"><span class="sig-name">__getattribute__</span>(<span class="sig-arg">...</span>)</span>
 239   </h3>
 240   </td><td align="right" valign="top"
 241     >&nbsp;
 242     </td>
 243   </tr></table>
 244
 245   x.__getattribute__('name') &lt;==&gt; x.name
 246   <dl class="fields">
 247     <dt>Overrides:
 248         object.__getattribute__
 249     </dt>
 250   </dl>
 251 </td></tr></table>
 252 </div>
 253 <a name="__init__"></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">__init__</span>(<span class="sig-arg">self</span>,
 261         <span class="sig-arg">namespace</span>=<span class="sig-default">None</span>,
 262         <span class="sig-arg">nsmap</span>=<span class="sig-default">None</span>,
 263         <span class="sig-arg">annotate</span>=<span class="sig-default">True</span>,
 264         <span class="sig-arg">makeelement</span>=<span class="sig-default">None</span>)</span>
 265     <br /><em class="fname">(Constructor)</em>
 266   </h3>
 267   </td><td align="right" valign="top"
 268     >&nbsp;
 269     </td>
 270   </tr></table>
 271
 272   x.__init__(...) initializes x; see x.__class__.__doc__ for signature
 273   <dl class="fields">
 274     <dt>Overrides:
 275         object.__init__
 276     </dt>
 277   </dl>
 278 </td></tr></table>
 279 </div>
 280 <a name="__new__"></a>
 281 <div>
 282 <table class="details" border="1" cellpadding="3"
 283        cellspacing="0" width="100%" bgcolor="white">
 284 <tr><td>
 285   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 286   <tr valign="top"><td>
 287   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 288         <span class="sig-arg">S</span>,
 289         <span class="sig-arg">...</span>)</span>
 290   </h3>
 291   </td><td align="right" valign="top"
 292     >&nbsp;
 293     </td>
 294   </tr></table>
 295
 296
 297   <dl class="fields">
 298     <dt>Returns: a new object with type S, a subtype of T</dt>
 299     <dt>Overrides:
 300         object.__new__
 301     </dt>
 302   </dl>
 303 </td></tr></table>
 304 </div>
 305 <br />
 306 <!-- ==================== NAVIGATION BAR ==================== -->
 307 <table class="navbar" border="0" width="100%" cellpadding="0"
 308        bgcolor="#a0c0ff" cellspacing="0">
 309   <tr valign="middle">
 310   <!-- Home link -->
 311       <th>&nbsp;&nbsp;&nbsp;<a
 312         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 313
 314   <!-- Tree link -->
 315       <th>&nbsp;&nbsp;&nbsp;<a
 316         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 317
 318   <!-- Index link -->
 319       <th>&nbsp;&nbsp;&nbsp;<a
 320         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 321
 322   <!-- Help link -->
 323       <th>&nbsp;&nbsp;&nbsp;<a
 324         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 325
 326   <!-- Project homepage -->
 327       <th class="navbar" align="right" width="100%">
 328         <table border="0" cellpadding="0" cellspacing="0">
 329           <tr><th class="navbar" align="center"
 330             ><a class="navbar" target="_top" href="http://codespeak.net/lxml/">lxml API</a></th>
 331           </tr></table></th>
 332   </tr>
 333 </table>
 334 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 335   <tr>
 336     <td align="left" class="footer">
 337     Generated by Epydoc 3.0 on Fri Oct 30 14:51:47 2009
 338     </td>
 339     <td align="right" class="footer">
 340       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 341         >http://epydoc.sourceforge.net</a>
 342     </td>
 343   </tr>
 344 </table>
 345
 346 <script type="text/javascript">
 347   <!--
 348   // Private objects are initially displayed (because if
 349   // javascript is turned off then we want them to be
 350   // visible); but by default, we want to hide them.  So hide
 351   // them unless we have a cookie that says to show them.
 352   checkCookie();
 353   // -->
 354 </script>
 355 </body>
 356 </html>