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

« back to all changes in this revision

Viewing changes to doc/api/twisted.trial.reporter.Reporter.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.trial.reporter.Reporter</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.trial.html">Package&nbsp;trial</a> ::
 
34
        <a href="twisted.trial.reporter.html">Module&nbsp;reporter</a> ::
 
35
        Class&nbsp;Reporter
 
36
      </b></font></br>
 
37
    </td>
 
38
    <td><table cellpadding="0" cellspacing="0">
 
39
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="twisted.trial.reporter.Reporter.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
40
    </table></td>
 
41
</tr></table>
 
42
 
 
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
44
<h2 class="class">Class Reporter</h2>
 
45
 
 
46
<dl><dt><b>Known Subclasses:</b></dt>
 
47
<dd>
 
48
    <a href="twisted.trial.remote.JellyReporter.html"><code>JellyReporter</code></a>,
 
49
    <a href="twisted.trial.reporter.MinimalReporter.html"><code>MinimalReporter</code></a>,
 
50
    <a href="twisted.trial.reporter.TextReporter.html"><code>TextReporter</code></a></dd></dl>
 
51
 
 
52
<hr/>
 
53
 
 
54
<p>I report results from a run of a test suite.</p>
 
55
In all lists below, 'Results' are either a 
 
56
twisted.python.failure.Failure object, an exc_info tuple, or a 
 
57
string.
 
58
<hr/>
 
59
 
 
60
 
 
61
<!-- =========== START OF METHOD SUMMARY =========== -->
 
62
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
63
<tr bgcolor="#70b0f0" class="summary">
 
64
  <th colspan="2">Method Summary</th></tr>
 
65
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
66
  <td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
67
</td></tr>
 
68
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
69
  <td><code><a name="allPassed"></a><span class="summary-sig"><span class="summary-sig-name">allPassed</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
70
</td></tr>
 
71
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
72
  <td><code><a name="getRunningTime"></a><span class="summary-sig"><span class="summary-sig-name">getRunningTime</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
73
</td></tr>
 
74
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
75
  <td><code><a name="reportImportError"></a><span class="summary-sig"><span class="summary-sig-name">reportImportError</span>(<span class=summary-sig-arg>self</span>,
 
76
          <span class=summary-sig-arg>name</span>,
 
77
          <span class=summary-sig-arg>exc</span>)</span></code>
 
78
</td></tr>
 
79
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
80
  <td><code><a name="reportResults"></a><span class="summary-sig"><span class="summary-sig-name">reportResults</span>(<span class=summary-sig-arg>self</span>,
 
81
          <span class=summary-sig-arg>testClass</span>,
 
82
          <span class=summary-sig-arg>method</span>,
 
83
          <span class=summary-sig-arg>resultType</span>,
 
84
          <span class=summary-sig-arg>results</span>)</span></code>
 
85
</td></tr>
 
86
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
87
  <td><code><a name="reportStart"></a><span class="summary-sig"><span class="summary-sig-name">reportStart</span>(<span class=summary-sig-arg>self</span>,
 
88
          <span class=summary-sig-arg>testClass</span>,
 
89
          <span class=summary-sig-arg>method</span>)</span></code>
 
90
</td></tr>
 
91
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
92
  <td><code><a name="start"></a><span class="summary-sig"><span class="summary-sig-name">start</span>(<span class=summary-sig-arg>self</span>,
 
93
          <span class=summary-sig-arg>expectedTests</span>)</span></code>
 
94
</td></tr>
 
95
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
96
  <td><code><a name="stop"></a><span class="summary-sig"><span class="summary-sig-name">stop</span>(<span class=summary-sig-arg>self</span>)</span></code>
 
97
</td></tr>
 
98
</table><br />
 
99
 
 
100
 
 
101
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
 
102
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
103
<tr bgcolor="#70b0f0" class="summary">
 
104
  <th colspan="2">Instance Variable Summary</th></tr>
 
105
<tr><td align="right" valign="top" width="15%"><font size="-1">bool</font></td>
 
