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