summaryrefslogtreecommitdiff
path: root/apidocs/testtools.tests.test_tags.TestTags.html
blob: 93596aae72ba26603584dd15d7b73930cc217941 (plain)
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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
<?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.tests.test_tags.TestTags : 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.tests.test_tags.TestTags(<a href="testtools.testcase.TestCase.html" class="code">TestCase</a>)</code> <small>class documentation</small></h1>

        <span id="partOf">
          Part of <code><a href="testtools.html" class="code">testtools</a>.<a href="testtools.tests.html" class="code">tests</a>.<a href="testtools.tests.test_tags.html" class="code">test_tags</a></code>
          
          <a href="classIndex.html#testtools.tests.test_tags.TestTags">(View In Hierarchy)</a>
        </span>
      </div>

      <div class="extrasDocstring">
        
      </div>

      <div class="moduleDocstring">
        <div class="undocumented">Undocumented</div>
      </div>

      <div id="splitTables">
        <table class="children sortable" id="id562">
  
  <tr class="method">
    
    <td>Method</td>
    <td><a href="testtools.tests.test_tags.TestTags.html#test_no_tags" class="code">test_no_tags</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="testtools.tests.test_tags.TestTags.html#test_add_tag" class="code">test_add_tag</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="testtools.tests.test_tags.TestTags.html#test_add_tag_twice" class="code">test_add_tag_twice</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="testtools.tests.test_tags.TestTags.html#test_change_tags_returns_tags" class="code">test_change_tags_returns_tags</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="testtools.tests.test_tags.TestTags.html#test_remove_tag" class="code">test_remove_tag</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="testtools.tests.test_tags.TestTags.html#test_child_context" class="code">test_child_context</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="testtools.tests.test_tags.TestTags.html#test_add_to_child" class="code">test_add_to_child</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="testtools.tests.test_tags.TestTags.html#test_remove_in_child" class="code">test_remove_in_child</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="testtools.tests.test_tags.TestTags.html#test_parent" class="code">test_parent</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr>
</table>
        
          <p class="inheritedFrom">
            Inherited from <a href="testtools.testcase.TestCase.html" class="code">TestCase</a>:
          </p>
          <table class="children sortable" id="id563">
  
  <tr class="baseinstancevariable">
    
    <td>Instance Variable</td>
    <td><a href="testtools.testcase.TestCase.html#exception_handlers" class="code">exception_handlers</a></td>
    <td>Exceptions to catch from setUp, runTest and
tearDown. This list is able to be modified at any time and consists of
(exception_class, handler(case, result, exception_value)) pairs.</td>
  </tr><tr class="baseinstancevariable">
    
    <td>Instance Variable</td>
    <td><a href="testtools.testcase.TestCase.html#force_failure" class="code">force_failure</a></td>
    <td>Force testtools.RunTest to fail the test after the
test has completed.</td>
  </tr><tr class="baseclassvariable">
    
    <td>Class Variable</td>
    <td><a href="testtools.testcase.TestCase.html#run_tests_with" class="code">run_tests_with</a></td>
    <td>A factory to make the <tt class="rst-docutils literal">RunTest</tt> to run tests with.