106
<td><b><a href="twisted.trial.reporter.Reporter.html#debugger"><code>debugger</code></a></b>: Run the debugger when encountering a failing test.</td></tr>
 
107
<tr><td align="right" valign="top" width="15%"><font size="-1">List of (testClass, method, Results) tuples.</font></td>
 
108
<td><b><a href="twisted.trial.reporter.Reporter.html#errors"><code>errors</code></a></b>: Tests which have encountered an error.</td></tr>
 
109
<tr><td align="right" valign="top" width="15%"><font size="-1">List of (testClass, method, Results) tuples.</font></td>
 
110
<td><b><a href="twisted.trial.reporter.Reporter.html#expectedFailures"><code>expectedFailures</code></a></b>: Tests which failed but are marked as 'todo'</td></tr>
 
111
<tr><td align="right" valign="top" width="15%"><font size="-1">int</font></td>
 
112
<td><b><a href="twisted.trial.reporter.Reporter.html#expectedTests"><code>expectedTests</code></a></b>: The number of tests I expect to run.</td></tr>
 
113
<tr><td align="right" valign="top" width="15%"><font size="-1">List of (testClass, method, Results) tuples.</font></td>
 
114
<td><b><a href="twisted.trial.reporter.Reporter.html#failures"><code>failures</code></a></b>: Tests which have failed.</td></tr>
 
115
<tr><td align="right" valign="top" width="15%"><font size="-1">List of (moduleName, exception) tuples.</font></td>
 
116
<td><b><a href="twisted.trial.reporter.Reporter.html#imports"><code>imports</code></a></b>: Import errors encountered while assembling the test suite.</td></tr>
 
117
<tr><td align="right" valign="top" width="15%"><font size="-1">int</font></td>
 
118
<td><b><a href="twisted.trial.reporter.Reporter.html#numTests"><code>numTests</code></a></b>: The number of tests I have reports for.</td></tr>
 
119
<tr><td align="right" valign="top" width="15%"><font size="-1">List of (testClass, method, Results) tuples.</font></td>
 
120
<td><b><a href="twisted.trial.reporter.Reporter.html#skips"><code>skips</code></a></b>: Tests which have been skipped.</td></tr>
 
121
<tr><td align="right" valign="top" width="15%"><font size="-1">List of (testClass, method, Results) tuples.</font></td>
 
122
<td><b><a href="twisted.trial.reporter.Reporter.html#unexpectedSuccesses"><code>unexpectedSuccesses</code></a></b>: Tests which passed but are marked as 'todo'</td></tr>
 
123
</table><br />
 
124
 
 
125
 
 
126
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
 
127
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
128
<tr bgcolor="#70b0f0" class="details">
 
129
  <th colspan="2">Instance Variable Details</th></tr>
 
130
</table>
 
131
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
132
<a name="debugger"></a>
 
133
<h3>debugger</h3>
 
134
Run the debugger when encountering a failing test.
 
135
<dl>
 
136
  <dt></dt>
 
137
  <dd>
 
138
    <dl>
 
139
      <dt><b>Type:</b></dt>
 
140
      <dd>
 
141
          bool
 
142
 
 
143
      </dd>
 
144
    </dl>
 
145
  </dd>
 
146
</dl></td></tr></table>
 
147
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
148
<a name="errors"></a>
 
149
<h3>errors</h3>
 
150
Tests which have encountered an error.
 
151
<dl>
 
152
  <dt></dt>
 
153
  <dd>
 
154
    <dl>
 
155
      <dt><b>Type:</b></dt>
 
156
      <dd>
 
157
          List of (testClass, method, Results) tuples.
 
158
 
 
159
      </dd>
 
160
    </dl>
 
161
  </dd>
 
162
</dl></td></tr></table>
 
163
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
164
<a name="expectedFailures"></a>
 
165
<h3>expectedFailures</h3>
 
166
Tests which failed but are marked as 'todo'
 
167
<dl>
 
168
  <dt></dt>
 
169
  <dd>
 
