~certify-web-dev/twisted/certify-trunk

« back to all changes in this revision

Viewing changes to doc/api/twisted.python.failure.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2004-06-21 22:01:11 UTC
  • mto: (2.2.3 sid)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040621220111-vkf909euqnyrp3nr
Tags: upstream-1.3.0
ImportĀ upstreamĀ versionĀ 1.3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>twisted.python.failure</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
 
8
</head>
 
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
10
      alink="#204080">
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
24
      </p></th></tr></table>
 
25
    </th>
 
26
  </tr>
 
27
</table>
 
28
<table width="100%" cellpadding="0" cellspacing="0">
 
29
  <tr valign="top">
 
30
    <td width="100%">
 
31
      <font size="-1"><b class="breadcrumbs">
 
32
        <a href="twisted.html">Package&nbsp;twisted</a> ::
 
33
        <a href="twisted.python.html">Package&nbsp;python</a> ::
 
34
        Module&nbsp;failure
 
35
      </b></font></br>
 
36
    </td>
 
37
    <td><table cellpadding="0" cellspacing="0">
 
38
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="twisted.python.failure.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
39
    </table></td>
 
40
</tr></table>
 
41
 
 
42
<!-- =========== START OF MODULE DESCRIPTION =========== -->
 
43
<h2 class="module">Module twisted.python.failure</h2>
 
44
 
 
45
<p>Asynchronous-friendly error mechanism.</p>
 
46
See <a href="twisted.python.failure.Failure.html" 
 
47
class="link"><code>Failure</code></a>.
 
48
<hr/>
 
49
 
 
50
<!-- =========== START OF CLASSES =========== -->
 
51
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
52
<tr bgcolor="#70b0f0" class="summary">
 
53
  <th colspan="2">Classes</th></tr>
 
54
<tr><td width="15%">
 
55
  <b><a href="twisted.python.failure.Failure.html"><code>Failure</code></a></b></td>
 
56
  <td>A basic abstraction for an error that has occurred.</td></tr>
 
57
</table><br />
 
58
 
 
59
 
 
60
<!-- =========== START OF EXCEPTIONS =========== -->
 
61
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
62
<tr bgcolor="#70b0f0" class="summary">
 
63
  <th colspan="2">Exceptions</th></tr>
 
64
<tr><td width="15%">
 
65
  <b><a href="twisted.python.failure.DefaultException.html"><code>DefaultException</code></a></b></td>
 
66
  <td>&nbsp;</td></tr>
 
67
</table><br />
 
68
 
 
69
 
 
70
<!-- =========== START OF FUNCTION SUMMARY =========== -->
 
71
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
72
<tr bgcolor="#70b0f0" class="summary">
 
73
  <th colspan="2">Function Summary</th></tr>
 
74
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
75
  <td><code><a name="_debuginit"></a><span class="summary-sig"><span class="summary-sig-name">_debuginit</span>(<span class=summary-sig-arg>self</span>,
 
76
          <span class=summary-sig-arg>exc_value</span>,
 
77
          <span class=summary-sig-arg>exc_type</span>,
 
78
          <span class=summary-sig-arg>exc_tb</span>,
 
79
          <span class=summary-sig-arg>Failure__init__</span>)</span></code>
 
80
</td></tr>
 
81
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
82
  <td><code><span class="summary-sig"><a href="twisted.python.failure.html#format_frames" class="summary-sig-name"><code>format_frames</code></a>(<span class=summary-sig-arg>frames</span>,
 
83
          <span class=summary-sig-arg>write</span>,
 
84
          <span class=summary-sig-arg>detail</span>)</span></code>
 
85
<br />
 
86
Format and write frames.</td></tr>
 
87
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
88
  <td><code><span class="summary-sig"><a href="twisted.python.failure.html#startDebugMode" class="summary-sig-name"><code>startDebugMode</code></a>()</span></code>
 
89
<br />
 
90
Enable debug hooks for Failures.</td></tr>
 
91
</table><br />
 
92
 
 
93
 
 
94
<!-- =========== START OF VARIABLE SUMMARY =========== -->
 
95
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
96
<tr bgcolor="#70b0f0" class="summary">
 
97
  <th colspan="2">Variable Summary</th></tr>
 
98
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
 
99
<td><b><a href="twisted.python.failure.html#count"><code>count</code></a></b> = <span title="10">10&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>
 
100
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
 
