twisted.manhole.explorer.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.manhole.explorer</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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;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&nbsp;twisted</a> ::
        <a href="twisted.manhole.html">Package&nbsp;manhole</a> ::
        Module&nbsp;explorer
      </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>&nbsp;|&nbsp;<a href="twisted.manhole.explorer.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.manhole.explorer</h2>

<p>Support for python object introspection and exploration.</p>
<p>Note that Explorers, what with their list of attributes, are much like 
manhole.coil.Configurables. Someone should investigate this further. 
(TODO)</p>
Also TODO: Determine how much code in here (particularly the function 
signature stuff) can be replaced with functions available in the 
<code>inspect</code> module available in Python 2.1.
<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.manhole.explorer._MonkeysSetattrMixin.html"><code>_MonkeysSetattrMixin</code></a></b></td>
  <td>A mix-in class providing __setattr__ for objects being watched.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer._WatchMonkey.html"><code>_WatchMonkey</code></a></b></td>
  <td>I hang on a method and tell you what I see.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer.CRUFT_WatchyThingie.html"><code>CRUFT_WatchyThingie</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer.Explorer.html"><code>Explorer</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer.ExplorerBuiltin.html"><code>ExplorerBuiltin</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer.ExplorerClass.html"><code>ExplorerClass</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer.ExplorerFunction.html"><code>ExplorerFunction</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer.ExplorerGeneric.html"><code>ExplorerGeneric</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer.ExplorerImmutable.html"><code>ExplorerImmutable</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer.ExplorerInstance.html"><code>ExplorerInstance</code></a></b></td>
  <td>Attribute groups:</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer.ExplorerMapping.html"><code>ExplorerMapping</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer.ExplorerMethod.html"><code>ExplorerMethod</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer.ExplorerModule.html"><code>ExplorerModule</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer.ExplorerSequence.html"><code>ExplorerSequence</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer.Pool.html"><code>Pool</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.explorer.Signature.html"><code>Signature</code></a></b></td>
  <td>I represent the signature of a callable.</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"><a href="twisted.manhole.explorer.Pool.html" 
          class="link"><code>Pool</code></a></font></td>
<td><b><a href="twisted.manhole.explorer.html#explorerPool"><code>explorerPool</code></a></b> = <span title="{}"><code>{}                                        </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.manhole.explorer.html#False"><code>False</code></a></b> = <span title="0">0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.manhole.explorer.html#True"><code>True</code></a></b> = <span title="1">1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="twisted.manhole.explorer.html#typeTable"><code>typeTable</code></a></b> = <span title="{&lt;type 'instance'&gt;: &lt;class twisted.manhole.explorer.ExplorerInstance at 0x86a0d5c&gt;, &lt;type 'class'&gt;: &lt;class twisted.manhole.explorer.ExplorerClass at 0x84c48b4&gt;, &lt;type 'module'&gt;: &lt;class twisted.manhole.explorer.ExplorerModule at 0x84dac4c&gt;, &lt;type 'long'&gt;: &lt;class twisted.manhole.explorer.ExplorerImmutable at 0x8723ae4&gt;, &lt;type 'dict'&gt;: &lt;class twisted.manhole.explorer.ExplorerMapping at 0x8729094&gt;, &lt;type 'complex'&gt;: &lt;class twisted.manhole.explorer.ExplorerImmutable at 0x8723ae4&gt;, &lt;type 'function'&gt;: &lt;class twisted.manhole.explorer.ExplorerFunction at 0x84c4924&gt;, &lt;type 'list'&gt;: &lt;class twisted.man..."><code>{&lt;type&nbsp;'instance'&gt;:&nbsp;&lt;class&nbsp;twisted.manhole.e<span class="variable-ellipsis">...</span></code>
</span></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="explorerPool"></a>
<h3>explorerPool</h3>
<dl>
  <dt></dt>
  <dd>
    <dl>
      <dt><b>Type:</b></dt>
      <dd>
          <a href="twisted.manhole.explorer.Pool.html" 
          class="link"><code>Pool</code></a>

      </dd>
<span title="{}">      <dt><b>Value:</b></dt>
      <dd><table><tr><td>
<pre class="variable">
{}                                                                     </pre>
        </td></tr></table></dd>
</span>    </dl>
  </dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="False"></a>
<h3>False</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&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
        </td></tr></table></dd>
</span>    </dl>
  </dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="True"></a>
<h3>True</h3>
<dl>
  <dt></dt>
  <dd>
    <dl>
      <dt><b>Type:</b></dt>
      <dd>
          <code>int</code>

      </dd>
<span title="1">      <dt><b>Value:</b></dt>
      <dd><table><tr><td>
<pre class="variable">
1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
        </td></tr></table></dd>
</span>    </dl>
  </dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="typeTable"></a>
<h3>typeTable</h3>
<dl>
  <dt></dt>
  <dd>
    <dl>
      <dt><b>Type:</b></dt>
      <dd>
          <code>dict</code>

      </dd>
<span title="{&lt;type 'instance'&gt;: &lt;class twisted.manhole.explorer.ExplorerInstance at 0x86a0d5c&gt;, &lt;type 'class'&gt;: &lt;class twisted.manhole.explorer.ExplorerClass at 0x84c48b4&gt;, &lt;type 'module'&gt;: &lt;class twisted.manhole.explorer.ExplorerModule at 0x84dac4c&gt;, &lt;type 'long'&gt;: &lt;class twisted.manhole.explorer.ExplorerImmutable at 0x8723ae4&gt;, &lt;type 'dict'&gt;: &lt;class twisted.manhole.explorer.ExplorerMapping at 0x8729094&gt;, &lt;type 'complex'&gt;: &lt;class twisted.manhole.explorer.ExplorerImmutable at 0x8723ae4&gt;, &lt;type 'function'&gt;: &lt;class twisted.manhole.explorer.ExplorerFunction at 0x84c4924&gt;, &lt;type 'list'&gt;: &lt;class twisted.man...">      <dt><b>Value:</b></dt>
      <dd><table><tr><td>
<pre class="variable">
{&lt;type 'NoneType'&gt;: &lt;class twisted.manhole.explorer.ExplorerImmutable <span class="variable-linewrap">\</span>
at 0x8723ae4&gt;,
 &lt;type 'str'&gt;: &lt;class twisted.manhole.explorer.ExplorerImmutable at 0x<span class="variable-linewrap">\</span>
8723ae4&gt;,
 &lt;type 'tuple'&gt;: &lt;class twisted.manhole.explorer.ExplorerSequence at 0<span class="variable-linewrap">\</span>
x867d6e4&gt;,
 &lt;type 'class'&gt;: &lt;class twisted.manhole.explorer.ExplorerClass at 0x84<span class="variable-linewrap">\</span>
c48b4&gt;,
<span class="variable-ellipsis">...</span>                                                                    </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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;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:08:45 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>