Defaults to <tt class="rst-docutils literal">RunTest</tt>.  The factory is expected to take a test case
and an optional list of exception handlers.</td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#__init__" class="code">__init__</a></td>
    <td><span>Construct a TestCase.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#__eq__" class="code">__eq__</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#__repr__" class="code">__repr__</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#addDetail" class="code">addDetail</a></td>
    <td><span>Add a detail to be reported with this test's outcome.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#getDetails" class="code">getDetails</a></td>
    <td><span>Get the details dict that will be reported with this test's outcome.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#patch" class="code">patch</a></td>
    <td><span>Monkey-patch 'obj.attribute' to 'value' while the test is running.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#shortDescription" class="code">shortDescription</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#skipTest" class="code">skipTest</a></td>
    <td><span>Cause this test to be skipped.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#addCleanup" class="code">addCleanup</a></td>
    <td><span>Add a cleanup function to be called after tearDown.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#addOnException" class="code">addOnException</a></td>
    <td><span>Add a handler to be called when an exception occurs in test code.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#assertEqual" class="code">assertEqual</a></td>
    <td><span>Assert that 'expected' is equal to 'observed'.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#assertIn" class="code">assertIn</a></td>
    <td><span>Assert that needle is in haystack.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#assertIsNone" class="code">assertIsNone</a></td>
    <td><span>Assert that 'observed' is equal to None.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#assertIsNotNone" class="code">assertIsNotNone</a></td>
    <td><span>Assert that 'observed' is not equal to None.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#assertIs" class="code">assertIs</a></td>
    <td><span>Assert that 'expected' is 'observed'.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#assertIsNot" class="code">assertIsNot</a></td>
    <td><span>Assert that 'expected' is not 'observed'.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#assertNotIn" class="code">assertNotIn</a></td>
    <td><span>Assert that needle is not in haystack.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#assertIsInstance" class="code">assertIsInstance</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#assertRaises" class="code">assertRaises</a></td>
    <td><span class="undocumented">No summary</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#assertThat" class="code">assertThat</a></td>
    <td><span>Assert that matchee is matched by matcher.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#addDetailUniqueName" class="code">addDetailUniqueName</a></td>
    <td><span>Add a detail to the test, but ensure it's name is unique.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#expectThat" class="code">expectThat</a></td>
    <td><span>Check that matchee is matched by matcher, but delay the assertion failure.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#defaultTestResult" class="code">defaultTestResult</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#expectFailure" class="code">expectFailure</a></td>
    <td><span>Check that a test fails in a particular way.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#getUniqueInteger" class="code">getUniqueInteger</a></td>
    <td><span>Get an integer unique to this test.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#getUniqueString" class="code">getUniqueString</a></td>
    <td><span>Get a string unique to this test.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#onException" class="code">onException</a></td>
    <td><span>Called when an exception propogates from test code.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#run" class="code">run</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#useFixture" class="code">useFixture</a></td>
    <td><span>Use fixture in a test case.</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#setUp" class="code">setUp</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#tearDown" class="code">tearDown</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod private">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#_formatTypes" class="code">_formatTypes</a></td>
    <td><span>Format a class or a bunch of classes for display in an error.</span></td>
  </tr><tr class="basemethod private">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#_add_reason" class="code">_add_reason</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod private">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#_matchHelper" class="code">_matchHelper</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basestaticmethod private">
    
    <td>Static Method</td>
    <td><a href="testtools.testcase.TestCase.html#_report_error" class="code">_report_error</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basestaticmethod private">
    
    <td>Static Method</td>
    <td><a href="testtools.testcase.TestCase.html#_report_expected_failure" class="code">_report_expected_failure</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basestaticmethod private">
    
    <td>Static Method</td>
    <td><a href="testtools.testcase.TestCase.html#_report_failure" class="code">_report_failure</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basestaticmethod private">
    
    <td>Static Method</td>
    <td><a href="testtools.testcase.TestCase.html#_report_skip" class="code">_report_skip</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod private">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#_report_traceback" class="code">_report_traceback</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basestaticmethod private">
    
    <td>Static Method</td>
    <td><a href="testtools.testcase.TestCase.html#_report_unexpected_success" class="code">_report_unexpected_success</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod private">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#_run_setup" class="code">_run_setup</a></td>
    <td><span>Run the setUp function for this test.</span></td>
  </tr><tr class="basemethod private">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#_run_teardown" class="code">_run_teardown</a></td>
    <td><span>Run the tearDown function for this test.</span></td>
  </tr><tr class="basemethod private">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#_get_test_method" class="code">_get_test_method</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="basemethod private">
    
    <td>Method</td>
    <td><a href="testtools.testcase.TestCase.html#_run_test_method" class="code">_run_test_method</a></td>
    <td><span>Run the test method for this test.</span></td>
  </tr>
</table>
          

          
      </div>

      <div id="childList">

        <div class="function">
  <a name="testtools.tests.test_tags.TestTags.test_no_tags">
    
  </a>
  <a name="test_no_tags">
    
  </a>
  <div class="functionHeader">
    
    def
    test_no_tags(self):
    
  </div>
  <div class="docstring functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="testtools.tests.test_tags.TestTags.test_add_tag">
    
  </a>
  <a name="test_add_tag">
    
  </a>
  <div class="functionHeader">
    
    def
    test_add_tag(self):
    
  </div>
  <div class="docstring functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="testtools.tests.test_tags.TestTags.test_add_tag_twice">
    
  </a>
  <a name="test_add_tag_twice">
    
  </a>
  <div class="functionHeader">
    
    def
    test_add_tag_twice(self):
    
  </div>
  <div class="docstring functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="testtools.tests.test_tags.TestTags.test_change_tags_returns_tags">
    
  </a>
  <a name="test_change_tags_returns_tags">
    
  </a>
  <div class="functionHeader">
    
    def
    test_change_tags_returns_tags(self):
    
  </div>
  <div class="docstring functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="testtools.tests.test_tags.TestTags.test_remove_tag">
    
  </a>
  <a name="test_remove_tag">
    
  </a>
  <div class="functionHeader">
    
    def
    test_remove_tag(self):
    
  </div>
  <div class="docstring functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="testtools.tests.test_tags.TestTags.test_child_context">
    
  </a>
  <a name="test_child_context">
    
  </a>
  <div class="functionHeader">
    
    def
    test_child_context(self):
    
  </div>
  <div class="docstring functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="testtools.tests.test_tags.TestTags.test_add_to_child">
    
  </a>
  <a name="test_add_to_child">
    
  </a>
  <div class="functionHeader">
    
    def
    test_add_to_child(self):
    
  </div>
  <div class="docstring functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="testtools.tests.test_tags.TestTags.test_remove_in_child">
    
  </a>
  <a name="test_remove_in_child">
    
  </a>
  <div class="functionHeader">
    
    def
    test_remove_in_child(self):
    
  </div>
  <div class="docstring functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="testtools.tests.test_tags.TestTags.test_parent">
    
  </a>
  <a name="test_parent">
    
  </a>
  <div class="functionHeader">
    
    def
    test_parent(self):
    
  </div>
  <div class="docstring functionBody">
    
    <div class="undocumented">Undocumented</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>