EVOLUTION-MANAGER
Edit File: factory.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Factories — zope.configuration 4.0 documentation</title> <link rel="stylesheet" href="_static/default.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '', VERSION: '4.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <link rel="top" title="zope.configuration 4.0 documentation" href="index.html" /> <link rel="next" title="Persistent Component Management" href="persistentregistry.html" /> <link rel="prev" title="Events" href="event.html" /> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="persistentregistry.html" title="Persistent Component Management" accesskey="N">next</a> |</li> <li class="right" > <a href="event.html" title="Events" accesskey="P">previous</a> |</li> <li><a href="index.html">zope.configuration 4.0 documentation</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="factories"> <h1>Factories<a class="headerlink" href="#factories" title="Permalink to this headline">¶</a></h1> <div class="section" id="the-factory-class"> <h2>The Factory Class<a class="headerlink" href="#the-factory-class" title="Permalink to this headline">¶</a></h2> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.interface</span> <span class="kn">import</span> <span class="n">Interface</span> <span class="gp">>>> </span><span class="k">class</span> <span class="nc">IFunction</span><span class="p">(</span><span class="n">Interface</span><span class="p">):</span> <span class="gp">... </span> <span class="k">pass</span> <span class="gp">>>> </span><span class="k">class</span> <span class="nc">IKlass</span><span class="p">(</span><span class="n">Interface</span><span class="p">):</span> <span class="gp">... </span> <span class="k">pass</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.interface</span> <span class="kn">import</span> <span class="n">implements</span> <span class="gp">>>> </span><span class="k">class</span> <span class="nc">Klass</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> <span class="gp">... </span> <span class="n">implements</span><span class="p">(</span><span class="n">IKlass</span><span class="p">)</span> <span class="gp">...</span> <span class="gp">... </span> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span> <span class="c">#*</span> <span class="gp">... </span> <span class="bp">self</span><span class="o">.</span><span class="n">args</span> <span class="o">=</span> <span class="n">args</span> <span class="gp">... </span> <span class="bp">self</span><span class="o">.</span><span class="n">kw</span> <span class="o">=</span> <span class="n">kw</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.factory</span> <span class="kn">import</span> <span class="n">Factory</span> <span class="gp">>>> </span><span class="n">factory</span> <span class="o">=</span> <span class="n">Factory</span><span class="p">(</span><span class="n">Klass</span><span class="p">,</span> <span class="s">'Klass'</span><span class="p">,</span> <span class="s">'Klassier'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">factory2</span> <span class="o">=</span> <span class="n">Factory</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">,</span> <span class="s">'Func'</span><span class="p">,</span> <span class="s">'Function'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">factory3</span> <span class="o">=</span> <span class="n">Factory</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="p">,</span> <span class="s">'Func'</span><span class="p">,</span> <span class="s">'Function'</span><span class="p">,</span> <span class="p">(</span><span class="n">IFunction</span><span class="p">,))</span> </pre></div> </div> <div class="section" id="calling-a-factory"> <h3>Calling a Factory<a class="headerlink" href="#calling-a-factory" title="Permalink to this headline">¶</a></h3> <p>Here we test whether the factory correctly creates the objects and including the correct handling of constructor elements.</p> <p>First we create a factory that creates instanace of the <cite>Klass</cite> class:</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">factory</span> <span class="o">=</span> <span class="n">Factory</span><span class="p">(</span><span class="n">Klass</span><span class="p">,</span> <span class="s">'Klass'</span><span class="p">,</span> <span class="s">'Klassier'</span><span class="p">)</span> </pre></div> </div> <p>Now we use the factory to create the instance</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">kl</span> <span class="o">=</span> <span class="n">factory</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="n">foo</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">bar</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span> </pre></div> </div> <p>and make sure that the correct class was used to create the object:</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">kl</span><span class="o">.</span><span class="n">__class__</span> <span class="go"><class 'Klass'></span> </pre></div> </div> <p>Since we passed in a couple positional and keyword arguments</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">kl</span><span class="o">.</span><span class="n">args</span> <span class="go">(1, 2)</span> <span class="gp">>>> </span><span class="n">kl</span><span class="o">.</span><span class="n">kw</span> <span class="go">{'foo': 3, 'bar': 4}</span> <span class="gp">>>> </span><span class="n">factory2</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="go">3</span> <span class="gp">>>> </span><span class="n">factory3</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> <span class="go">3</span> </pre></div> </div> </div> <div class="section" id="title-and-description"> <h3>Title and Description<a class="headerlink" href="#title-and-description" title="Permalink to this headline">¶</a></h3> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">factory</span><span class="o">.</span><span class="n">title</span> <span class="go">'Klass'</span> <span class="gp">>>> </span><span class="n">factory</span><span class="o">.</span><span class="n">description</span> <span class="go">'Klassier'</span> <span class="gp">>>> </span><span class="n">factory2</span><span class="o">.</span><span class="n">title</span> <span class="go">'Func'</span> <span class="gp">>>> </span><span class="n">factory2</span><span class="o">.</span><span class="n">description</span> <span class="go">'Function'</span> <span class="gp">>>> </span><span class="n">factory3</span><span class="o">.</span><span class="n">title</span> <span class="go">'Func'</span> <span class="gp">>>> </span><span class="n">factory3</span><span class="o">.</span><span class="n">description</span> <span class="go">'Function'</span> </pre></div> </div> </div> <div class="section" id="provided-interfaces"> <h3>Provided Interfaces<a class="headerlink" href="#provided-interfaces" title="Permalink to this headline">¶</a></h3> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">implemented</span> <span class="o">=</span> <span class="n">factory</span><span class="o">.</span><span class="n">getInterfaces</span><span class="p">()</span> <span class="gp">>>> </span><span class="n">implemented</span><span class="o">.</span><span class="n">isOrExtends</span><span class="p">(</span><span class="n">IKlass</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">implemented</span><span class="p">)</span> <span class="go">[<InterfaceClass __builtin__.IKlass>]</span> <span class="gp">>>> </span><span class="n">implemented2</span> <span class="o">=</span> <span class="n">factory2</span><span class="o">.</span><span class="n">getInterfaces</span><span class="p">()</span> <span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">implemented2</span><span class="p">)</span> <span class="go">[]</span> <span class="gp">>>> </span><span class="n">implemented3</span> <span class="o">=</span> <span class="n">factory3</span><span class="o">.</span><span class="n">getInterfaces</span><span class="p">()</span> <span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">implemented3</span><span class="p">)</span> <span class="go">[<InterfaceClass __builtin__.IFunction>]</span> </pre></div> </div> </div> </div> <div class="section" id="the-component-architecture-factory-api"> <h2>The Component Architecture Factory API<a class="headerlink" href="#the-component-architecture-factory-api" title="Permalink to this headline">¶</a></h2> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">zope.component</span> <span class="gp">>>> </span><span class="n">factory</span> <span class="o">=</span> <span class="n">Factory</span><span class="p">(</span><span class="n">Klass</span><span class="p">,</span> <span class="s">'Klass'</span><span class="p">,</span> <span class="s">'Klassier'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">gsm</span> <span class="o">=</span> <span class="n">zope</span><span class="o">.</span><span class="n">component</span><span class="o">.</span><span class="n">getGlobalSiteManager</span><span class="p">()</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.interfaces</span> <span class="kn">import</span> <span class="n">IFactory</span> <span class="gp">>>> </span><span class="n">gsm</span><span class="o">.</span><span class="n">registerUtility</span><span class="p">(</span><span class="n">factory</span><span class="p">,</span> <span class="n">IFactory</span><span class="p">,</span> <span class="s">'klass'</span><span class="p">)</span> </pre></div> </div> <div class="section" id="creating-an-object"> <h3>Creating an Object<a class="headerlink" href="#creating-an-object" title="Permalink to this headline">¶</a></h3> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">kl</span> <span class="o">=</span> <span class="n">zope</span><span class="o">.</span><span class="n">component</span><span class="o">.</span><span class="n">createObject</span><span class="p">(</span><span class="s">'klass'</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="n">foo</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">bar</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span> <span class="gp">>>> </span><span class="nb">isinstance</span><span class="p">(</span><span class="n">kl</span><span class="p">,</span> <span class="n">Klass</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="n">kl</span><span class="o">.</span><span class="n">args</span> <span class="go">(1, 2)</span> <span class="gp">>>> </span><span class="n">kl</span><span class="o">.</span><span class="n">kw</span> <span class="go">{'foo': 3, 'bar': 4}</span> </pre></div> </div> </div> <div class="section" id="accessing-provided-interfaces"> <h3>Accessing Provided Interfaces<a class="headerlink" href="#accessing-provided-interfaces" title="Permalink to this headline">¶</a></h3> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">implemented</span> <span class="o">=</span> <span class="n">zope</span><span class="o">.</span><span class="n">component</span><span class="o">.</span><span class="n">getFactoryInterfaces</span><span class="p">(</span><span class="s">'klass'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">implemented</span><span class="o">.</span><span class="n">isOrExtends</span><span class="p">(</span><span class="n">IKlass</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="p">[</span><span class="n">iface</span> <span class="k">for</span> <span class="n">iface</span> <span class="ow">in</span> <span class="n">implemented</span><span class="p">]</span> <span class="go">[<InterfaceClass __builtin__.IKlass>]</span> </pre></div> </div> </div> <div class="section" id="list-of-all-factories"> <h3>List of All Factories<a class="headerlink" href="#list-of-all-factories" title="Permalink to this headline">¶</a></h3> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="p">[(</span><span class="n">name</span><span class="p">,</span> <span class="n">fac</span><span class="o">.</span><span class="n">__class__</span><span class="p">)</span> <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">fac</span> <span class="ow">in</span> <span class="gp">... </span> <span class="n">zope</span><span class="o">.</span><span class="n">component</span><span class="o">.</span><span class="n">getFactoriesFor</span><span class="p">(</span><span class="n">IKlass</span><span class="p">)]</span> <span class="go">[(u'klass', <class 'zope.component.factory.Factory'>)]</span> </pre></div> </div> </div> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Factories</a><ul> <li><a class="reference internal" href="#the-factory-class">The Factory Class</a><ul> <li><a class="reference internal" href="#calling-a-factory">Calling a Factory</a></li> <li><a class="reference internal" href="#title-and-description">Title and Description</a></li> <li><a class="reference internal" href="#provided-interfaces">Provided Interfaces</a></li> </ul> </li> <li><a class="reference internal" href="#the-component-architecture-factory-api">The Component Architecture Factory API</a><ul> <li><a class="reference internal" href="#creating-an-object">Creating an Object</a></li> <li><a class="reference internal" href="#accessing-provided-interfaces">Accessing Provided Interfaces</a></li> <li><a class="reference internal" href="#list-of-all-factories">List of All Factories</a></li> </ul> </li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="event.html" title="previous chapter">Events</a></p> <h4>Next topic</h4> <p class="topless"><a href="persistentregistry.html" title="next chapter">Persistent Component Management</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="_sources/factory.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="persistentregistry.html" title="Persistent Component Management" >next</a> |</li> <li class="right" > <a href="event.html" title="Events" >previous</a> |</li> <li><a href="index.html">zope.configuration 4.0 documentation</a> »</li> </ul> </div> <div class="footer"> © Copyright 2012, Zope Foundation Contributors. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>