File: PKG-INFO

package info (click to toggle)
zope.testing 4.9-1
  • links: PTS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 448 kB
  • sloc: python: 895; makefile: 5; sh: 2
file content (1925 lines) | stat: -rw-r--r-- 69,720 bytes parent folder | download | duplicates (2)
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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
Metadata-Version: 2.1
Name: zope.testing
Version: 4.9
Summary: Zope testing helpers
Home-page: https://github.com/zopefoundation/zope.testing
Author: Zope Foundation and Contributors
Author-email: zope-dev@zope.org
License: ZPL 2.1
Description: =================
        ``zope.testing``
        =================
        
        .. image:: https://img.shields.io/pypi/v/zope.testing.svg
            :target: https://pypi.python.org/pypi/zope.testing/
            :alt: Latest Version
        
        .. image:: https://travis-ci.com/zopefoundation/zope.testing.svg?branch=master
                :target: https://travis-ci.com/zopefoundation/zope.testing
        
        .. image:: https://readthedocs.org/projects/zopetesting/badge/?version=latest
                :target: http://zopetesting.readthedocs.org/en/latest/
                :alt: Documentation Status
        
        This package provides a number of testing frameworks.
        
        cleanup
          Provides a mixin class for cleaning up after tests that
          make global changes.
        
        formparser
          An HTML parser that extracts form information.
        
          **Python 2 only**
        
          This is intended to support functional tests that need to extract
          information from HTML forms returned by the publisher.
        
          See formparser.txt.
        
        loggingsupport
          Support for testing logging code
        
          If you want to test that your code generates proper log output, you
          can create and install a handler that collects output.
        
        loghandler
          Logging handler for tests that check logging output.
        
        module
          Lets a doctest pretend to be a Python module.
        
          See module.txt.
        
        renormalizing
          Regular expression pattern normalizing output checker.
          Useful for doctests.
        
        server
          Provides a simple HTTP server compatible with the zope.app.testing
          functional testing API.  Lets you interactively play with the system
          under test.  Helpful in debugging functional doctest failures.
        
          **Python 2 only**
        
        setupstack
          A simple framework for automating doctest set-up and tear-down.
          See setupstack.txt.
        
        wait
          A small utility for dealing with timing non-determinism
          See wait.txt.
        
        doctestcase
          Support for defining doctests as methods of ``unittest.TestCase``
          classes so that they can be more easily found by test runners, like
          nose, that ignore test suites.
        
        .. contents::
        
        Getting started developing zope.testing
        =======================================
        
        zope.testing uses buildout.  To start, run ``python bootstrap.py``.  It will
        create a number of directories and the ``bin/buildout`` script.  Next, run
        ``bin/buildout``.  It will create a test script for you.  Now, run ``bin/test``
        to run the zope.testing test suite.
        
        
        Parsing HTML Forms
        ==================
        
        Sometimes in functional tests, information from a generated form must
        be extracted in order to re-submit it as part of a subsequent request.
        The `zope.testing.formparser` module can be used for this purpose.
        
        NOTE
           formparser doesn't support Python 3.
        
        The scanner is implemented using the `FormParser` class.  The
        constructor arguments are the page data containing the form and
        (optionally) the URL from which the page was retrieved:
        
          >>> import zope.testing.formparser
        
          >>> page_text = '''\
          ... <html><body>
          ...   <form name="form1" action="/cgi-bin/foobar.py" method="POST">
          ...     <input type="hidden" name="f1" value="today" />
          ...     <input type="submit" name="do-it-now" value="Go for it!" />
          ...     <input type="IMAGE" name="not-really" value="Don't."
          ...            src="dont.png" />
          ...     <select name="pick-two" size="3" multiple>
          ...       <option value="one" selected>First</option>
          ...       <option value="two" label="Second">Another</option>
          ...       <optgroup>
          ...         <option value="three">Third</option>
          ...         <option selected="selected">Fourth</option>
          ...       </optgroup>
          ...     </select>
          ...   </form>
          ...
          ...   Just for fun, a second form, after specifying a base:
          ...   <base href="http://www.example.com/base/" />
          ...   <form action = 'sproing/sprung.html' enctype="multipart/form">
          ...     <textarea name="sometext" rows="5">Some text.</textarea>
          ...     <input type="Image" name="action" value="Do something."
          ...            src="else.png" />
          ...     <input type="text" value="" name="multi" size="2" />
          ...     <input type="text" value="" name="multi" size="3" />
          ...   </form>
          ... </body></html>
          ... '''
        
          >>> parser = zope.testing.formparser.FormParser(page_text)
          >>> forms = parser.parse()
        
          >>> len(forms)
          2
          >>> forms.form1 is forms[0]
          True
          >>> forms.form1 is forms[1]
          False
        
        More often, the `parse()` convenience function is all that's needed:
        
          >>> forms = zope.testing.formparser.parse(
          ...     page_text, "http://cgi.example.com/somewhere/form.html")
        
          >>> len(forms)
          2
          >>> forms.form1 is forms[0]
          True
          >>> forms.form1 is forms[1]
          False
        
        Once we have the form we're interested in, we can check form
        attributes and individual field values:
        
          >>> form = forms.form1
          >>> form.enctype
          'application/x-www-form-urlencoded'
          >>> form.method
          'post'
        
          >>> keys = form.keys()
          >>> keys.sort()
          >>> keys
          ['do-it-now', 'f1', 'not-really', 'pick-two']
        
          >>> not_really = form["not-really"]
          >>> not_really.type
          'image'
          >>> not_really.value
          "Don't."
          >>> not_really.readonly
          False
          >>> not_really.disabled
          False
        
        Note that relative URLs are converted to absolute URLs based on the
        ``<base>`` element (if present) or using the base passed in to the
        constructor.
        
          >>> form.action
          'http://cgi.example.com/cgi-bin/foobar.py'
          >>> not_really.src
          'http://cgi.example.com/somewhere/dont.png'
        
          >>> forms[1].action
          'http://www.example.com/base/sproing/sprung.html'
          >>> forms[1]["action"].src
          'http://www.example.com/base/else.png'
        
        Fields which are repeated are reported as lists of objects that
        represent each instance of the field::
        
          >>> field = forms[1]["multi"]
          >>> isinstance(field, list)
          True
          >>> [o.value for o in field]
          ['', '']
          >>> [o.size for o in field]
          [2, 3]
        
        The ``<textarea>`` element provides some additional attributes:
        
          >>> ta = forms[1]["sometext"]
          >>> print ta.rows
          5
          >>> print ta.cols
          None
          >>> ta.value
          'Some text.'
        
        The ``<select>`` element provides access to the options as well:
        
          >>> select = form["pick-two"]
          >>> select.multiple
          True
          >>> select.size
          3
          >>> select.type
          'select'
          >>> select.value
          ['one', 'Fourth']
        
          >>> options = select.options
          >>> len(options)
          4
          >>> [opt.label for opt in options]
          ['First', 'Second', 'Third', 'Fourth']
          >>> [opt.value for opt in options]
          ['one', 'two', 'three', 'Fourth']
        
        
        Support for testing logging code
        ================================
        
        If you want to test that your code generates proper log output, you
        can create and install a handler that collects output:
        
          >>> from zope.testing.loggingsupport import InstalledHandler
          >>> handler = InstalledHandler('foo.bar')
        
        The handler is installed into loggers for all of the names passed. In
        addition, the logger level is set to 1, which means, log
        everything. If you want to log less than everything, you can provide a
        level keyword argument.  The level setting effects only the named
        loggers.
        
          >>> import logging
          >>> handler_with_levels = InstalledHandler('baz', level=logging.WARNING)
        
        Then, any log output is collected in the handler:
        
          >>> logging.getLogger('foo.bar').exception('eek')
          >>> logging.getLogger('foo.bar').info('blah blah')
        
          >>> for record in handler.records:
          ...     print_(record.name, record.levelname)
          ...     print_(' ', record.getMessage())
          foo.bar ERROR
            eek
          foo.bar INFO
            blah blah
        
        A similar effect can be gotten by just printing the handler:
        
          >>> print_(handler)
          foo.bar ERROR
            eek
          foo.bar INFO
            blah blah
        
        After checking the log output, you need to uninstall the handler:
        
          >>> handler.uninstall()
          >>> handler_with_levels.uninstall()
        
        At which point, the handler won't get any more log output.
        Let's clear the handler:
        
          >>> handler.clear()
          >>> handler.records
          []
        
        And then log something:
        
          >>> logging.getLogger('foo.bar').info('blah')
        
        and, sure enough, we still have no output:
        
          >>> handler.records
          []
        
        
        Regular expression pattern normalizing output checker
        =====================================================
        
        The pattern-normalizing output checker extends the default output checker with
        an option to normalize expected and actual output.
        
        You specify a sequence of patterns and replacements.  The replacements are
        applied to the expected and actual outputs before calling the default outputs
        checker.  Let's look at an example.  In this example, we have some times and
        addresses:
        
            >>> want = '''\
            ... <object object at 0xb7f14438>
            ... completed in 1.234 seconds.
            ... <BLANKLINE>
            ... <object object at 0xb7f14440>
            ... completed in 123.234 seconds.
            ... <BLANKLINE>
            ... <object object at 0xb7f14448>
            ... completed in .234 seconds.
            ... <BLANKLINE>
            ... <object object at 0xb7f14450>
            ... completed in 1.234 seconds.
            ... <BLANKLINE>
            ... '''
        
            >>> got = '''\
            ... <object object at 0xb7f14458>
            ... completed in 1.235 seconds.
            ...
            ... <object object at 0xb7f14460>
            ... completed in 123.233 seconds.
            ...
            ... <object object at 0xb7f14468>
            ... completed in .231 seconds.
            ...
            ... <object object at 0xb7f14470>
            ... completed in 1.23 seconds.
            ...
            ... '''
        
        We may wish to consider these two strings to match, even though they differ in
        actual addresses and times.  The default output checker will consider them
        different:
        
            >>> import doctest
            >>> doctest.OutputChecker().check_output(want, got, 0)
            False
        
        We'll use the zope.testing.renormalizing.OutputChecker to normalize both the
        wanted and gotten strings to ignore differences in times and
        addresses:
        
            >>> import re
            >>> from zope.testing.renormalizing import OutputChecker
            >>> checker = OutputChecker([
            ...    (re.compile('[0-9]*[.][0-9]* seconds'), '<SOME NUMBER OF> seconds'),
            ...    (re.compile('at 0x[0-9a-f]+'), 'at <SOME ADDRESS>'),
            ...    ])
        
            >>> checker.check_output(want, got, 0)
            True
        
        Usual OutputChecker options work as expected:
        
            >>> want_ellided = '''\
            ... <object object at 0xb7f14438>
            ... completed in 1.234 seconds.
            ... ...
            ... <object object at 0xb7f14450>
            ... completed in 1.234 seconds.
            ... <BLANKLINE>
            ... '''
        
            >>> checker.check_output(want_ellided, got, 0)
            False
        
            >>> checker.check_output(want_ellided, got, doctest.ELLIPSIS)
            True
        
        When we get differencs, we output them with normalized text:
        
            >>> source = '''\
            ... >>> do_something()
            ... <object object at 0xb7f14438>
            ... completed in 1.234 seconds.
            ... ...
            ... <object object at 0xb7f14450>
            ... completed in 1.234 seconds.
            ... <BLANKLINE>
            ... '''
        
            >>> example = doctest.Example(source, want_ellided)
        
            >>> print_(checker.output_difference(example, got, 0))
            Expected:
                <object object at <SOME ADDRESS>>
                completed in <SOME NUMBER OF> seconds.
                ...
                <object object at <SOME ADDRESS>>
                completed in <SOME NUMBER OF> seconds.
                <BLANKLINE>
            Got:
                <object object at <SOME ADDRESS>>
                completed in <SOME NUMBER OF> seconds.
                <BLANKLINE>
                <object object at <SOME ADDRESS>>
                completed in <SOME NUMBER OF> seconds.
                <BLANKLINE>
                <object object at <SOME ADDRESS>>
                completed in <SOME NUMBER OF> seconds.
                <BLANKLINE>
                <object object at <SOME ADDRESS>>
                completed in <SOME NUMBER OF> seconds.
                <BLANKLINE>
            <BLANKLINE>
        
            >>> print_(checker.output_difference(example, got,
            ...                                 doctest.REPORT_NDIFF))
            Differences (ndiff with -expected +actual):
                - <object object at <SOME ADDRESS>>
                - completed in <SOME NUMBER OF> seconds.
                - ...
                  <object object at <SOME ADDRESS>>
                  completed in <SOME NUMBER OF> seconds.
                  <BLANKLINE>
                + <object object at <SOME ADDRESS>>
                + completed in <SOME NUMBER OF> seconds.
                + <BLANKLINE>
                + <object object at <SOME ADDRESS>>
                + completed in <SOME NUMBER OF> seconds.
                + <BLANKLINE>
                + <object object at <SOME ADDRESS>>
                + completed in <SOME NUMBER OF> seconds.
                + <BLANKLINE>
            <BLANKLINE>
        
            If the wanted text is empty, however, we don't transform the actual output.
            This is usful when writing tests.  We leave the expected output empty, run
            the test, and use the actual output as expected, after reviewing it.
        
            >>> source = '''\
            ... >>> do_something()
            ... '''
        
            >>> example = doctest.Example(source, '\n')
            >>> print_(checker.output_difference(example, got, 0))
            Expected:
            <BLANKLINE>
            Got:
                <object object at 0xb7f14458>
                completed in 1.235 seconds.
                <BLANKLINE>
                <object object at 0xb7f14460>
                completed in 123.233 seconds.
                <BLANKLINE>
                <object object at 0xb7f14468>
                completed in .231 seconds.
                <BLANKLINE>
                <object object at 0xb7f14470>
                completed in 1.23 seconds.
                <BLANKLINE>
            <BLANKLINE>
        
        If regular expressions aren't expressive enough, you can use arbitrary Python
        callables to transform the text.  For example, suppose you want to ignore
        case during comparison:
        
            >>> checker = OutputChecker([
            ...    lambda s: s.lower(),
            ...    lambda s: s.replace('<blankline>', '<BLANKLINE>'),
            ...    ])
        
            >>> want = '''\
            ... Usage: thundermonkey [options] [url]
            ... <BLANKLINE>
            ... Options:
            ...     -h    display this help message
            ... '''
        
            >>> got = '''\
            ... usage: thundermonkey [options] [URL]
            ...
            ... options:
            ...     -h    Display this help message
            ... '''
        
            >>> checker.check_output(want, got, 0)
            True
        
        Suppose we forgot that <BLANKLINE> must be in upper case:
        
            >>> checker = OutputChecker([
            ...    lambda s: s.lower(),
            ...    ])
        
            >>> checker.check_output(want, got, 0)
            False
        
        The difference would show us that:
        
            >>> source = '''\
            ... >>> print_help_message()
            ... ''' + want
            >>> example = doctest.Example(source, want)
            >>> print_(checker.output_difference(example, got,
            ...                                 doctest.REPORT_NDIFF))
            Differences (ndiff with -expected +actual):
                  usage: thundermonkey [options] [url]
                - <blankline>
                + <BLANKLINE>
                  options:
                      -h    display this help message
            <BLANKLINE>
        
        
        It is possible to combine OutputChecker checkers for easy reuse:
        
            >>> address_and_time_checker = OutputChecker([
            ...    (re.compile('[0-9]*[.][0-9]* seconds'), '<SOME NUMBER OF> seconds'),
            ...    (re.compile('at 0x[0-9a-f]+'), 'at <SOME ADDRESS>'),
            ...    ])
            >>> lowercase_checker = OutputChecker([
            ...    lambda s: s.lower(),
            ...    ])
            >>> combined_checker = address_and_time_checker + lowercase_checker
            >>> len(combined_checker.transformers)
            3
        
        Combining a checker with something else does not work:
        
            >>> lowercase_checker + 5 #doctest: +ELLIPSIS
            Traceback (most recent call last):
                ...
            TypeError: unsupported operand type(s) for +: ...
        
        Using the 2to3 exception normalization:
        
            >>> from zope.testing.renormalizing import (
            ...     IGNORE_EXCEPTION_MODULE_IN_PYTHON2)
            >>> checker = OutputChecker()
            >>> want = """\
            ... Traceback (most recent call last):
            ... foo.bar.FooBarError: requires at least one argument."""
            >>> got = """\
            ... Traceback (most recent call last):
            ... FooBarError: requires at least one argument."""
            >>> result = checker.check_output(
            ...     want, got, IGNORE_EXCEPTION_MODULE_IN_PYTHON2)
            >>> import sys
            >>> if sys.version_info[0] < 3:
            ...     expected = True
            ... else:
            ...     expected = False
            >>> result == expected
            True
        
        When reporting a failing test and running in Python 2, the normalizer tries
        to be helpful by explaining how to test for exceptions in the traceback output.
        
            >>> want = """\
            ... Traceback (most recent call last):
            ... foo.bar.FooBarErrorXX: requires at least one argument.
            ... """
            >>> got = """\
            ... Traceback (most recent call last):
            ... FooBarError: requires at least one argument.
            ... """
            >>> checker.check_output(want, got, IGNORE_EXCEPTION_MODULE_IN_PYTHON2)
            False
            >>> from doctest import Example
            >>> example = Example('dummy', want)
            >>> result = checker.output_difference(
            ...     example, got, IGNORE_EXCEPTION_MODULE_IN_PYTHON2)
            >>> output = """\
            ... Expected:
            ...     Traceback (most recent call last):
            ...     foo.bar.FooBarErrorXX: requires at least one argument.
            ... Got:
            ...     Traceback (most recent call last):
            ...     FooBarError: requires at least one argument.
            ... """
            >>> hint = """\
            ...     ===============================================================
            ...     HINT:
            ...       The optionflag IGNORE_EXCEPTION_MODULE_IN_PYTHON2 is set.
            ...       You seem to test traceback output.
            ...       If you are indeed, make sure to use the full dotted name of
            ...       the exception class like Python 3 displays,
            ...       even though you are running the tests in Python 2.
            ...       The exception message needs to be last line (and thus not
            ...       split over multiple lines).
            ...     ==============================================================="""
            >>> if sys.version_info[0] < 3:
            ...     expected = output + hint
            ... else:
            ...     expected = output
            >>> result == expected
            True
        
        
        Stack-based test setUp and tearDown
        ===================================
        
        Writing doctest setUp and tearDown functions can be a bit tedious,
        especially when setUp/tearDown functions are combined.
        
        the zope.testing.setupstack module provides a small framework for
        automating test tear down.  It provides a generic setUp function that
        sets up a stack. Normal test setUp functions call this function to set
        up the stack and then use the register function to register tear-down
        functions.
        
        To see how this works we'll create a faux test:
        
            >>> class Test:
            ...     def __init__(self):
            ...         self.globs = {}
            >>> test = Test()
        
        We'll register some tearDown functions that just print something:
        
            >>> import sys
            >>> import zope.testing.setupstack
            >>> zope.testing.setupstack.register(
            ...     test, lambda : sys.stdout.write('td 1\n'))
            >>> zope.testing.setupstack.register(
            ...     test, lambda : sys.stdout.write('td 2\n'))
        
        Now, when we call the tearDown function:
        
            >>> zope.testing.setupstack.tearDown(test)
            td 2
            td 1
        
        The registered tearDown functions are run. Note that they are run in
        the reverse order that they were registered.
        
        
        Extra positional arguments can be passed to register:
        
            >>> zope.testing.setupstack.register(
            ...    test, lambda x, y, z: sys.stdout.write('%s %s %s\n' % (x, y, z)),
            ...    1, 2, z=9)
            >>> zope.testing.setupstack.tearDown(test)
            1 2 9
        
        
        Temporary Test Directory
        ------------------------
        
        Often, tests create files as they demonstrate functionality.  They
        need to arrange for the removeal of these files when the test is
        cleaned up.
        
        The setUpDirectory function automates this.  We'll get the current
        directory first:
        
            >>> import os
            >>> here = os.getcwd()
        
        We'll also create a new test:
        
            >>> test = Test()
        
        Now we'll call the setUpDirectory function:
        
            >>> zope.testing.setupstack.setUpDirectory(test)
        
        We don't have to call zope.testing.setupstack.setUp, because
        setUpDirectory calls it for us.
        
        Now the current working directory has changed:
        
            >>> here == os.getcwd()
            False
            >>> setupstack_cwd = os.getcwd()
        
        We can create files to out heart's content:
        
            >>> with open('Data.fs', 'w') as f:
            ...     foo = f.write('xxx')
            >>> os.path.exists(os.path.join(setupstack_cwd, 'Data.fs'))
            True
        
        We'll make the file read-only. This can cause problems on Windows, but
        setupstack takes care of that by making files writable before trying
        to remove them.
        
            >>> import stat
            >>> os.chmod('Data.fs', stat.S_IREAD)
        
        On Unix systems, broken symlinks can cause problems because the chmod
        attempt by the teardown hook will fail; let's set up a broken symlink as
        well, and verify the teardown doesn't break because of that:
        
            >>> if sys.platform != 'win32':
            ...     os.symlink('NotThere', 'BrokenLink')
        
        When tearDown is called:
        
            >>> zope.testing.setupstack.tearDown(test)
        
        We'll be back where we started:
        
            >>> here == os.getcwd()
            True
        
        and the files we created will be gone (along with the temporary
        directory that was created:
        
            >>> os.path.exists(os.path.join(setupstack_cwd, 'Data.fs'))
            False
        
        Context-manager support
        -----------------------
        
        You can leverage context managers using the ``contextmanager`` method.
        The result of calling the content manager's __enter__ method will be
        returned. The context-manager's __exit__ method will be called as part
        of test tear down:
        
            >>> class Manager(object):
            ...     def __init__(self, *args, **kw):
            ...         if kw:
            ...             args += (kw, )
            ...         self.args = args
            ...     def __enter__(self):
            ...         print_('enter', *self.args)
            ...         return 42
            ...     def __exit__(self, *args):
            ...         print_('exit', args, *self.args)
        
            >>> manager = Manager()
            >>> test = Test()
        
            >>> zope.testing.setupstack.context_manager(test, manager)
            enter
            42
        
            >>> zope.testing.setupstack.tearDown(test)
            exit (None, None, None)
        
        .. faux mock
        
            >>> old_mock = sys.modules.get('mock')
            >>> class FauxMock:
            ...     @classmethod
            ...     def patch(self, *args, **kw):
            ...         return Manager(*args, **kw)
        
            >>> sys.modules['mock'] = FauxMock
        
        By far the most commonly called context manager is ``mock.patch``, so
        there's a convenience function to make that simpler:
        
            >>> zope.testing.setupstack.mock(test, 'time.time', return_value=42)
            enter time.time {'return_value': 42}
            42
        
            >>> zope.testing.setupstack.tearDown(test)
            exit (None, None, None) time.time {'return_value': 42}
        
        globs
        -----
        
        Doctests have ``globs`` attributes used to hold test globals.
        ``setupstack`` was originally designed to work with doctests, but can
        now work with either doctests, or other test objects, as long as the
        test objects have either a ``globs`` attribute or a ``__dict__``
        attribute.  The ``zope.testing.setupstack.globs`` function is used to
        get the globals for a test object:
        
            >>> zope.testing.setupstack.globs(test) is test.globs
            True
        
        Here, because the test object had a ``globs`` attribute, it was
        returned. Because we used the test object above, it has a setupstack:
        
            >>> '__zope.testing.setupstack' in test.globs
            True
        
        If we remove the ``globs`` attribute, the object's instance dictionary
        will be used:
        
            >>> del test.globs
            >>> zope.testing.setupstack.globs(test) is test.__dict__
            True
            >>> zope.testing.setupstack.context_manager(test, manager)
            enter
            42
        
            >>> '__zope.testing.setupstack' in test.__dict__
            True
        
        The ``globs`` function is used internally, but can also be used by
        setup code to support either doctests or other test objects.
        
        TestCase
        --------
        
        A TestCase class is provided that:
        
        - Makes it easier to call setupstack apis, and
        
        - provides an inheritable tearDown method.
        
        In addition to a tearDown method, the class provides methods:
        
        ``setupDirectory()``
            Creates a temporary directory, runs the test, and cleans it up.
        
        ``register(func)``
            Register a tear-down function.
        
        ``context_manager(manager)``
            Enters a context manager and exits it on tearDown.
        
        ``mock(*args, **kw)``
            Enters  ``mock.patch`` with the given arguments.
        
            This is syntactic sugur for::
        
                context_manager(mock.patch(*args, **kw))
        
        Here's an example:
        
            >>> class MyTests(zope.testing.setupstack.TestCase):
            ...
            ...     def setUp(self):
            ...         self.setUpDirectory()
            ...         self.context_manager(manager)
            ...         self.mock("time.time", return_value=42)
            ...
            ...         @self.register
            ...         def _():
            ...             print('done w test')
            ...
            ...     def test(self):
            ...         if here == os.getcwd():
            ...             print('Failed to change directory')
        
        .. let's try it
        
            >>> import unittest
            >>> loader = unittest.TestLoader()
            >>> suite = loader.loadTestsFromTestCase(MyTests)
            >>> result = suite.run(unittest.TestResult())
            enter
            enter time.time {'return_value': 42}
            done w test
            exit (None, None, None) time.time {'return_value': 42}
            exit (None, None, None)
        
        .. cleanup
        
            >>> if old_mock:
            ...     sys.modules['mock'] = old_mock
            ... else:
            ...     del sys.modules['mock']
        
        
        
        Wait until a condition holds (or until a time out)
        ==================================================
        
        Often, in tests, you need to wait until some condition holds.  This
        may be because you're testing interaction with an external system or
        testing threaded (threads, processes, greenlet's, etc.) interactions.
        
        You can add sleeps to your tests, but it's often hard to know how
        long to sleep.
        
        ``zope.testing.wait`` provides a convenient way to wait until
        some condition holds.  It will test a condition and, when true,
        return.  It will sleep a short time between tests.
        
        Here's a silly example, that illustrates it's use:
        
            >>> from zope.testing.wait import wait
            >>> wait(lambda : True)
        
        Since the condition we passed is always True, it returned
        immediately.  If the condition doesn't hold, then we'll get a timeout:
        
            >>> wait((lambda : False), timeout=.01)
            Traceback (most recent call last):
            ...
            TimeOutWaitingFor: <lambda>
        
        ``wait`` has some keyword options:
        
        timeout
           How long, in seconds, to wait for the condition to hold
        
           Defaults to 9 seconds.
        
        wait
           How long to wait between calls.
        
           Defaults to .01 seconds.
        
        message
           A message (or other data) to pass to the timeout exception.
        
           This defaults to ``None``.  If this is false, then the callable's
           doc string or ``__name__`` is used.
        
        ``wait`` can be used as a decorator:
        
            >>> @wait
            ... def ok():
            ...     return True
        
            >>> @wait(timeout=.01)
            ... def no_way():
            ...     pass
            Traceback (most recent call last):
            ...
            TimeOutWaitingFor: no_way
        
            >>> @wait(timeout=.01)
            ... def no_way():
            ...     "never true"
            Traceback (most recent call last):
            ...
            TimeOutWaitingFor: never true
        
        .. more tests
        
            >>> import time
            >>> now = time.time()
            >>> @wait(timeout=.01, message='dang')
            ... def no_way():
            ...     "never true"
            Traceback (most recent call last):
            ...
            TimeOutWaitingFor: dang
        
            >>> .01 < (time.time() - now) < .03
            True
        
        
        Customization
        -------------
        
        ``wait`` is an instance of ``Wait``.  With ``Wait``,
        you can create you're own custom ``wait`` utilities.  For
        example, if you're testing something that uses getevent, you'd want to
        use gevent's sleep function:
        
            >>> import zope.testing.wait
            >>> wait = zope.testing.wait.Wait(getsleep=lambda : gevent.sleep)
        
        Wait takes a number of customization parameters:
        
        exception
          Timeout exception class
        
        getnow
          Function used to get a function for getting the current time.
        
          Default: lambda : time.time
        
        getsleep
          Function used to get a sleep function.
        
          Default: lambda : time.sleep
        
        timeout
          Default timeout
        
          Default: 9
        
        wait
          Default time to wait between attempts
        
          Default: .01
        
        
        .. more tests
        
            >>> def mysleep(t):
            ...     print_('mysleep', t)
            ...     time.sleep(t)
        
            >>> def mynow():
            ...     print_('mynow')
            ...     return time.time()
        
            >>> wait = zope.testing.wait.Wait(
            ...    getnow=(lambda : mynow), getsleep=(lambda : mysleep),
            ...    exception=ValueError, timeout=.1, wait=.02)
        
            >>> @wait
            ... def _(state=[]):
            ...     if len(state) > 1:
            ...        return True
            ...     state.append(0)
            mynow
            mysleep 0.02
            mynow
            mysleep 0.02
        
            >>> @wait(wait=.002)
            ... def _(state=[]):
            ...     if len(state) > 1:
            ...        return True
            ...     state.append(0)
            mynow
            mysleep 0.002
            mynow
            mysleep 0.002
        
            >>> @wait(timeout=0)
            ... def _(state=[]):
            ...     if len(state) > 1:
            ...        return True
            ...     state.append(0)
            Traceback (most recent call last):
            ...
            ValueError: _
        
            >>> wait = zope.testing.wait.Wait(timeout=0)
            >>> @wait(timeout=0)
            ... def _(state=[]):
            ...     if len(state) > 1:
            ...        return True
            ...     state.append(0)
            Traceback (most recent call last):
            ...
            TimeOutWaitingFor: _
        
        
        Doctests in TestCase classes
        ============================
        
        The original ``doctest`` unittest integration was based on
        ``unittest`` test suites, which have fallen out of favor. This module
        provides a way to define doctests inside of unittest ``TestCase``
        classes. It provides better integration with unittest test fixtures,
        because doctests use setup provided by the containing test case
        class. It provides access to unittest assertion methods.
        
        You can define doctests in multiple ways:
        
        - references to named files
        
        - strings
        
        - decorated functions with docstrings
        
        - reference to named files decorating test-specific setup functions
        
        - reference to named files decorating a test class
        
        .. some setup
        
           >>> __name__ = 'tests'
        
        Here are some examples::
        
            >>> from zope.testing import doctestcase
            >>> import doctest
            >>> import unittest
        
            >>> g = 'global'
        
            >>> class MyTest(unittest.TestCase):
            ...
            ...     def setUp(self):
            ...         self.a = 1
            ...         self.globs = dict(c=9)
            ...
            ...     test1 = doctestcase.file('test-1.txt', optionflags=doctest.ELLIPSIS)
            ...
            ...     test2 = doctestcase.docteststring('''
            ...       >>> self.a, g, c
            ...       (1, 'global', 9)
            ...     ''')
            ...
            ...     @doctestcase.doctestmethod(optionflags=doctest.ELLIPSIS)
            ...     def test3(self):
            ...         '''
            ...         >>> self.a, self.x, g, c
            ...         (1, 3, 'global', 9)
            ...         '''
            ...         self.x = 3
            ...
            ...     @doctestcase.doctestfile('test4.txt')
            ...     def test4(self):
            ...         self.x = 5
        
            >>> import sys
        
            >>> @doctestcase.doctestfiles('loggingsupport.txt', 'renormalizing.txt')
            ... class MoreTests(unittest.TestCase):
            ...
            ...    def setUp(self):
            ...        def print_(*args):
            ...            sys.stdout.write(' '.join(map(str, args))+'\n')
            ...        self.globs = dict(print_=print_)
        
        
        .. We can run these tests with the ``unittest`` test runner.
        
            >>> loader = unittest.TestLoader()
            >>> sys.stdout.writeln = lambda s: sys.stdout.write(s+'\n')
            >>> suite = loader.loadTestsFromTestCase(MyTest)
            >>> result = suite.run(unittest.TextTestResult(sys.stdout, True, 3))
            test1 (tests.MyTest) ... ok
            test2 (tests.MyTest) ... ok
            test3 (tests.MyTest) ... ok
            test4 (tests.MyTest) ... ok
        
            >>> suite = loader.loadTestsFromTestCase(MoreTests)
            >>> result = suite.run(unittest.TextTestResult(sys.stdout, True, 3))
            test_loggingsupport (tests.MoreTests) ... ok
            test_renormalizing (tests.MoreTests) ... ok
        
            >>> for _, e in result.errors:
            ...     print(e); print
        
            Check meta data:
        
            >>> MyTest.test1.__name__
            'test_1'
            >>> import os, zope.testing
            >>> (MyTest.test1.filepath ==
            ...  os.path.join(os.path.dirname(zope.testing.__file__), 'test-1.txt'))
            True
            >>> MyTest.test1.filename
            'test-1.txt'
        
            >>> MyTest.test3.__name__
            'test3'
            >>> MyTest.test4.__name__
            'test4'
        
            >>> (MyTest.test4.filepath ==
            ...  os.path.join(os.path.dirname(zope.testing.__file__), 'test4.txt'))
            True
            >>> MyTest.test4.filename
            'test4.txt'
        
            >>> MoreTests.test_loggingsupport.__name__
            'test_loggingsupport'
            >>> MoreTests.test_loggingsupport.filename
            'loggingsupport.txt'
            >>> (MoreTests.test_loggingsupport.filepath ==
            ...  os.path.join(os.path.dirname(zope.testing.__file__),
            ...               'loggingsupport.txt'))
            True
        
        In these examples, 4 constructors were used:
        
        doctestfile (alias: file)
          doctestfile makes a file-based test case.
        
          This can be used as a decorator, in which case, the decorated
          function is called before the test is run, to provide test-specific
          setup.
        
        doctestfiles (alias: files)
          doctestfiles makes file-based test cases and assigns them to the
          decorated class.
        
          Multiple files can be specified and the resulting doctests are added
          as members of the decorated class.
        
        docteststring (alias string)
          docteststring constructs a doctest from a string.
        
        doctestmethod (alias method)
          doctestmethod constructs a doctest from a method.
        
          The method's docstring provides the test. The method's body provides
          optional test-specific setup.
        
        Note that short aliases are provided, which maye be useful in certain
        import styles.
        
        Tests have access to the following data:
        
        - Tests created with the ``docteststring`` and ``doctestmethod``
          constructors have access to the module globals of the defining
          module.
        
        - In tests created with the ``docteststring`` and ``doctestmethod``
          constructors, the test case instance is available as the ``self``
          variable.
        
        - In tests created with the ``doctestfile`` and ``doctestfiles``
          constructor, the test case instance is available as the ``test``
          variable.
        
        - If a test case defines a globs attribute, it must be a dictionary
          and it's contents are added to the test globals.
        
        The constructors accept standard doctest ``optionflags`` and
        ``checker`` arguments.
        
        Note that the doctest IGNORE_EXCEPTION_DETAIL option flag is
        added to optionflags.
        
        When using ``doctestfile`` and ``doctestfile``, ``filename`` and
        ``filepath`` attributes are available that contain the test file name
        and full path.
        
        ``__name__`` attributes of class members
        ----------------------------------------
        
        Class members have ``__name__`` attributes set as follows:
        
        - When using ``doctestmethod`` or ``doctestfile`` with a setup
          function, ``__name__`` attribute is set to the name of the function.
          A ``test_`` prefix is added, if the name doesn't start with ``test``.
        
        - When ``doctestfile`` is used without a setup function or when
          ``doctestfiles`` is used, ``__name__`` is set to the last part of the
          file path with the extension removed and non-word characters
          converted to underscores. For example, with a test path of
          ``'/foo/bar/test-it.rst'``, the ``__name__`` attribute is set to
          ``'test_it'``.  A ``test_`` prefix is added, if the name doesn't
          start with ``test``.
        
        - when using ``docteststring``, a ``name`` option can be passed in to
          set ``__name__``.  A ``test_`` prefix is added, if the name doesn't
          start with ``test``.
        
        The ``__name__`` attribute is important when using nose, because nose
        discovers tests as class members using their ``__name__`` attributes,
        whereas the unittest and py.test test runners use class dictionary keys.
        
        .. Let's look at some failure cases:
        
            >>> class MyTest(unittest.TestCase):
            ...
            ...     test2 = doctestcase.string('''
            ...     >>> 1
            ...     1
            ...     >>> 1 + 1
            ...     1
            ...     ''', name='test2')
            ...
            ...     @doctestcase.method
            ...     def test3(self):
            ...         '''
            ...         >>> self.x
            ...         3
            ...         >>> 1 + 1
            ...         1
            ...         '''
            ...         self.x = 3
            ...
            ...     @doctestcase.file('test4f.txt')
            ...     def test4(self):
            ...         self.x = 5
        
            >>> suite = loader.loadTestsFromTestCase(MyTest)
            >>> result = suite.run(unittest.TextTestResult(sys.stdout, True, 1))
            FFF
            >>> for c, e in result.failures:
            ...     print(e) # doctest: +ELLIPSIS +NORMALIZE_WHITESPACE
            Traceback (most recent call last):
              ...
            ...: Failed doctest test for <string>
              File "<string>", line 0, in <string>
            <BLANKLINE>
            ----------------------------------------------------------------------
            File "<string>", line 4, in <string>
            Failed example:
                1 + 1
            Expected:
                1
            Got:
                2
            <BLANKLINE>
            <BLANKLINE>
            Traceback (most recent call last):
              ...
            ...: Failed doctest test for test3
              File "None", line 10, in test3
            <BLANKLINE>
            ----------------------------------------------------------------------
            Line 4, in test3
            Failed example:
                1 + 1
            Expected:
                1
            Got:
                2
            <BLANKLINE>
            <BLANKLINE>
            Traceback (most recent call last):
            ...
            ...: Failed doctest test for test4f.txt
              File "...test4f.txt", line 0, in txt
            <BLANKLINE>
            ----------------------------------------------------------------------
            File "...test4f.txt", line 3, in test4f.txt
            Failed example:
                1 + 1
            Expected:
                1
            Got:
                2
            <BLANKLINE>
            <BLANKLINE>
        
            Check string meta data:
        
            >>> MyTest.test2.__name__
            'test2'
        
        .. Verify setting optionflags and checker
        
            >>> class EasyChecker:
            ...     def check_output(self, want, got, optionflags):
            ...         return True
            ...     def output_difference(self, example, got, optionflags):
            ...         return ''
        
            >>> class MyTest(unittest.TestCase):
            ...
            ...     test2 = doctestcase.string('''
            ...     >>> 1
            ...     2
            ...     ''', checker=EasyChecker())
            ...
            ...     @doctestcase.method(optionflags=doctest.ELLIPSIS)
            ...     def test3(self):
            ...         '''
            ...         >>> 'Hello'
            ...         '...'
            ...         '''
            ...
            ...     @doctestcase.file('test4e.txt', optionflags=doctest.ELLIPSIS)
            ...     def test4(self):
            ...         self.x = 5
        
            >>> suite = loader.loadTestsFromTestCase(MyTest)
            >>> result = suite.run(unittest.TextTestResult(sys.stdout, True, 2))
            test2 (tests.MyTest) ... ok
            test3 (tests.MyTest) ... ok
            test4 (tests.MyTest) ... ok
        
        .. test __name__ variations
        
            >>> class MyTest(unittest.TestCase):
            ...
            ...     foo = doctestcase.string('''>>> 1''', name='foo')
            ...
            ...     @doctestcase.method
            ...     def bar(self):
            ...         '''
            ...         >>> self.x
            ...         3
            ...         '''
            ...     @doctestcase.file('test4f.txt')
            ...     def baz(self):
            ...         pass
            ...     wait = doctestcase.file('wait.txt')
        
            >>> MyTest.foo.__name__
            'test_foo'
            >>> MyTest.bar.__name__
            'test_bar'
            >>> MyTest.baz.__name__
            'test_baz'
            >>> MyTest.wait.__name__
            'test_wait'
        
        
        Changes
        =======
        
        4.9 (2021-01-08)
        ----------------
        
        - Make ``setupstack.txt`` test work again if the current directory is empty.
        
        
        4.8 (2021-01-04)
        ----------------
        
        - Add support for Python 3.8 and 3.9.
        
        - Drop support for Python 3.3 and 3.4.
        
        - Extend IGNORE_EXCEPTION_MODULE_IN_PYTHON2 to cover also exceptions without
          arguments (thus without a colon on the last line of the traceback output).
        
        
        4.7 (2018-10-04)
        ----------------
        
        - Added support for Python 3.7.
        
        
        4.6.2 (2017-06-12)
        ------------------
        
        - Remove dependencies on ``zope.interface`` and ``zope.exceptions``;
          they're not used here.
        
        - Remove use of 2to3 for outdated versions of PyPy3, letting us build
          universal wheels.
        
        
        4.6.1 (2017-01-04)
        ------------------
        
        - Add support for Python 3.6.
        
        
        4.6.0 (2016-10-20)
        ------------------
        
        - Introduce option flag ``IGNORE_EXCEPTION_MODULE_IN_PYTHON2`` to normalize
          exception class names in traceback output. In Python 3 they are displayed as
          the full dotted name. In Python 2 they are displayed as "just" the class
          name.  When running doctests in Python 3, the option flag will not have any
          effect, however when running the same test in Python 2, the segments in the
          full dotted name leading up to the class name are stripped away from the
          "expected" string.
        
        - Drop support for Python 2.6 and 3.2.
        
        - Add support for Python 3.5.
        
        - Cleaned up useless 2to3 conversion.
        
        4.5.0 (2015-09-02)
        ------------------
        
        - Added meta data for test case methods created with
          ``zope.testing.doctestcase``.
        
          - Reasonable values for ``__name__``, making sure that ``__name__``
            starts with ``test``.
        
          - For ``doctestfile`` methods, provide ``filename`` and ``filepath``
            attributes.
        
          The meta data us useful, for example, for selecting tests with the
          nose attribute mechanism.
        
        - Added ``doctestcase.doctestfiles``
        
          - Define multiple doctest files at once.
        
          - Automatically assign test class members.  So rather than::
        
              class MYTests(unittest.TestCase):
                  ...
                  test_foo = doctestcase.doctestfile('foo.txt')
        
            You can use::
        
              @doctestcase.doctestfiles('foo.txt', 'bar.txt', ...)
              class MYTests(unittest.TestCase):
                  ...
        
        4.4.0 (2015-07-16)
        ------------------
        
        - Added ``zope.testing.setupstack.mock`` as a convenience function for
          setting up mocks in tests.  (The Python ``mock`` package must be in
          the path for this to work. The excellent ``mock`` package isn't a
          dependency of ``zope.testing``.)
        
        - Added the base class ``zope.testing.setupstack.TestCase`` to make it
          much easier to use ``zope.testing.setupstack`` in ``unittest`` test
          cases.
        
        
        4.3.0 (2015-07-15)
        ------------------
        
        - Added support for creating doctests as methods of
          ``unittest.TestCase`` classes so that they can found automatically
          by test runners, like *nose* that ignore test suites.
        
        4.2.0 (2015-06-01)
        ------------------
        
        - **Actually** remove long-deprecated ``zope.testing.doctest`` (announced as
          removed in 4.0.0) and ``zope.testing.doctestunit``.
        
        - Add support for PyPy and PyPy3.
        
        4.1.3 (2014-03-19)
        ------------------
        
        - Add support for Python 3.4.
        
        - Update ``boostrap.py`` to version 2.2.
        
        4.1.2 (2013-02-19)
        ------------------
        
        - Adjust Trove classifiers to reflect the currently supported Python
          versions. Officially drop Python 2.4 and 2.5. Add Python 3.3.
        
        - LP: #1055720: Fix failing test on Python 3.3 due to changed exception
          messaging.
        
        4.1.1 (2012-02-01)
        ------------------
        
        - Fix: Windows test failure.
        
        4.1.0 (2012-01-29)
        ------------------
        
        - Add context-manager support to ``zope.testing.setupstack``
        
        - Make ``zope.testing.setupstack`` usable with all tests, not just
          doctests and added ``zope.testing.setupstack.globs``, which makes it
          easier to write test setup code that workes with doctests and other
          kinds of tests.
        
        - Add the ``wait`` module, which makes it easier to deal with
          non-deterministic timing issues.
        
        - Rename ``zope.testing.renormalizing.RENormalizing`` to
          ``zope.testing.renormalizing.OutputChecker``. The old name is an
          alias.
        
        - Update tests to run with Python 3.
        
        - Label more clearly which features are supported by Python 3.
        
        - Reorganize documentation.
        
        4.0.0 (2011-11-09)
        ------------------
        
        - Remove the deprecated ``zope.testing.doctest``.
        
        - Add Python 3 support.
        
        - Fix test which fails if there is a file named `Data.fs` in the current
          working directory.
        
        
        3.10.2 (2010-11-30)
        -------------------
        
        - Fix test of broken symlink handling to not break on Windows.
        
        
        3.10.1 (2010-11-29)
        -------------------
        
        - Fix removal of broken symlinks on Unix.
        
        
        3.10.0 (2010-07-21)
        -------------------
        
        - Remove ``zope.testing.testrunner``, which now is moved to zope.testrunner.
        
        - Update fix for LP #221151 to a spelling compatible with Python 2.4.
        
        3.9.5 (2010-05-19)
        ------------------
        
        - LP #579019: When layers are run in parallel, ensure that each ``tearDown``
          is called, including the first layer which is run in the main
          thread.
        
        - Deprecate ``zope.testing.testrunner`` and ``zope.testing.exceptions``.
          They have been moved to a separate zope.testrunner module, and will be
          removed from zope.testing in 4.0.0, together with ``zope.testing.doctest``.
        
        3.9.4 (2010-04-13)
        ------------------
        
        - LP #560259: Fix subunit output formatter to handle layer setup
          errors.
        
        - LP #399394:  Add a ``--stop-on-error`` / ``--stop`` / ``-x`` option to
          the testrunner.
        
        - LP #498162:  Add a ``--pdb`` alias for the existing ``--post-mortem``
          / ``-D`` option to the testrunner.
        
        - LP #547023:  Add a ``--version`` option to the testrunner.
        
        - Add tests for LP #144569 and #69988.
        
          https://bugs.launchpad.net/bugs/69988
        
          https://bugs.launchpad.net/zope3/+bug/144569
        
        
        3.9.3 (2010-03-26)
        ------------------
        
        - Remove import of ``zope.testing.doctest`` from ``zope.testing.renormalizer``.
        
        - Suppress output to ``sys.stderr`` in ``testrunner-layers-ntd.txt``.
        
        - Suppress ``zope.testing.doctest`` deprecation warning when running
          our own test suite.
        
        
        3.9.2 (2010-03-15)
        ------------------
        
        - Fix broken ``from zope.testing.doctest import *``
        
        3.9.1 (2010-03-15)
        ------------------
        
        - No changes; reupload to fix broken 3.9.0 release on PyPI.
        
        3.9.0 (2010-03-12)
        ------------------
        
        - Modify the testrunner to use the standard Python ``doctest`` module instead
          of the deprecated ``zope.testing.doctest``.
        
        - Fix ``testrunner-leaks.txt`` to use the ``run_internal`` helper, so that
          ``sys.exit`` isn't triggered during the test run.
        
        - Add support for conditionally using a subunit-based output
          formatter upon request if subunit and testtools are available. Patch
          contributed by Jonathan Lange.
        
        3.8.7 (2010-01-26)
        ------------------
        
        - Downgrade the ``zope.testing.doctest`` deprecation warning into a
          PendingDeprecationWarning.
        
        3.8.6 (2009-12-23)
        ------------------
        
        - Add ``MANIFEST.in`` and reupload to fix broken 3.8.5 release on PyPI.
        
        
        3.8.5 (2009-12-23)
        ------------------
        
        - Add back ``DocFileSuite``, ``DocTestSuite``, ``debug_src`` and ``debug``
          BBB imports back into ``zope.testing.doctestunit``; apparently many packages
          still import them from there!
        
        - Deprecate ``zope.testing.doctest`` and ``zope.testing.doctestunit``
          in favor of the stdlib ``doctest`` module.
        
        
        3.8.4 (2009-12-18)
        ------------------
        
        - Fix missing imports and undefined variables reported by pyflakes,
          adding tests to exercise the blind spots.
        
        - Cleaned up unused imports reported by pyflakes.
        
        - Add two new options to generate randomly ordered list of tests and to
          select a specific order of tests.
        
        - Allow combining RENormalizing checkers via ``+`` now:
          ``checker1 + checker2`` creates a checker with the transformations of both
          checkers.
        
        - Fix tests under Python 2.7.
        
        3.8.3 (2009-09-21)
        ------------------
        
        - Fix test failures due to using ``split()`` on filenames when running from a
          directory with spaces in it.
        
        - Fix testrunner behavior on Windows for ``-j2`` (or greater) combined with
          ``-v`` (or greater).
        
        3.8.2 (2009-09-15)
        ------------------
        
        - Remove hotshot profiler when using Python 2.6. That makes zope.testing
          compatible with Python 2.6
        
        
        3.8.1 (2009-08-12)
        ------------------
        
        - Avoid hardcoding ``sys.argv[0]`` as script;
          allow, for instance, Zope 2's `bin/instance test` (LP#407916).
        
        - Produce a clear error message when a subprocess doesn't follow the
          ``zope.testing.testrunner`` protocol (LP#407916).
        
        - Avoid unnecessarily squelching verbose output in a subprocess when there are
          not multiple subprocesses.
        
        - Avoid unnecessarily batching subprocess output, which can stymie automated
          and human processes for identifying hung tests.
        
        - Include incremental output when there are multiple subprocesses and a
          verbosity of ``-vv`` or greater is requested.  This again is not batched,
          supporting automated processes and humans looking for hung tests.
        
        
        3.8.0 (2009-07-24)
        ------------------
        
        - Allow testrunner to include descendants of ``unittest.TestCase`` in test
          modules, which no longer need to provide ``test_suite()``.
        
        
        3.7.7 (2009-07-15)
        ------------------
        
        - Clean up support for displaying tracebacks with supplements by turning it
          into an always-enabled feature and making the dependency on
          ``zope.exceptions`` explicit.
        
        - Fix #251759: prevent the testrunner descending into directories that
          aren't Python packages.
        
        - Code cleanups.
        
        
        3.7.6 (2009-07-02)
        ------------------
        
        - Add zope-testrunner ``console_scripts`` entry point. This exposes a
          ``zope-testrunner`` script with default installs allowing the testrunner
          to be run from the command line.
        
        3.7.5 (2009-06-08)
        ------------------
        
        - Fix bug when running subprocesses on Windows.
        
        - The option ``REPORT_ONLY_FIRST_FAILURE`` (command line option "-1") is now
          respected even when a doctest declares its own ``REPORTING_FLAGS``, such as
          ``REPORT_NDIFF``.
        
        - Fix bug that broke readline with pdb when using doctest
          (see http://bugs.python.org/issue5727).
        
        - Make tests pass on Windows and Linux at the same time.
        
        
        3.7.4 (2009-05-01)
        ------------------
        
        - Filenames of doctest examples now contain the line number and not
          only the example number. So a stack trace in pdb tells the exact
          line number of the current example. This fixes
          https://bugs.launchpad.net/bugs/339813
        
        - Colorization of doctest output correctly handles blank lines.
        
        
        3.7.3 (2009-04-22)
        ------------------
        
        - Improve handling of rogue threads:  always exit with status so even
          spinning daemon threads won't block the runner from exiting. This deprecated
          the ``--with-exit-status`` option.
        
        
        3.7.2 (2009-04-13)
        ------------------
        
        - Fix test failure on Python 2.4 due to slight difference in the way
          coverage is reported (__init__ files with only a single comment line are now
          not reported)
        
        - Fix bug that caused the test runner to hang when running subprocesses (as a
          result Python 2.3 is no longer supported).
        
        - Work around a bug in Python 2.6 (related to
          http://bugs.python.org/issue1303673) that causes the profile tests to fail.
        
        - Add explanitory notes to ``buildout.cfg`` about how to run the tests with
          multiple versions of Python
        
        
        3.7.1 (2008-10-17)
        ------------------
        
        - The ``setupstack`` temporary directory support now properly handles
          read-only files by making them writable before removing them.
        
        
        3.7.0 (2008-09-22)
        ------------------
        
        - Add alterate setuptools / distutils commands for running all tests
          using our testrunner.  See 'zope.testing.testrunner.eggsupport:ftest'.
        
        - Add a setuptools-compatible test loader which skips tests with layers:
          the testrunner used by ``setup.py test`` doesn't know about them, and those
          tests then fail.  See ``zope.testing.testrunner.eggsupport:SkipLayers``.
        
        - Add support for Jython, when a garbage collector call is sent.
        
        - Add support to bootstrap on Jython.
        
        - Fix NameError in StartUpFailure.
        
        - Open doctest files in universal mode, so that packages released on Windows
          can be tested on Linux, for example.
        
        
        3.6.0 (2008-07-10)
        ------------------
        
        - Add ``-j`` option to parallel tests run in subprocesses.
        
        - RENormalizer accepts plain Python callables.
        
        - Add ``--slow-test`` option.
        
        - Add ``--no-progress`` and ``--auto-progress`` options.
        
        - Complete refactoring of the test runner into multiple code files and a more
          modular (pipeline-like) architecture.
        
        - Unify unit tests with the layer support by introducing a real unit test
          layer.
        
        - Add a doctest for ``zope.testing.module``. There were several bugs
          that were fixed:
        
          * ``README.txt`` was a really bad default argument for the module
            name, as it is not a proper dotted name. The code would
            immediately fail as it would look for the ``txt`` module in the
            ``README`` package. The default is now ``__main__``.
        
          * The ``tearDown`` function did not clean up the ``__name__`` entry in the
            global dictionary.
        
        - Fix a bug that caused a SubprocessError to be generated if a subprocess
          sent any output to stderr.
        
        - Fix a bug that caused the unit tests to be skipped if run in a subprocess.
        
        
        3.5.1 (2007-08-14)
        ------------------
        
        - Invoke post-mortem debugging for layer-setup failures.
        
        3.5.0 (2007-07-19)
        ------------------
        
        - Ensure that the test runner works on Python 2.5.
        
        - Add support for ``cProfile``.
        
        - Add output colorizing (``-c`` option).
        
        - Add ``--hide-secondary-failures`` and ``--show-secondary-failures`` options
          (https://bugs.launchpad.net/zope3/+bug/115454).
        
        - Fix some problems with Unicode in doctests.
        
        - Fix "Error reading from subprocess" errors on Unix-like systems.
        
        3.4 (2007-03-29)
        ----------------
        
        - Add ``exit-with-status`` support (supports use with buildbot and
          ``zc.recipe.testing``)
        
        - Add a small framework for automating set up and tear down of
          doctest tests. See ``setupstack.txt``.
        
        - Allow ``testrunner-wo-source.txt`` and ``testrunner-errors.txt`` to run
          within a read-only source tree.
        
        3.0 (2006-09-20)
        ----------------
        
        - Update the doctest copy with text-file encoding support.
        
        - Add logging-level support to the ``loggingsuppport`` module.
        
        - At verbosity-level 1, dots are not output continuously, without any
          line breaks.
        
        - Improve output when the inability to tear down a layer causes tests
          to be run in a subprocess.
        
        - Make ``zope.exception`` required only if the ``zope_tracebacks`` extra is
          requested.
        
        - Fix the test coverage. If a module, for example `interfaces`, was in an
          ignored directory/package, then if a module of the same name existed in a
          covered directory/package, then it was also ignored there, because the
          ignore cache stored the result by module name and not the filename of the
          module.
        
        2.0 (2006-01-05)
        ----------------
        
        - Release a separate project corresponding to the version of ``zope.testing``
          shipped as part of the Zope 3.2.0 release.
        
Keywords: zope testing doctest RENormalizing OutputChecker timeout logging
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Zope Public License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Framework :: Zope :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Testing
Provides-Extra: test