1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html>
<head>
<title>testtools.deferredruntest.SynchronousDeferredRunTest : API documentation</title>
<meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
<link href="bootstrap.min.css" type="text/css" rel="stylesheet" />
<link href="apidocs.css" type="text/css" rel="stylesheet" />
</head>
<body>
<nav class="navbar navbar-default">
<div class="container">
<div class="navbar-header">
<a href="index.html" class="navbar-brand">
<a href="https://github.com/testing-cabal/testtools">testtools</a> API Documentation
</a>
</div>
</div>
</nav>
<div class="container">
<div class="page-header">
<h1 class="class"><code>testtools.deferredruntest.SynchronousDeferredRunTest(<a href="testtools.deferredruntest._DeferredRunTest.html" class="code">_DeferredRunTest</a>)</code> <small>class documentation</small></h1>
<span id="partOf">
Part of <code><a href="testtools.html" class="code">testtools</a>.<a href="testtools.deferredruntest.html" class="code">deferredruntest</a></code>
<a href="classIndex.html#testtools.deferredruntest.SynchronousDeferredRunTest">(View In Hierarchy)</a>
</span>
</div>
<div class="extrasDocstring">
</div>
<div class="moduleDocstring">
<div>Runner for tests that return synchronous Deferreds.<table class="fieldTable"></table></div>
</div>
<div id="splitTables">
<table class="children sortable" id="id717">
<tr class="method private">
<td>Method</td>
<td><a href="testtools.deferredruntest.SynchronousDeferredRunTest.html#_run_user" class="code">_run_user</a></td>
<td><span>Run a user supplied function.</span></td>
</tr>
</table>
<p class="inheritedFrom">
Inherited from <a href="testtools.runtest.RunTest.html" class="code">RunTest</a> (via <a href="testtools.deferredruntest._DeferredRunTest.html" class="code">_DeferredRunTest</a>):
</p>
<table class="children sortable" id="id719">
<tr class="baseinstancevariable">
<td>Instance Variable</td>
<td><a href="testtools.runtest.RunTest.html#case" class="code">case</a></td>
<td>The test case that is to be run.</td>
</tr><tr class="baseinstancevariable">
<td>Instance Variable</td>
<td><a href="testtools.runtest.RunTest.html#result" class="code">result</a></td>
<td>The result object a case is reporting to.</td>
</tr><tr class="baseinstancevariable">
<td>Instance Variable</td>
<td><a href="testtools.runtest.RunTest.html#handlers" class="code">handlers</a></td>
<td>A list of (ExceptionClass, handler_function) for
exceptions that should be caught if raised from the user
code. Exceptions that are caught are checked against this list in
first to last order. There is a catch-all of 'Exception' at the end
of the list, so to add a new exception to the list, insert it at the
front (which ensures that it will be checked before any existing base
classes in the list. If you add multiple exceptions some of which are
subclasses of each other, add the most specific exceptions last (so
they come before their parent classes in the list).</td>
</tr><tr class="baseinstancevariable">
<td>Instance Variable</td>
<td><a href="testtools.runtest.RunTest.html#exception_caught" class="code">exception_caught</a></td>
<td>An object returned when _run_user catches an
exception.</td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="testtools.runtest.RunTest.html#__init__" class="code">__init__</a></td>
<td><span>Create a RunTest to run a case.</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="testtools.runtest.RunTest.html#run" class="code">run</a></td>
<td><span>Run self.case reporting activity to result.</span></td>
</tr><tr class="baseinstancevariable private">
<td>Instance Variable</td>
<td><a href="testtools.runtest.RunTest.html#_exceptions" class="code">_exceptions</a></td>
<td>A list of caught exceptions, used to do the single
reporting of error/failure/skip etc.</td>
</tr><tr class="basemethod private">
<td>Method</td>
<td><a href="testtools.runtest.RunTest.html#_run_one" class="code">_run_one</a></td>
<td><span>Run one test reporting to result.</span></td>
</tr><tr class="basemethod private">
<td>Method</td>
<td><a href="testtools.runtest.RunTest.html#_run_prepared_result" class="code">_run_prepared_result</a></td>
<td><span>Run one test reporting to result.</span></td>
</tr><tr class="basemethod private">
<td>Method</td>
<td><a href="testtools.runtest.RunTest.html#_run_core" class="code">_run_core</a></td>
<td><span>Run the user supplied test code.</span></td>
</tr><tr class="basemethod private">
<td>Method</td>
<td><a href="testtools.runtest.RunTest.html#_run_cleanups" class="code">_run_cleanups</a></td>
<td><span>Run the cleanups that have been added with addCleanup.</span></td>
</tr><tr class="basemethod private">
<td>Method</td>
<td><a href="testtools.runtest.RunTest.html#_got_user_exception" class="code">_got_user_exception</a></td>
<td><span>Called when user code raises an exception.</span></td>
</tr>
</table>
<p class="inheritedFrom">
Inherited from <a href="testtools.runtest.RunTest.html" class="code">RunTest</a> (via <a href="testtools.deferredruntest._DeferredRunTest.html" class="code">_DeferredRunTest</a>):
</p>
<table class="children sortable" id="id719">
<tr class="baseinstancevariable">
<td>Instance Variable</td>
<td><a href="testtools.runtest.RunTest.html#case" class="code">case</a></td>
<td>The test case that is to be run.</td>
</tr><tr class="baseinstancevariable">
<td>Instance Variable</td>
<td><a href="testtools.runtest.RunTest.html#result" class="code">result</a></td>
<td>The result object a case is reporting to.</td>
</tr><tr class="baseinstancevariable">
<td>Instance Variable</td>
<td><a href="testtools.runtest.RunTest.html#handlers" class="code">handlers</a></td>
<td>A list of (ExceptionClass, handler_function) for
exceptions that should be caught if raised from the user
code. Exceptions that are caught are checked against this list in
first to last order. There is a catch-all of 'Exception' at the end
of the list, so to add a new exception to the list, insert it at the
front (which ensures that it will be checked before any existing base
classes in the list. If you add multiple exceptions some of which are
subclasses of each other, add the most specific exceptions last (so
they come before their parent classes in the list).</td>
</tr><tr class="baseinstancevariable">
<td>Instance Variable</td>
<td><a href="testtools.runtest.RunTest.html#exception_caught" class="code">exception_caught</a></td>
<td>An object returned when _run_user catches an
exception.</td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="testtools.runtest.RunTest.html#__init__" class="code">__init__</a></td>
<td><span>Create a RunTest to run a case.</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="testtools.runtest.RunTest.html#run" class="code">run</a></td>
<td><span>Run self.case reporting activity to result.</span></td>
</tr><tr class="baseinstancevariable private">
<td>Instance Variable</td>
<td><a href="testtools.runtest.RunTest.html#_exceptions" class="code">_exceptions</a></td>
<td>A list of caught exceptions, used to do the single
reporting of error/failure/skip etc.</td>
</tr><tr class="basemethod private">
<td>Method</td>
<td><a href="testtools.runtest.RunTest.html#_run_one" class="code">_run_one</a></td>
<td><span>Run one test reporting to result.</span></td>
</tr><tr class="basemethod private">
<td>Method</td>
<td><a href="testtools.runtest.RunTest.html#_run_prepared_result" class="code">_run_prepared_result</a></td>
<td><span>Run one test reporting to result.</span></td>
</tr><tr class="basemethod private">
<td>Method</td>
<td><a href="testtools.runtest.RunTest.html#_run_core" class="code">_run_core</a></td>
<td><span>Run the user supplied test code.</span></td>
</tr><tr class="basemethod private">
<td>Method</td>
<td><a href="testtools.runtest.RunTest.html#_run_cleanups" class="code">_run_cleanups</a></td>
<td><span>Run the cleanups that have been added with addCleanup.</span></td>
</tr><tr class="basemethod private">
<td>Method</td>
<td><a href="testtools.runtest.RunTest.html#_got_user_exception" class="code">_got_user_exception</a></td>
<td><span>Called when user code raises an exception.</span></td>
</tr>
</table>
</div>
<div id="childList">
<div class="function">
<a name="testtools.deferredruntest.SynchronousDeferredRunTest._run_user">
</a>
<a name="_run_user">
</a>
<div class="functionHeader">
def
_run_user(self, function, *args):
</div>
<div class="docstring functionBody">
<div class="interfaceinfo">overrides <a href="testtools.runtest.RunTest.html#_run_user" class="code">testtools.runtest.RunTest._run_user</a></div>
<div><p>Run a user supplied function.</p>
<p>Exceptions are processed by <a href="testtools.runtest.RunTest.html#_got_user_exception"><code>_got_user_exception</code></a>.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">Either whatever 'fn' returns or <tt class="rst-docutils literal">exception_caught</tt> if
'fn' raised an exception.</td></tr></table></div>
</div>
</div>
</div>
<address>
<a href="index.html">API Documentation</a> for <a href="https://github.com/testing-cabal/testtools">testtools</a>, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> at 2015-07-01 16:11:28.
</address>
</div>
</body>
</html>
|
