twisted.manhole.service.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.service</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;service
      </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.service.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

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

<a href="twisted.manhole.html" 
class="link"><code>twisted.manhole</code></a> <a 
href="twisted.spread.pb.html" class="link"><code>PB</code></a> service 
implementation.
<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.service.FakeStdIO.html"><code>FakeStdIO</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.service.IManholeClient.html"><code>IManholeClient</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.service.Perspective.html"><code>Perspective</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.service.Realm.html"><code>Realm</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.manhole.service.Service.html"><code>Service</code></a></b></td>
  <td>&nbsp;</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">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.manhole.service.html#_failureOldStyle" class="summary-sig-name"><code>_failureOldStyle</code></a>(<span class=summary-sig-arg>fail</span>)</span></code>
<br />
Pre-Failure manhole representation of exceptions.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.manhole.service.html#runInConsole" class="summary-sig-name"><code>runInConsole</code></a>(<span class=summary-sig-arg>command</span>,
          <span class=summary-sig-arg>console</span>,
          <span class=summary-sig-arg>globalNS</span>,
          <span class=summary-sig-arg>localNS</span>,
          <span class=summary-sig-arg>filename</span>,
          <span class=summary-sig-arg>args</span>,
          <span class=summary-sig-arg>kw</span>,
          <span class=summary-sig-arg>unsafeTracebacks</span>)</span></code>
<br />
Run this, directing all output to the specified console.</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>dict</code></font></td>
<td><b><a href="twisted.manhole.service.html#_defaultCapabilities"><code>_defaultCapabilities</code></a></b> = <span title="{'Explorer': 'Set'}"><code>{'Explorer':&nbsp;'Set'}               </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="_failureOldStyle"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">_failureOldStyle</span>(<span class=sig-arg>fail</span>)</span>
  </h3>
  <p>Pre-Failure manhole representation of exceptions.</p>
  <p>For compatibility with manhole clients without the 
  &quot;Failure&quot; capability.</p>
  A dictionary with two members:
  <ul>
    <li>
      'traceback' -- traceback.extract_tb output; a list of tuples 
      (filename, line number, function name, text) suitable for feeding 
      to traceback.format_list.
    </li>
    <li>
      'exception' -- a list of one or more strings, each ending in a 
      newline. (traceback.format_exception_only output)
    </li>
  </ul>
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="runInConsole"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">runInConsole</span>(<span class=sig-arg>command</span>,
          <span class=sig-arg>console</span>,
          <span class=sig-arg>globalNS</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>localNS</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>filename</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>args</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>kw</span>=<span class=sig-default>None</span>,
          <span class=sig-arg>unsafeTracebacks</span>=<span class=sig-default>0</span>)</span>
  </h3>
  <p>Run this, directing all output to the specified console.</p>
  <p>If command is callable, it will be called with the args and keywords 
  provided. Otherwise, command will be compiled and eval'd. (Wouldn't you 
  like a macro?)</p>
  <p>Returns the command's return value.</p>
  The console is called with a list of (type, message) pairs for 
  display, see <a href="twisted.manhole.service.html#console" 
  class="link"><code>IManholeClient.console</code></a>.
  <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="_defaultCapabilities"></a>
<h3>_defaultCapabilities</h3>
<dl>
  <dt></dt>
  <dd>
    <dl>
      <dt><b>Type:</b></dt>
      <dd>
          <code>dict</code>

      </dd>
<span title="{'Explorer': 'Set'}">      <dt><b>Value:</b></dt>
      <dd><table><tr><td>
<pre class="variable">
{'Explorer': 'Set'}                                                    </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:08 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>