/usr/lib/python3/dist-packages/zope/testing/doctestcase.txt is in python3-zope.testing 4.5.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | 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'
|