101
<td><b><a href="twisted.python.failure.html#traceupLength"><code>traceupLength</code></a></b> = <span title="4">4&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>
 
102
</table><br />
 
103
 
 
104
 
 
105
<!-- =========== START OF FUNCTION DETAILS =========== -->
 
106
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
107
<tr bgcolor="#70b0f0" class="details">
 
108
  <th colspan="2">Function Details</th></tr>
 
109
</table>
 
110
 
 
111
<a name="format_frames"></a>
 
112
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
113
  <h3><span class="sig"><span class="sig-name">format_frames</span>(<span class=sig-arg>frames</span>,
 
114
          <span class=sig-arg>write</span>,
 
115
          <span class=sig-arg>detail</span>=<span class=sig-default>'default'</span>)</span>
 
116
  </h3>
 
117
  Format and write frames.
 
118
  <dl><dt></dt><dd>
 
119
    <dl><dt><b>Parameters:</b></dt>
 
120
      <dd><code><b>frames</b></code> -
 
121
         is a list of frames as used by Failure.frames, with each frame 
 
122
        being a list of (funcName, fileName, lineNumber, locals.items(), 
 
123
        globals.items())
 
124
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
125
        (type=list)</i>
 
126
      <dd><code><b>write</b></code> -
 
127
         this will be called with formatted strings.
 
128
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
129
        (type=callable)</i>
 
130
      <dd><code><b>detail</b></code> -
 
131
         Three detail levels are available: default, brief, and 
 
132
        verbose.
 
133
        <br /><i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
134
        (type=string)</i>
 
135
      </dd>
 
136
    </dl>
 
137
  </dd></dl>
 
138
</td></tr></table>
 
139
 
 
140
<a name="startDebugMode"></a>
 
141
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
142
  <h3><span class="sig"><span class="sig-name">startDebugMode</span>()</span>
 
143
  </h3>
 
144
  Enable debug hooks for Failures.
 
145
  <dl><dt></dt><dd>
 
146
  </dd></dl>
 
147
</td></tr></table>
 
148
<br />
 
149
 
 
150
 
 
151
<!-- =========== START OF VARIABLE DETAILS =========== -->
 
152
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
153
<tr bgcolor="#70b0f0" class="details">
 
154
  <th colspan="2">Variable Details</th></tr>
 
155
</table>
 
156
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
157
<a name="count"></a>
 
158
<h3>count</h3>
 
159
<dl>
 
160
  <dt></dt>
 
161
  <dd>
 
162
    <dl>
 
163
      <dt><b>Type:</b></dt>
 
164
      <dd>
 
165
          <code>int</code>
 
166
 
 
167
      </dd>
 
168
<span title="10">      <dt><b>Value:</b></dt>
 
169
      <dd><table><tr><td>
 
170
<pre class="variable">
 
171
10&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>
 
172
        </td></tr></table></dd>
 
173
</span>    </dl>
 
174
  </dd>
 
175
</dl></td></tr></table>
 
176
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
177
<a name="traceupLength"></a>
 
178
<h3>traceupLength</h3>
 
179
<dl>
 
180
  <dt></dt>
 
181
  <dd>
 
182
    <dl>
 
183
      <dt><b>Type:</b></dt>
 
184
      <dd>
 
185
          <code>int</code>
 
186
 
 
187
      </dd>
 
188
<span title="4">      <dt><b>Value:</b></dt>
 
189
      <dd><table><tr><td>
 
190
<pre class="variable">
 
191
4&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>
 
192
        </td></tr></table></dd>
 
193
</span>    </dl>
 
194
  </dd>
 
195
</dl></td></tr></table>
 
196
<br />
 
197
 
 
198
 
 
199
<!-- =========== START OF NAVBAR =========== -->
 
200
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
201
  <tr valign="center">
 
202
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
203
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
204
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
205
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
206
    <th class="navbar" align="right" width="100%">
 
207
      <table border="0" cellpadding="0" cellspacing="0">
 
208
      <tr><th class="navbar" align="center">
 
209
        <p class="nomargin">
 
210
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
211
      </p></th></tr></table>
 
212
    </th>
 
213
  </tr>
 
214
</table>
 
215
 
 
216
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
217
  <tr>
 
218
    <td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:13 2004</font></td>
 
219
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
220
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
221
  </tr>
 
222
</table>
 
223
</body>
 
224
</html>