<?xml version="1.0" encoding="ascii"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>genshi.builder.ElementFactory</title> <link rel="stylesheet" href="epydoc.css" type="text/css" /> <script type="text/javascript" src="epydoc.js"></script> </head> <body bgcolor="white" text="black" link="blue" vlink="#204080" alink="#204080"> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="genshi-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th> </tr></table></th> </tr> </table> <table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <span class="breadcrumbs"> <a href="genshi-module.html">Package genshi</a> :: <a href="genshi.builder-module.html">Module builder</a> :: Class ElementFactory </span> </td> <td> <table cellpadding="0" cellspacing="0"> <!-- hide/show private --> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class ElementFactory</h1><p class="nomargin-top"></p> <pre class="base-tree"> object --+ | <strong class="uidshort">ElementFactory</strong> </pre> <hr /> <p>Factory for <a href="genshi.builder.Element-class.html" class="link">Element</a> objects.</p> <p>A new element is created simply by accessing a correspondingly named attribute of the factory object:</p> <pre class="py-doctest"> <span class="py-prompt">>>> </span>factory = ElementFactory() <span class="py-prompt">>>> </span><span class="py-keyword">print</span>(factory.foo) <span class="py-output"><foo/></span> <span class="py-output"></span><span class="py-prompt">>>> </span><span class="py-keyword">print</span>(factory.foo(id=2)) <span class="py-output"><foo id="2"/></span></pre> <p>Markup fragments (lists of nodes without a parent element) can be created by calling the factory:</p> <pre class="py-doctest"> <span class="py-prompt">>>> </span><span class="py-keyword">print</span>(factory(<span class="py-string">'Hello, '</span>, factory.em(<span class="py-string">'world'</span>), <span class="py-string">'!'</span>)) <span class="py-output">Hello, <em>world</em>!</span></pre> <p>A factory can also be bound to a specific namespace:</p> <pre class="py-doctest"> <span class="py-prompt">>>> </span>factory = ElementFactory(<span class="py-string">'http://www.w3.org/1999/xhtml'</span>) <span class="py-prompt">>>> </span><span class="py-keyword">print</span>(factory.html(lang=<span class="py-string">"en"</span>)) <span class="py-output"><html xmlns="http://www.w3.org/1999/xhtml" lang="en"/></span></pre> <p>The namespace for a specific element can be altered on an existing factory by specifying the new namespace using item access:</p> <pre class="py-doctest"> <span class="py-prompt">>>> </span>factory = ElementFactory() <span class="py-prompt">>>> </span><span class="py-keyword">print</span>(factory.html(factory[<span class="py-string">'http://www.w3.org/2000/svg'</span>].g(id=3))) <span class="py-output"><html><g xmlns="http://www.w3.org/2000/svg" id="3"/></html></span></pre> <p>Usually, the <a href="genshi.builder.ElementFactory-class.html" class="link">ElementFactory</a> class is not be used directly. Rather, the <a href="genshi.builder-module.html#tag" class="link">tag</a> instance should be used to create elements.</p> <!-- ==================== INSTANCE METHODS ==================== --> <a name="section-InstanceMethods"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Instance Methods</span></td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="genshi.builder.ElementFactory-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">namespace</span>=<span class="summary-sig-default">None</span>)</span><br /> Create the factory, optionally bound to the given namespace.</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><a href="genshi.builder.Fragment-class.html" class="link">Fragment</a></span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="genshi.builder.ElementFactory-class.html#__call__" class="summary-sig-name">__call__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">*args</span>)</span><br /> Create a fragment that has the given positional arguments as child nodes.</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><a href="genshi.builder.ElementFactory-class.html" class="link">ElementFactory</a></span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="genshi.builder.ElementFactory-class.html#__getitem__" class="summary-sig-name">__getitem__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">namespace</span>)</span><br /> Return a new factory that is bound to the specified namespace.</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><a href="genshi.builder.Element-class.html" class="link">Element</a></span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="genshi.builder.ElementFactory-class.html#__getattr__" class="summary-sig-name">__getattr__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">name</span>)</span><br /> Create an <a href="genshi.builder.Element-class.html" class="link">Element</a> with the given name.</td> <td align="right" valign="top"> </td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__delattr__</code>, <code>__format__</code>, <code>__getattribute__</code>, <code>__hash__</code>, <code>__new__</code>, <code>__reduce__</code>, <code>__reduce_ex__</code>, <code>__repr__</code>, <code>__setattr__</code>, <code>__sizeof__</code>, <code>__str__</code>, <code>__subclasshook__</code> </p> </td> </tr> </table> <!-- ==================== PROPERTIES ==================== --> <a name="section-Properties"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Properties</span></td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__class__</code> </p> </td> </tr> </table> <!-- ==================== METHOD DETAILS ==================== --> <a name="section-MethodDetails"></a> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td align="left" colspan="2" class="table-header"> <span class="table-header">Method Details</span></td> </tr> </table> <a name="__init__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">namespace</span>=<span class="sig-default">None</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" > </td> </tr></table> Create the factory, optionally bound to the given namespace. <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>namespace</code></strong> - the namespace URI for any created elements, or <code class="link">None</code> for no namespace</li> </ul></dd> <dt>Overrides: object.__init__ </dt> </dl> </td></tr></table> </div> <a name="__call__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__call__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">*args</span>)</span> <br /><em class="fname">(Call operator)</em> </h3> </td><td align="right" valign="top" > </td> </tr></table> Create a fragment that has the given positional arguments as child nodes. <dl class="fields"> <dt>Returns: <a href="genshi.builder.Fragment-class.html" class="link">Fragment</a></dt> <dd>the created <a href="genshi.builder.Fragment-class.html" class="link">Fragment</a></dd> </dl> </td></tr></table> </div> <a name="__getitem__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__getitem__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">namespace</span>)</span> <br /><em class="fname">(Indexing operator)</em> </h3> </td><td align="right" valign="top" > </td> </tr></table> Return a new factory that is bound to the specified namespace. <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>namespace</code></strong> - the namespace URI or <a href="genshi.core.Namespace-class.html" class="link">Namespace</a> object</li> </ul></dd> <dt>Returns: <a href="genshi.builder.ElementFactory-class.html" class="link">ElementFactory</a></dt> <dd>an <a href="genshi.builder.ElementFactory-class.html" class="link">ElementFactory</a> that produces elements bound to the given namespace</dd> </dl> </td></tr></table> </div> <a name="__getattr__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__getattr__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">name</span>)</span> <br /><em class="fname">(Qualification operator)</em> </h3> </td><td align="right" valign="top" > </td> </tr></table> Create an <a href="genshi.builder.Element-class.html" class="link">Element</a> with the given name. <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>name</code></strong> - the tag name of the element to create</li> </ul></dd> <dt>Returns: <a href="genshi.builder.Element-class.html" class="link">Element</a></dt> <dd>an <a href="genshi.builder.Element-class.html" class="link">Element</a> with the specified name</dd> </dl> </td></tr></table> </div> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="genshi-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <!-- Project homepage --> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center" ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th> </tr></table></th> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> Generated by Epydoc 3.0.1 on Sun Jan 27 18:17:20 2013 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" >http://epydoc.sourceforge.net</a> </td> </tr> </table> <script type="text/javascript"> <!-- // Private objects are initially displayed (because if // javascript is turned off then we want them to be // visible); but by default, we want to hide them. So hide // them unless we have a cookie that says to show them. checkCookie(); // --> </script> </body> </html>