EVOLUTION-MANAGER
Edit File: interface.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>Interface Registration APIs — 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="up" title="zope.component API Reference" href="../api.html" /> <link rel="next" title="Security APIs" href="security.html" /> <link rel="prev" title="Factory APIs" href="factory.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="security.html" title="Security APIs" accesskey="N">next</a> |</li> <li class="right" > <a href="factory.html" title="Factory APIs" accesskey="P">previous</a> |</li> <li><a href="../index.html">zope.configuration 4.0 documentation</a> »</li> <li><a href="../api.html" accesskey="U"><tt class="docutils literal"><span class="pre">zope.component</span></tt> API Reference</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="interface-registration-apis"> <h1>Interface Registration APIs<a class="headerlink" href="#interface-registration-apis" title="Permalink to this headline">¶</a></h1> <div class="section" id="registering-interfaces-as-utilities"> <h2>Registering Interfaces as Utilities<a class="headerlink" href="#registering-interfaces-as-utilities" title="Permalink to this headline">¶</a></h2> <p>We can register a given interface with the global site manager as a utility. First, declare a new interface, which itself provides only the core API, <tt class="xref py py-class docutils literal"><span class="pre">zope.interface.interfaces.IInterface</span></tt>:</p> <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="kn">from</span> <span class="nn">zope.interface.interfaces</span> <span class="kn">import</span> <span class="n">IInterface</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.tests.examples</span> <span class="kn">import</span> <span class="n">ITestType</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component</span> <span class="kn">import</span> <span class="n">getGlobalSiteManager</span> <span class="gp">>>> </span><span class="n">gsm</span> <span class="o">=</span> <span class="n">getGlobalSiteManager</span><span class="p">()</span> <span class="gp">>>> </span><span class="k">class</span> <span class="nc">IDemo</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="n">IInterface</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">IDemo</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="n">ITestType</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">IDemo</span><span class="p">)</span> <span class="go">False</span> <span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">gsm</span><span class="o">.</span><span class="n">getUtilitiesFor</span><span class="p">(</span><span class="n">ITestType</span><span class="p">))</span> <span class="go">[]</span> </pre></div> </div> <p>Now, register <tt class="docutils literal"><span class="pre">IDemo</span></tt> as providing <tt class="docutils literal"><span class="pre">ITestType</span></tt></p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.interface</span> <span class="kn">import</span> <span class="n">provideInterface</span> <span class="gp">>>> </span><span class="n">provideInterface</span><span class="p">(</span><span class="s">''</span><span class="p">,</span> <span class="n">IDemo</span><span class="p">,</span> <span class="n">ITestType</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">ITestType</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">IDemo</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="n">interfaces</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">gsm</span><span class="o">.</span><span class="n">getUtilitiesFor</span><span class="p">(</span><span class="n">ITestType</span><span class="p">))</span> <span class="gp">>>> </span><span class="p">[</span><span class="n">iface</span><span class="o">.</span><span class="n">__name__</span> <span class="k">for</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">iface</span><span class="p">)</span> <span class="ow">in</span> <span class="n">interfaces</span><span class="p">]</span> <span class="go">['IDemo']</span> </pre></div> </div> <p>We can register <tt class="docutils literal"><span class="pre">IDemo</span></tt> as providing more than one interface:</p> <div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">class</span> <span class="nc">IOtherType</span><span class="p">(</span><span class="n">IInterface</span><span class="p">):</span> <span class="gp">... </span> <span class="k">pass</span> <span class="gp">>>> </span><span class="n">provideInterface</span><span class="p">(</span><span class="s">''</span><span class="p">,</span> <span class="n">IDemo</span><span class="p">,</span> <span class="n">IOtherType</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">ITestType</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">IDemo</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="n">IOtherType</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">IDemo</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="n">interfaces</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">gsm</span><span class="o">.</span><span class="n">getUtilitiesFor</span><span class="p">(</span><span class="n">ITestType</span><span class="p">))</span> <span class="gp">>>> </span><span class="p">[</span><span class="n">iface</span><span class="o">.</span><span class="n">__name__</span> <span class="k">for</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">iface</span><span class="p">)</span> <span class="ow">in</span> <span class="n">interfaces</span><span class="p">]</span> <span class="go">['IDemo']</span> <span class="gp">>>> </span><span class="n">interfaces</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">gsm</span><span class="o">.</span><span class="n">getUtilitiesFor</span><span class="p">(</span><span class="n">IOtherType</span><span class="p">))</span> <span class="gp">>>> </span><span class="p">[</span><span class="n">iface</span><span class="o">.</span><span class="n">__name__</span> <span class="k">for</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">iface</span><span class="p">)</span> <span class="ow">in</span> <span class="n">interfaces</span><span class="p">]</span> <span class="go">['IDemo']</span> </pre></div> </div> <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="kn">from</span> <span class="nn">zope.component.interface</span> <span class="kn">import</span> <span class="n">getInterface</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.tests.examples</span> <span class="kn">import</span> <span class="n">ITestType</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.tests.examples</span> <span class="kn">import</span> <span class="n">IGI</span> <span class="gp">>>> </span><span class="n">IInterface</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">IGI</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="n">ITestType</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">IGI</span><span class="p">)</span> <span class="go">False</span> <span class="gp">>>> </span><span class="n">getInterface</span><span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="s">'zope.component.tests.examples.IGI'</span><span class="p">)</span> <span class="gt">Traceback (most recent call last):</span> <span class="c">...</span> <span class="gr">ComponentLookupError</span>: <span class="n">zope.component.tests.examples.interface.IGI</span> <span class="gp">>>> </span><span class="n">provideInterface</span><span class="p">(</span><span class="s">''</span><span class="p">,</span> <span class="n">IGI</span><span class="p">,</span> <span class="n">ITestType</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">ITestType</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">IGI</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="n">iface</span> <span class="o">=</span> <span class="n">getInterface</span><span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="gp">... </span> <span class="s">'zope.component.tests.examples.IGI'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">iface</span><span class="o">.</span><span class="n">__name__</span> <span class="go">'IGI'</span> </pre></div> </div> <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="kn">from</span> <span class="nn">zope.interface.interfaces</span> <span class="kn">import</span> <span class="n">IInterface</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.interface</span> <span class="kn">import</span> <span class="n">queryInterface</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.tests.examples</span> <span class="kn">import</span> <span class="n">ITestType</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.tests.examples</span> <span class="kn">import</span> <span class="n">IQI</span> <span class="gp">>>> </span><span class="n">IInterface</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">IQI</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="n">ITestType</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">IQI</span><span class="p">)</span> <span class="go">False</span> <span class="gp">>>> </span><span class="n">queryInterface</span><span class="p">(</span><span class="s">'zope.component.tests.examples.IQI'</span><span class="p">)</span> <span class="ow">is</span> <span class="bp">None</span> <span class="go">True</span> <span class="gp">>>> </span><span class="n">provideInterface</span><span class="p">(</span><span class="s">''</span><span class="p">,</span> <span class="n">IQI</span><span class="p">,</span> <span class="n">ITestType</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">ITestType</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">IQI</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="n">iface</span> <span class="o">=</span> <span class="n">queryInterface</span><span class="p">(</span><span class="s">'zope.component.tests.examples.IQI'</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">iface</span><span class="o">.</span><span class="n">__name__</span> <span class="go">'IQI'</span> </pre></div> </div> <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="kn">from</span> <span class="nn">zope.interface.interfaces</span> <span class="kn">import</span> <span class="n">IInterface</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.interface</span> <span class="kn">import</span> <span class="n">searchInterface</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.tests.examples</span> <span class="kn">import</span> <span class="n">ITestType</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.tests.examples</span> <span class="kn">import</span> <span class="n">ISI</span> <span class="gp">>>> </span><span class="n">IInterface</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">ISI</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="n">ITestType</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">ISI</span><span class="p">)</span> <span class="go">False</span> <span class="gp">>>> </span><span class="n">searchInterface</span><span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="s">'zope.component.tests.examples.ISI'</span><span class="p">)</span> <span class="go">[]</span> <span class="gp">>>> </span><span class="n">provideInterface</span><span class="p">(</span><span class="s">''</span><span class="p">,</span> <span class="n">ISI</span><span class="p">,</span> <span class="n">ITestType</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">ITestType</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">ISI</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="n">searchInterface</span><span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="s">'zope.component.tests.examples.ISI'</span><span class="p">)</span> <span class="o">==</span> <span class="p">[</span><span class="n">ISI</span><span class="p">]</span> <span class="go">True</span> </pre></div> </div> <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="kn">from</span> <span class="nn">zope.interface.interfaces</span> <span class="kn">import</span> <span class="n">IInterface</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.interface</span> <span class="kn">import</span> <span class="n">searchInterfaceIds</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.tests.examples</span> <span class="kn">import</span> <span class="n">ITestType</span> <span class="gp">>>> </span><span class="kn">from</span> <span class="nn">zope.component.tests.examples</span> <span class="kn">import</span> <span class="n">ISII</span> <span class="gp">>>> </span><span class="n">IInterface</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">ISII</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="n">ITestType</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">ISII</span><span class="p">)</span> <span class="go">False</span> <span class="gp">>>> </span><span class="n">searchInterfaceIds</span><span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="s">'zope.component.tests.examples.ISII'</span><span class="p">)</span> <span class="go">[]</span> <span class="gp">>>> </span><span class="n">provideInterface</span><span class="p">(</span><span class="s">''</span><span class="p">,</span> <span class="n">ISII</span><span class="p">,</span> <span class="n">ITestType</span><span class="p">)</span> <span class="gp">>>> </span><span class="n">ITestType</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">ISII</span><span class="p">)</span> <span class="go">True</span> <span class="gp">>>> </span><span class="n">searchInterfaceIds</span><span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="s">'zope.component.tests.examples.ISII'</span><span class="p">)</span> <span class="go">[u'zope.component.tests.examples.ISII']</span> </pre></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="#">Interface Registration APIs</a><ul> <li><a class="reference internal" href="#registering-interfaces-as-utilities">Registering Interfaces as Utilities</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="factory.html" title="previous chapter">Factory APIs</a></p> <h4>Next topic</h4> <p class="topless"><a href="security.html" title="next chapter">Security APIs</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/api/interface.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="security.html" title="Security APIs" >next</a> |</li> <li class="right" > <a href="factory.html" title="Factory APIs" >previous</a> |</li> <li><a href="../index.html">zope.configuration 4.0 documentation</a> »</li> <li><a href="../api.html" ><tt class="docutils literal"><span class="pre">zope.component</span></tt> API Reference</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>