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">
6
<title>twisted.trial.reporter.Reporter</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
24
</p></th></tr></table>
28
<table width="100%" cellpadding="0" cellspacing="0">
31
<font size="-1"><b class="breadcrumbs">
32
<a href="twisted.html">Package twisted</a> ::
33
<a href="twisted.trial.html">Package trial</a> ::
34
<a href="twisted.trial.reporter.html">Module reporter</a> ::
38
<td><table cellpadding="0" cellspacing="0">
39
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.trial.reporter.Reporter.html" target="_top">no frames</a>]</font></td></tr>
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
44
<h2 class="class">Class Reporter</h2>
46
<dl><dt><b>Known Subclasses:</b></dt>
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>
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
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"> </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>
68
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
71
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
74
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
79
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
86
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
91
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
95
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
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>
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>
131
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
132
<a name="debugger"></a>
134
Run the debugger when encountering a failing test.
139
<dt><b>Type:</b></dt>
146
</dl></td></tr></table>
147
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
148
<a name="errors"></a>
150
Tests which have encountered an error.
155
<dt><b>Type:</b></dt>
157
List of (testClass, method, Results) tuples.
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'
171
<dt><b>Type:</b></dt>
173
List of (testClass, method, Results) tuples.
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.
187
<dt><b>Type:</b></dt>
194
</dl></td></tr></table>
195
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
196
<a name="failures"></a>
198
Tests which have failed.
203
<dt><b>Type:</b></dt>
205
List of (testClass, method, Results) tuples.
210
</dl></td></tr></table>
211
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
212
<a name="imports"></a>
214
Import errors encountered while assembling the test suite.
219
<dt><b>Type:</b></dt>
221
List of (moduleName, exception) tuples.
226
</dl></td></tr></table>
227
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
228
<a name="numTests"></a>
230
The number of tests I have reports for.
235
<dt><b>Type:</b></dt>
242
</dl></td></tr></table>
243
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
246
Tests which have been skipped.
251
<dt><b>Type:</b></dt>
253
List of (testClass, method, Results) tuples.
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'
267
<dt><b>Type:</b></dt>
269
List of (testClass, method, Results) tuples.
274
</dl></td></tr></table>
278
<!-- =========== START OF NAVBAR =========== -->
279
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
281
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
282
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
283
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
284
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
285
<th class="navbar" align="right" width="100%">
286
<table border="0" cellpadding="0" cellspacing="0">
287
<tr><th class="navbar" align="center">
289
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
290
</p></th></tr></table>
295
<table border="0" cellpadding="0" cellspacing="0" width="100%">
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>