twisted.python.components.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!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>twisted.python.components</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.python.html">Package python</a> ::
Module components
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.python.components.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.python.components</h2>
Component architecture for Twisted.
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="twisted.python.components._NoImplementor.html"><code>_NoImplementor</code></a></b></td>
<td>Same as _Nothing but used by MetaInterface.__call__</td></tr>
<tr><td width="15%">
<b><a href="twisted.python.components._Nothing.html"><code>_Nothing</code></a></b></td>
<td>An alternative to None - default value for functions which raise if
default not passed.</td></tr>
<tr><td width="15%">
<b><a href="twisted.python.components._Wrapper.html"><code>_Wrapper</code></a></b></td>
<td>Makes any object be able to be dict key.</td></tr>
<tr><td width="15%">
<b><a href="twisted.python.components.Adapter.html"><code>Adapter</code></a></b></td>
<td>I am the default implementation of an Adapter for some interface.</td></tr>
<tr><td width="15%">
<b><a href="twisted.python.components.AdapterRegistry.html"><code>AdapterRegistry</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.python.components.Componentized.html"><code>Componentized</code></a></b></td>
<td>I am a mixin to allow you to be adapted in various ways
persistently.</td></tr>
<tr><td width="15%">
<b><a href="twisted.python.components.Interface.html"><code>Interface</code></a></b></td>
<td>Base class for interfaces.</td></tr>
<tr><td width="15%">
<b><a href="twisted.python.components.MetaInterface.html"><code>MetaInterface</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.python.components.ReprableComponentized.html"><code>ReprableComponentized</code></a></b></td>
<td> </td></tr>
</table><br />
<!-- =========== START OF EXCEPTIONS =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Exceptions</th></tr>
<tr><td width="15%">
<b><a href="twisted.python.components.CannotAdapt.html"><code>CannotAdapt</code></a></b></td>
<td>Can't adapt some object to some Interface.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="classToInterfaces"></a><span class="summary-sig"><span class="summary-sig-name">classToInterfaces</span>(<span class=summary-sig-arg>k</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.components.html#getInterfaces" class="summary-sig-name"><code>getInterfaces</code></a>(<span class=summary-sig-arg>obj</span>,
<span class=summary-sig-arg>attr</span>)</span></code>
<br />
Return list of all interfaces an object implements, using a particular
attribute name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getRegistry"></a><span class="summary-sig"><span class="summary-sig-name">getRegistry</span>(<span class=summary-sig-arg>r</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.components.html#implements" class="summary-sig-name"><code>implements</code></a>(<span class=summary-sig-arg>obj</span>,
<span class=summary-sig-arg>interfaceClass</span>)</span></code>
<br />
Return boolean indicating if obj implements the given interface.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.components.html#superInterfaces" class="summary-sig-name"><code>superInterfaces</code></a>(<span class=summary-sig-arg>interface</span>)</span></code>
<br />
Given an interface, return list of super-interfaces (including
itself).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.components.html#tupleTreeToList" class="summary-sig-name"><code>tupleTreeToList</code></a>(<span class=summary-sig-arg>t</span>,
<span class=summary-sig-arg>l</span>)</span></code>
<br />
Convert an instance, or tree of tuples, into list.</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.python.components.html#ALLOW_DUPLICATES"><code>ALLOW_DUPLICATES</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>instance method</code></font></td>
<td><a name="getAdapter"></a><b><code>getAdapter</code></b> = <a href="twisted.python.components.AdapterRegistry.html#getAdapter"><code>twisted.python.components.AdapterRegistry.getAdapter</code></a></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>instance method</code></font></td>
<td><a name="getAdapterClass"></a><b><code>getAdapterClass</code></b> = <a href="twisted.python.components.AdapterRegistry.html#getAdapterFactory"><code>twisted.python.components.AdapterRegistry.getAdapterFactory</code></a></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>instance method</code></font></td>
<td><a name="getAdapterClassWithInheritance"></a><b><code>getAdapterClassWithInheritance</code></b> = <a href="twisted.python.components.AdapterRegistry.html#getAdapterClassWithInheritance"><code>twisted.python.components.AdapterRegistry.getAdapterClassWithInheritance</code></a></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>instance method</code></font></td>
<td><a name="registerAdapter"></a><b><code>registerAdapter</code></b> = <a href="twisted.python.components.AdapterRegistry.html#registerAdapter"><code>twisted.python.components.AdapterRegistry.registerAdapter</code></a></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><a href="twisted.python.components.AdapterRegistry.html"
class="link"><code>AdapterRegistry</code></a></font></td>
<td><b><a href="twisted.python.components.html#theAdapterRegistry"><code>theAdapterRegistry</code></a></b> = <span title="<twisted.python.components.AdapterRegistry instance at 0x81989cc>"><code><twisted.python.components.AdapterR<span class="variable-ellipsis">...</span></code>
</span></td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="getInterfaces"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getInterfaces</span>(<span class=sig-arg>obj</span>,
<span class=sig-arg>attr</span>=<span class=sig-default>'__implements__'</span>)</span>
</h3>
Return list of all interfaces an object implements, using a
particular attribute name. For example, if you wish to discover what
interfaces a class implements directly, pass '__class_implements__' as
the attribute name.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="implements"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">implements</span>(<span class=sig-arg>obj</span>,
<span class=sig-arg>interfaceClass</span>)</span>
</h3>
Return boolean indicating if obj implements the given interface.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="superInterfaces"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">superInterfaces</span>(<span class=sig-arg>interface</span>)</span>
</h3>
Given an interface, return list of super-interfaces (including
itself).
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="tupleTreeToList"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">tupleTreeToList</span>(<span class=sig-arg>t</span>,
<span class=sig-arg>l</span>=<span class=sig-default>None</span>)</span>
</h3>
Convert an instance, or tree of tuples, into list.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="ALLOW_DUPLICATES"></a>
<h3>ALLOW_DUPLICATES</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="0"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
0 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="theAdapterRegistry"></a>
<h3>theAdapterRegistry</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<a href="twisted.python.components.AdapterRegistry.html"
class="link"><code>AdapterRegistry</code></a>
</dd>
<span title="<twisted.python.components.AdapterRegistry instance at 0x81989cc>"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<twisted.python.components.AdapterRegistry instance at 0x81989cc> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:07:55 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>