170
    <dl>
 
171
      <dt><b>Type:</b></dt>
 
172
      <dd>
 
173
          List of (testClass, method, Results) tuples.
 
174
 
 
175
      </dd>
 
176
    </dl>
 
177
  </dd>
 
178
</dl></td></tr></table>
 
179
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
180
<a name="expectedTests"></a>
 
181
<h3>expectedTests</h3>
 
182
The number of tests I expect to run.
 
183
<dl>
 
184
  <dt></dt>
 
185
  <dd>
 
186
    <dl>
 
187
      <dt><b>Type:</b></dt>
 
188
      <dd>
 
189
          int
 
190
 
 
191
      </dd>
 
192
    </dl>
 
193
  </dd>
 
194
</dl></td></tr></table>
 
195
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
196
<a name="failures"></a>
 
197
<h3>failures</h3>
 
198
Tests which have failed.
 
199
<dl>
 
200
  <dt></dt>
 
201
  <dd>
 
202
    <dl>
 
203
      <dt><b>Type:</b></dt>
 
204
      <dd>
 
205
          List of (testClass, method, Results) tuples.
 
206
 
 
207
      </dd>
 
208
    </dl>
 
209
  </dd>
 
210
</dl></td></tr></table>
 
211
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
212
<a name="imports"></a>
 
213
<h3>imports</h3>
 
214
Import errors encountered while assembling the test suite.
 
215
<dl>
 
216
  <dt></dt>
 
217
  <dd>
 
218
    <dl>
 
219
      <dt><b>Type:</b></dt>
 
220
      <dd>
 
221
          List of (moduleName, exception) tuples.
 
222
 
 
223
      </dd>
 
224
    </dl>
 
225
  </dd>
 
226
</dl></td></tr></table>
 
227
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
228
<a name="numTests"></a>
 
229
<h3>numTests</h3>
 
230
The number of tests I have reports for.
 
231
<dl>
 
232
  <dt></dt>
 
233
  <dd>
 
234
    <dl>
 
235
      <dt><b>Type:</b></dt>
 
236
      <dd>
 
237
          int
 
238
 
 
239
      </dd>
 
240
    </dl>
 
241
  </dd>
 
242
</dl></td></tr></table>
 
243
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
244
<a name="skips"></a>
 
245
<h3>skips</h3>
 
246
Tests which have been skipped.
 
247
<dl>
 
248
  <dt></dt>
 
249
  <dd>
 
250
    <dl>
 
251
      <dt><b>Type:</b></dt>
 
252
      <dd>
 
253
          List of (testClass, method, Results) tuples.
 
254
 
 
255
      </dd>
 
256
    </dl>
 
257
  </dd>
 
258
</dl></td></tr></table>
 
259
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
260
<a name="unexpectedSuccesses"></a>
 
261
<h3>unexpectedSuccesses</h3>
 
262
Tests which passed but are marked as 'todo'
 
263
<dl>
 
264
  <dt></dt>
 
265
  <dd>
 
266
    <dl>
 
267
      <dt><b>Type:</b></dt>
 
268
      <dd>
 
269
          List of (testClass, method, Results) tuples.
 
270
 
 
271
      </dd>
 
272
    </dl>
 
273
  </dd>
 
274
</dl></td></tr></table>
 
275
<br />
 
276
 
 
277
 
 
278
<!-- =========== START OF NAVBAR =========== -->
 
279
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
280
  <tr valign="center">
 
281
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
282
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
283
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
284
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
285
    <th class="navbar" align="right" width="100%">
 
286
      <table border="0" cellpadding="0" cellspacing="0">
 
287
      <tr><th class="navbar" align="center">
 
288
        <p class="nomargin">
 
289
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
290
      </p></th></tr></table>
 
291
    </th>
 
292
  </tr>
 
293
</table>
 
294
 
 
295
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
296
  <tr>
 
297
    <td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:07:39 2004</font></td>
 
298
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
299
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
300
  </tr>
 
301
</table>
 
302
</body>
 
303
</html>