twisted.trial.util.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.trial.util</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.trial.html">Package trial</a> ::
Module util
</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.trial.util.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.trial.util</h2>
<!-- =========== 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="_append"></a><span class="summary-sig"><span class="summary-sig-name">_append</span>(<span class=summary-sig-arg>result</span>,
<span class=summary-sig-arg>lst</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_getDeferredResult"></a><span class="summary-sig"><span class="summary-sig-name">_getDeferredResult</span>(<span class=summary-sig-arg>d</span>,
<span class=summary-sig-arg>timeout</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.trial.util.html#deferredError" class="summary-sig-name"><code>deferredError</code></a>(<span class=summary-sig-arg>d</span>,
<span class=summary-sig-arg>timeout</span>)</span></code>
<br />
Waits for deferred to fail, and it returns the Failure.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.trial.util.html#deferredResult" class="summary-sig-name"><code>deferredResult</code></a>(<span class=summary-sig-arg>d</span>,
<span class=summary-sig-arg>timeout</span>)</span></code>
<br />
Waits for a Deferred to arrive, then returns or throws an exception,
based on the result.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.trial.util.html#extract_tb" class="summary-sig-name"><code>extract_tb</code></a>(<span class=summary-sig-arg>tb</span>,
<span class=summary-sig-arg>limit</span>)</span></code>
<br />
Extract a list of frames from a traceback, without unittest
internals.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.trial.util.html#format_exception" class="summary-sig-name"><code>format_exception</code></a>(<span class=summary-sig-arg>eType</span>,
<span class=summary-sig-arg>eValue</span>,
<span class=summary-sig-arg>tb</span>,
<span class=summary-sig-arg>limit</span>)</span></code>
<br />
A formatted traceback and exception, without exposing the
framework.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="isTestCase"></a><span class="summary-sig"><span class="summary-sig-name">isTestCase</span>(<span class=summary-sig-arg>testCase</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="isTestClass"></a><span class="summary-sig"><span class="summary-sig-name">isTestClass</span>(<span class=summary-sig-arg>testClass</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="reactorCleanUp"></a><span class="summary-sig"><span class="summary-sig-name">reactorCleanUp</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.trial.util.html#wait" class="summary-sig-name"><code>wait</code></a>(<span class=summary-sig-arg>d</span>,
<span class=summary-sig-arg>timeout</span>)</span></code>
<br />
This function is unstable.</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>list</code></font></td>
<td><b><a href="twisted.trial.util.html#_failureConditionals"><code>_failureConditionals</code></a></b> = <span title="['fail', 'failIf', 'failUnless', 'failUnlessRaises', 'failUnlessEqual', 'failUnlessIdentical', 'failIfEqual', 'assertApproximates']"><code>['fail', 'failIf', 'failUnless', <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="deferredError"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">deferredError</span>(<span class=sig-arg>d</span>,
<span class=sig-arg>timeout</span>=<span class=sig-default>None</span>)</span>
</h3>
<p>Waits for deferred to fail, and it returns the Failure.</p>
If the deferred succeeds, raises FailTest.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="deferredResult"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">deferredResult</span>(<span class=sig-arg>d</span>,
<span class=sig-arg>timeout</span>=<span class=sig-default>None</span>)</span>
</h3>
Waits for a Deferred to arrive, then returns or throws an exception,
based on the result.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="extract_tb"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">extract_tb</span>(<span class=sig-arg>tb</span>,
<span class=sig-arg>limit</span>=<span class=sig-default>None</span>)</span>
</h3>
<p>Extract a list of frames from a traceback, without unittest
internals.</p>
Functionally identical to <code>traceback.extract_tb</code>, but
cropped to just the test case itself, excluding frames that are part of
the Trial testing framework.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="format_exception"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">format_exception</span>(<span class=sig-arg>eType</span>,
<span class=sig-arg>eValue</span>,
<span class=sig-arg>tb</span>,
<span class=sig-arg>limit</span>=<span class=sig-default>None</span>)</span>
</h3>
<p>A formatted traceback and exception, without exposing the
framework.</p>
I am identical in function to
<code>traceback.format_exception</code>, but I screen out frames from
the traceback that are part of the testing framework itself, leaving
only the code being tested.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="wait"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">wait</span>(<span class=sig-arg>d</span>,
<span class=sig-arg>timeout</span>=<span class=sig-default>10</span>)</span>
</h3>
<p>This function is unstable.</p>
Waits (spins the reactor) for a Deferred to arrive, then returns or
throws an exception, based on the result. The difference between this
and deferredResult is that it actually throws the original exception,
not the Failure, so synchronous exception handling is much more
sane.
<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="_failureConditionals"></a>
<h3>_failureConditionals</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="['fail', 'failIf', 'failUnless', 'failUnlessRaises', 'failUnlessEqual', 'failUnlessIdentical', 'failIfEqual', 'assertApproximates']"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
['fail',
'failIf',
'failUnless',
'failUnlessRaises',
'failUnlessEqual',
'failUnlessIdentical',
'failIfEqual',
'assertApproximates'] </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:08:34 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>