twisted.python.failure.Failure.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.failure.Failure</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> ::
<a href="twisted.python.failure.html">Module failure</a> ::
Class Failure
</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.failure.Failure.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Failure</h2>
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.spread.pb.CopiedFailure.html"><code>CopiedFailure</code></a>,
<a href="twisted.spread.pb.CopyableFailure.html"><code>CopyableFailure</code></a></dd></dl>
<hr/>
<p>A basic abstraction for an error that has occurred.</p>
This is necessary because Python's built-in error mechanisms are
inconvenient for asynchronous communication.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.failure.Failure.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>exc_value</span>,
<span class=summary-sig-arg>exc_type</span>,
<span class=summary-sig-arg>exc_tb</span>)</span></code>
<br />
Initialize me with an explanation of the error.</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.failure.Failure.html#__getstate__" class="summary-sig-name"><code>__getstate__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Avoid pickling objects in the traceback.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__repr__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__str__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="check"></a><span class="summary-sig"><span class="summary-sig-name">check</span>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-vararg">*errorTypes</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.failure.Failure.html#cleanFailure" class="summary-sig-name"><code>cleanFailure</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Remove references to other objects, replacing them with strings.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getBriefTraceback"></a><span class="summary-sig"><span class="summary-sig-name">getBriefTraceback</span>(<span class=summary-sig-arg>self</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.failure.Failure.html#getErrorMessage" class="summary-sig-name"><code>getErrorMessage</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get a string of the exception which caused this Failure.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getTraceback"></a><span class="summary-sig"><span class="summary-sig-name">getTraceback</span>(<span class=summary-sig-arg>self</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.failure.Failure.html#printBriefTraceback" class="summary-sig-name"><code>printBriefTraceback</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>file</span>)</span></code>
<br />
Print a traceback as densely as possible.</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.failure.Failure.html#printDetailedTraceback" class="summary-sig-name"><code>printDetailedTraceback</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>file</span>)</span></code>
<br />
Print a traceback with detailed locals and globals information.</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.failure.Failure.html#printTraceback" class="summary-sig-name"><code>printTraceback</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>file</span>)</span></code>
<br />
Emulate Python's standard error reporting mechanism.</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.failure.Failure.html#trap" class="summary-sig-name"><code>trap</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-vararg">*errorTypes</span>)</span></code>
<br />
Trap this failure if its type is in a predetermined list.</td></tr>
</table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.python.failure.Failure.html#type"><code>type</code></a></b>: The exception's class.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.python.failure.Failure.html#value"><code>value</code></a></b>: The exception instance responsible for this failure.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class 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.failure.Failure.html#pickled"><code>pickled</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.python.failure.Failure.html#stack"><code>stack</code></a></b> = <span title="None">None </span></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>exc_value</span>=<span class=sig-default>None</span>,
<span class=sig-arg>exc_type</span>=<span class=sig-default>None</span>,
<span class=sig-arg>exc_tb</span>=<span class=sig-default>None</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<p>Initialize me with an explanation of the error.</p>
By default, this will use the current <a
name="index-exception"></a><i class="indexterm">exception</i>
(<code>sys.exc_info</code>()). However, if you want to specify a
particular kind of failure, you can pass an exception as an
argument.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__getstate__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__getstate__</span>(<span class=sig-arg>self</span>)</span>
</h3>
Avoid pickling objects in the traceback.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="cleanFailure"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">cleanFailure</span>(<span class=sig-arg>self</span>)</span>
</h3>
Remove references to other objects, replacing them with strings.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getErrorMessage"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getErrorMessage</span>(<span class=sig-arg>self</span>)</span>
</h3>
Get a string of the exception which caused this Failure.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="printBriefTraceback"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">printBriefTraceback</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>file</span>=<span class=sig-default>None</span>)</span>
</h3>
Print a traceback as densely as possible.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="printDetailedTraceback"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">printDetailedTraceback</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>file</span>=<span class=sig-default>None</span>)</span>
</h3>
Print a traceback with detailed locals and globals information.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="printTraceback"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">printTraceback</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>file</span>=<span class=sig-default>None</span>)</span>
</h3>
Emulate Python's standard error reporting mechanism.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="trap"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">trap</span>(<span class=sig-arg>self</span>,
<span class="sig-vararg">*errorTypes</span>)</span>
</h3>
<p>Trap this failure if its type is in a predetermined list.</p>
<p>This allows you to trap a Failure in an error callback. It will be
automatically re-raised if it is not a type that you expect.</p>
<p>The reason for having this particular API is because it's very
useful in Deferred errback chains:</p>
<p>| def _ebFoo(self, failure): | r = failure.trap(Spam, Eggs) | print
'The Failure is due to either Spam or Eggs!' | if r == Spam: | print
'Spam did it!' | elif r == Eggs: | print 'Eggs did it!'</p>
If the failure is not a Spam or an Eggs, then the Failure will be
'passed on' to the next errback.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>errorTypes</b></code>
<br /><i>
(type=<code>Exception</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="type"></a>
<h3>type</h3>
The exception's class.
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="value"></a>
<h3>value</h3>
The exception instance responsible for this failure.
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="pickled"></a>
<h3>pickled</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="stack"></a>
<h3>stack</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </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:10 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>