Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1 | """ |
| 2 | Test script for doctest. |
| 3 | """ |
| 4 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 5 | from test import support |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 6 | import doctest |
| 7 | |
Florent Xicluna | dc6f2d0 | 2010-04-02 19:25:32 +0000 | [diff] [blame] | 8 | |
Nick Coghlan | f088e5e | 2008-12-14 11:50:48 +0000 | [diff] [blame] | 9 | # NOTE: There are some additional tests relating to interaction with |
| 10 | # zipimport in the test_zipimport_support test module. |
| 11 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 12 | ###################################################################### |
| 13 | ## Sample Objects (used by test cases) |
| 14 | ###################################################################### |
| 15 | |
| 16 | def sample_func(v): |
| 17 | """ |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 18 | Blah blah |
| 19 | |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 20 | >>> print(sample_func(22)) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 21 | 44 |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 22 | |
| 23 | Yee ha! |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 24 | """ |
| 25 | return v+v |
| 26 | |
| 27 | class SampleClass: |
| 28 | """ |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 29 | >>> print(1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 30 | 1 |
Edward Loper | 4ae900f | 2004-09-21 03:20:34 +0000 | [diff] [blame] | 31 | |
| 32 | >>> # comments get ignored. so are empty PS1 and PS2 prompts: |
| 33 | >>> |
| 34 | ... |
| 35 | |
| 36 | Multiline example: |
| 37 | >>> sc = SampleClass(3) |
| 38 | >>> for i in range(10): |
| 39 | ... sc = sc.double() |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 40 | ... print(' ', sc.get(), sep='', end='') |
| 41 | 6 12 24 48 96 192 384 768 1536 3072 |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 42 | """ |
| 43 | def __init__(self, val): |
| 44 | """ |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 45 | >>> print(SampleClass(12).get()) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 46 | 12 |
| 47 | """ |
| 48 | self.val = val |
| 49 | |
| 50 | def double(self): |
| 51 | """ |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 52 | >>> print(SampleClass(12).double().get()) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 53 | 24 |
| 54 | """ |
| 55 | return SampleClass(self.val + self.val) |
| 56 | |
| 57 | def get(self): |
| 58 | """ |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 59 | >>> print(SampleClass(-5).get()) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 60 | -5 |
| 61 | """ |
| 62 | return self.val |
| 63 | |
| 64 | def a_staticmethod(v): |
| 65 | """ |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 66 | >>> print(SampleClass.a_staticmethod(10)) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 67 | 11 |
| 68 | """ |
| 69 | return v+1 |
| 70 | a_staticmethod = staticmethod(a_staticmethod) |
| 71 | |
| 72 | def a_classmethod(cls, v): |
| 73 | """ |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 74 | >>> print(SampleClass.a_classmethod(10)) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 75 | 12 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 76 | >>> print(SampleClass(0).a_classmethod(10)) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 77 | 12 |
| 78 | """ |
| 79 | return v+2 |
| 80 | a_classmethod = classmethod(a_classmethod) |
| 81 | |
| 82 | a_property = property(get, doc=""" |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 83 | >>> print(SampleClass(22).a_property) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 84 | 22 |
| 85 | """) |
| 86 | |
| 87 | class NestedClass: |
| 88 | """ |
| 89 | >>> x = SampleClass.NestedClass(5) |
| 90 | >>> y = x.square() |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 91 | >>> print(y.get()) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 92 | 25 |
| 93 | """ |
| 94 | def __init__(self, val=0): |
| 95 | """ |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 96 | >>> print(SampleClass.NestedClass().get()) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 97 | 0 |
| 98 | """ |
| 99 | self.val = val |
| 100 | def square(self): |
| 101 | return SampleClass.NestedClass(self.val*self.val) |
| 102 | def get(self): |
| 103 | return self.val |
| 104 | |
| 105 | class SampleNewStyleClass(object): |
| 106 | r""" |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 107 | >>> print('1\n2\n3') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 108 | 1 |
| 109 | 2 |
| 110 | 3 |
| 111 | """ |
| 112 | def __init__(self, val): |
| 113 | """ |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 114 | >>> print(SampleNewStyleClass(12).get()) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 115 | 12 |
| 116 | """ |
| 117 | self.val = val |
| 118 | |
| 119 | def double(self): |
| 120 | """ |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 121 | >>> print(SampleNewStyleClass(12).double().get()) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 122 | 24 |
| 123 | """ |
| 124 | return SampleNewStyleClass(self.val + self.val) |
| 125 | |
| 126 | def get(self): |
| 127 | """ |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 128 | >>> print(SampleNewStyleClass(-5).get()) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 129 | -5 |
| 130 | """ |
| 131 | return self.val |
| 132 | |
| 133 | ###################################################################### |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 134 | ## Fake stdin (for testing interactive debugging) |
| 135 | ###################################################################### |
| 136 | |
| 137 | class _FakeInput: |
| 138 | """ |
| 139 | A fake input stream for pdb's interactive debugger. Whenever a |
| 140 | line is read, print it (to simulate the user typing it), and then |
| 141 | return it. The set of lines to return is specified in the |
| 142 | constructor; they should not have trailing newlines. |
| 143 | """ |
| 144 | def __init__(self, lines): |
| 145 | self.lines = lines |
| 146 | |
| 147 | def readline(self): |
| 148 | line = self.lines.pop(0) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 149 | print(line) |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 150 | return line+'\n' |
| 151 | |
| 152 | ###################################################################### |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 153 | ## Test Cases |
| 154 | ###################################################################### |
| 155 | |
| 156 | def test_Example(): r""" |
| 157 | Unit tests for the `Example` class. |
| 158 | |
Edward Loper | a6b6832 | 2004-08-26 00:05:43 +0000 | [diff] [blame] | 159 | Example is a simple container class that holds: |
| 160 | - `source`: A source string. |
| 161 | - `want`: An expected output string. |
| 162 | - `exc_msg`: An expected exception message string (or None if no |
| 163 | exception is expected). |
| 164 | - `lineno`: A line number (within the docstring). |
| 165 | - `indent`: The example's indentation in the input string. |
| 166 | - `options`: An option dictionary, mapping option flags to True or |
| 167 | False. |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 168 | |
Edward Loper | a6b6832 | 2004-08-26 00:05:43 +0000 | [diff] [blame] | 169 | These attributes are set by the constructor. `source` and `want` are |
| 170 | required; the other attributes all have default values: |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 171 | |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 172 | >>> example = doctest.Example('print(1)', '1\n') |
Edward Loper | a6b6832 | 2004-08-26 00:05:43 +0000 | [diff] [blame] | 173 | >>> (example.source, example.want, example.exc_msg, |
| 174 | ... example.lineno, example.indent, example.options) |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 175 | ('print(1)\n', '1\n', None, 0, 0, {}) |
Edward Loper | a6b6832 | 2004-08-26 00:05:43 +0000 | [diff] [blame] | 176 | |
| 177 | The first three attributes (`source`, `want`, and `exc_msg`) may be |
| 178 | specified positionally; the remaining arguments should be specified as |
| 179 | keyword arguments: |
| 180 | |
| 181 | >>> exc_msg = 'IndexError: pop from an empty list' |
| 182 | >>> example = doctest.Example('[].pop()', '', exc_msg, |
| 183 | ... lineno=5, indent=4, |
| 184 | ... options={doctest.ELLIPSIS: True}) |
| 185 | >>> (example.source, example.want, example.exc_msg, |
| 186 | ... example.lineno, example.indent, example.options) |
| 187 | ('[].pop()\n', '', 'IndexError: pop from an empty list\n', 5, 4, {8: True}) |
| 188 | |
| 189 | The constructor normalizes the `source` string to end in a newline: |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 190 | |
Tim Peters | bb43147 | 2004-08-09 03:51:46 +0000 | [diff] [blame] | 191 | Source spans a single line: no terminating newline. |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 192 | >>> e = doctest.Example('print(1)', '1\n') |
Tim Peters | bb43147 | 2004-08-09 03:51:46 +0000 | [diff] [blame] | 193 | >>> e.source, e.want |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 194 | ('print(1)\n', '1\n') |
Tim Peters | bb43147 | 2004-08-09 03:51:46 +0000 | [diff] [blame] | 195 | |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 196 | >>> e = doctest.Example('print(1)\n', '1\n') |
Tim Peters | bb43147 | 2004-08-09 03:51:46 +0000 | [diff] [blame] | 197 | >>> e.source, e.want |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 198 | ('print(1)\n', '1\n') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 199 | |
Tim Peters | bb43147 | 2004-08-09 03:51:46 +0000 | [diff] [blame] | 200 | Source spans multiple lines: require terminating newline. |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 201 | >>> e = doctest.Example('print(1);\nprint(2)\n', '1\n2\n') |
Tim Peters | bb43147 | 2004-08-09 03:51:46 +0000 | [diff] [blame] | 202 | >>> e.source, e.want |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 203 | ('print(1);\nprint(2)\n', '1\n2\n') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 204 | |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 205 | >>> e = doctest.Example('print(1);\nprint(2)', '1\n2\n') |
Tim Peters | bb43147 | 2004-08-09 03:51:46 +0000 | [diff] [blame] | 206 | >>> e.source, e.want |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 207 | ('print(1);\nprint(2)\n', '1\n2\n') |
Tim Peters | bb43147 | 2004-08-09 03:51:46 +0000 | [diff] [blame] | 208 | |
Edward Loper | a6b6832 | 2004-08-26 00:05:43 +0000 | [diff] [blame] | 209 | Empty source string (which should never appear in real examples) |
| 210 | >>> e = doctest.Example('', '') |
| 211 | >>> e.source, e.want |
| 212 | ('\n', '') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 213 | |
Edward Loper | a6b6832 | 2004-08-26 00:05:43 +0000 | [diff] [blame] | 214 | The constructor normalizes the `want` string to end in a newline, |
| 215 | unless it's the empty string: |
| 216 | |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 217 | >>> e = doctest.Example('print(1)', '1\n') |
Tim Peters | bb43147 | 2004-08-09 03:51:46 +0000 | [diff] [blame] | 218 | >>> e.source, e.want |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 219 | ('print(1)\n', '1\n') |
Tim Peters | bb43147 | 2004-08-09 03:51:46 +0000 | [diff] [blame] | 220 | |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 221 | >>> e = doctest.Example('print(1)', '1') |
Tim Peters | bb43147 | 2004-08-09 03:51:46 +0000 | [diff] [blame] | 222 | >>> e.source, e.want |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 223 | ('print(1)\n', '1\n') |
Tim Peters | bb43147 | 2004-08-09 03:51:46 +0000 | [diff] [blame] | 224 | |
Edward Loper | a6b6832 | 2004-08-26 00:05:43 +0000 | [diff] [blame] | 225 | >>> e = doctest.Example('print', '') |
Tim Peters | bb43147 | 2004-08-09 03:51:46 +0000 | [diff] [blame] | 226 | >>> e.source, e.want |
| 227 | ('print\n', '') |
Edward Loper | a6b6832 | 2004-08-26 00:05:43 +0000 | [diff] [blame] | 228 | |
| 229 | The constructor normalizes the `exc_msg` string to end in a newline, |
| 230 | unless it's `None`: |
| 231 | |
| 232 | Message spans one line |
| 233 | >>> exc_msg = 'IndexError: pop from an empty list' |
| 234 | >>> e = doctest.Example('[].pop()', '', exc_msg) |
| 235 | >>> e.exc_msg |
| 236 | 'IndexError: pop from an empty list\n' |
| 237 | |
| 238 | >>> exc_msg = 'IndexError: pop from an empty list\n' |
| 239 | >>> e = doctest.Example('[].pop()', '', exc_msg) |
| 240 | >>> e.exc_msg |
| 241 | 'IndexError: pop from an empty list\n' |
| 242 | |
| 243 | Message spans multiple lines |
| 244 | >>> exc_msg = 'ValueError: 1\n 2' |
| 245 | >>> e = doctest.Example('raise ValueError("1\n 2")', '', exc_msg) |
| 246 | >>> e.exc_msg |
| 247 | 'ValueError: 1\n 2\n' |
| 248 | |
| 249 | >>> exc_msg = 'ValueError: 1\n 2\n' |
| 250 | >>> e = doctest.Example('raise ValueError("1\n 2")', '', exc_msg) |
| 251 | >>> e.exc_msg |
| 252 | 'ValueError: 1\n 2\n' |
| 253 | |
| 254 | Empty (but non-None) exception message (which should never appear |
| 255 | in real examples) |
| 256 | >>> exc_msg = '' |
| 257 | >>> e = doctest.Example('raise X()', '', exc_msg) |
| 258 | >>> e.exc_msg |
| 259 | '\n' |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 260 | """ |
| 261 | |
| 262 | def test_DocTest(): r""" |
| 263 | Unit tests for the `DocTest` class. |
| 264 | |
| 265 | DocTest is a collection of examples, extracted from a docstring, along |
| 266 | with information about where the docstring comes from (a name, |
| 267 | filename, and line number). The docstring is parsed by the `DocTest` |
| 268 | constructor: |
| 269 | |
| 270 | >>> docstring = ''' |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 271 | ... >>> print(12) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 272 | ... 12 |
| 273 | ... |
| 274 | ... Non-example text. |
| 275 | ... |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 276 | ... >>> print('another\example') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 277 | ... another |
| 278 | ... example |
| 279 | ... ''' |
| 280 | >>> globs = {} # globals to run the test in. |
Edward Loper | a1ef611 | 2004-08-09 16:14:41 +0000 | [diff] [blame] | 281 | >>> parser = doctest.DocTestParser() |
| 282 | >>> test = parser.get_doctest(docstring, globs, 'some_test', |
| 283 | ... 'some_file', 20) |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 284 | >>> print(test) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 285 | <DocTest some_test from some_file:20 (2 examples)> |
| 286 | >>> len(test.examples) |
| 287 | 2 |
| 288 | >>> e1, e2 = test.examples |
| 289 | >>> (e1.source, e1.want, e1.lineno) |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 290 | ('print(12)\n', '12\n', 1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 291 | >>> (e2.source, e2.want, e2.lineno) |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 292 | ("print('another\\example')\n", 'another\nexample\n', 6) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 293 | |
| 294 | Source information (name, filename, and line number) is available as |
| 295 | attributes on the doctest object: |
| 296 | |
| 297 | >>> (test.name, test.filename, test.lineno) |
| 298 | ('some_test', 'some_file', 20) |
| 299 | |
| 300 | The line number of an example within its containing file is found by |
| 301 | adding the line number of the example and the line number of its |
| 302 | containing test: |
| 303 | |
| 304 | >>> test.lineno + e1.lineno |
| 305 | 21 |
| 306 | >>> test.lineno + e2.lineno |
| 307 | 26 |
| 308 | |
| 309 | If the docstring contains inconsistant leading whitespace in the |
| 310 | expected output of an example, then `DocTest` will raise a ValueError: |
| 311 | |
| 312 | >>> docstring = r''' |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 313 | ... >>> print('bad\nindentation') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 314 | ... bad |
| 315 | ... indentation |
| 316 | ... ''' |
Edward Loper | a1ef611 | 2004-08-09 16:14:41 +0000 | [diff] [blame] | 317 | >>> parser.get_doctest(docstring, globs, 'some_test', 'filename', 0) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 318 | Traceback (most recent call last): |
Edward Loper | 00f8da7 | 2004-08-26 18:05:07 +0000 | [diff] [blame] | 319 | ValueError: line 4 of the docstring for some_test has inconsistent leading whitespace: 'indentation' |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 320 | |
| 321 | If the docstring contains inconsistent leading whitespace on |
| 322 | continuation lines, then `DocTest` will raise a ValueError: |
| 323 | |
| 324 | >>> docstring = r''' |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 325 | ... >>> print(('bad indentation', |
| 326 | ... ... 2)) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 327 | ... ('bad', 'indentation') |
| 328 | ... ''' |
Edward Loper | a1ef611 | 2004-08-09 16:14:41 +0000 | [diff] [blame] | 329 | >>> parser.get_doctest(docstring, globs, 'some_test', 'filename', 0) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 330 | Traceback (most recent call last): |
Guido van Rossum | e0192e5 | 2007-02-09 23:39:59 +0000 | [diff] [blame] | 331 | ValueError: line 2 of the docstring for some_test has inconsistent leading whitespace: '... 2))' |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 332 | |
| 333 | If there's no blank space after a PS1 prompt ('>>>'), then `DocTest` |
| 334 | will raise a ValueError: |
| 335 | |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 336 | >>> docstring = '>>>print(1)\n1' |
Edward Loper | a1ef611 | 2004-08-09 16:14:41 +0000 | [diff] [blame] | 337 | >>> parser.get_doctest(docstring, globs, 'some_test', 'filename', 0) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 338 | Traceback (most recent call last): |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 339 | ValueError: line 1 of the docstring for some_test lacks blank after >>>: '>>>print(1)' |
Edward Loper | 7c74846 | 2004-08-09 02:06:06 +0000 | [diff] [blame] | 340 | |
| 341 | If there's no blank space after a PS2 prompt ('...'), then `DocTest` |
| 342 | will raise a ValueError: |
| 343 | |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 344 | >>> docstring = '>>> if 1:\n...print(1)\n1' |
Edward Loper | a1ef611 | 2004-08-09 16:14:41 +0000 | [diff] [blame] | 345 | >>> parser.get_doctest(docstring, globs, 'some_test', 'filename', 0) |
Edward Loper | 7c74846 | 2004-08-09 02:06:06 +0000 | [diff] [blame] | 346 | Traceback (most recent call last): |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 347 | ValueError: line 2 of the docstring for some_test lacks blank after ...: '...print(1)' |
Edward Loper | 7c74846 | 2004-08-09 02:06:06 +0000 | [diff] [blame] | 348 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 349 | """ |
| 350 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 351 | def test_DocTestFinder(): r""" |
| 352 | Unit tests for the `DocTestFinder` class. |
| 353 | |
| 354 | DocTestFinder is used to extract DocTests from an object's docstring |
| 355 | and the docstrings of its contained objects. It can be used with |
| 356 | modules, functions, classes, methods, staticmethods, classmethods, and |
| 357 | properties. |
| 358 | |
| 359 | Finding Tests in Functions |
| 360 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 361 | For a function whose docstring contains examples, DocTestFinder.find() |
| 362 | will return a single test (for that function's docstring): |
| 363 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 364 | >>> finder = doctest.DocTestFinder() |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 365 | |
| 366 | We'll simulate a __file__ attr that ends in pyc: |
| 367 | |
| 368 | >>> import test.test_doctest |
| 369 | >>> old = test.test_doctest.__file__ |
| 370 | >>> test.test_doctest.__file__ = 'test_doctest.pyc' |
| 371 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 372 | >>> tests = finder.find(sample_func) |
Edward Loper | 8e4a34b | 2004-08-12 02:34:27 +0000 | [diff] [blame] | 373 | |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 374 | >>> print(tests) # doctest: +ELLIPSIS |
Nick Coghlan | f088e5e | 2008-12-14 11:50:48 +0000 | [diff] [blame] | 375 | [<DocTest sample_func from ...:16 (1 example)>] |
Edward Loper | 8e4a34b | 2004-08-12 02:34:27 +0000 | [diff] [blame] | 376 | |
Tim Peters | 4de7c5c | 2004-08-23 22:38:05 +0000 | [diff] [blame] | 377 | The exact name depends on how test_doctest was invoked, so allow for |
| 378 | leading path components. |
| 379 | |
| 380 | >>> tests[0].filename # doctest: +ELLIPSIS |
| 381 | '...test_doctest.py' |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 382 | |
| 383 | >>> test.test_doctest.__file__ = old |
Tim Peters | c6cbab0 | 2004-08-22 19:43:28 +0000 | [diff] [blame] | 384 | |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 385 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 386 | >>> e = tests[0].examples[0] |
Tim Peters | bb43147 | 2004-08-09 03:51:46 +0000 | [diff] [blame] | 387 | >>> (e.source, e.want, e.lineno) |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 388 | ('print(sample_func(22))\n', '44\n', 3) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 389 | |
Edward Loper | 32ddbf7 | 2004-09-13 05:47:24 +0000 | [diff] [blame] | 390 | By default, tests are created for objects with no docstring: |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 391 | |
| 392 | >>> def no_docstring(v): |
| 393 | ... pass |
Tim Peters | 958cc89 | 2004-09-13 14:53:28 +0000 | [diff] [blame] | 394 | >>> finder.find(no_docstring) |
| 395 | [] |
Edward Loper | 32ddbf7 | 2004-09-13 05:47:24 +0000 | [diff] [blame] | 396 | |
| 397 | However, the optional argument `exclude_empty` to the DocTestFinder |
| 398 | constructor can be used to exclude tests for objects with empty |
| 399 | docstrings: |
| 400 | |
| 401 | >>> def no_docstring(v): |
| 402 | ... pass |
| 403 | >>> excl_empty_finder = doctest.DocTestFinder(exclude_empty=True) |
| 404 | >>> excl_empty_finder.find(no_docstring) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 405 | [] |
| 406 | |
| 407 | If the function has a docstring with no examples, then a test with no |
| 408 | examples is returned. (This lets `DocTestRunner` collect statistics |
| 409 | about which functions have no tests -- but is that useful? And should |
| 410 | an empty test also be created when there's no docstring?) |
| 411 | |
| 412 | >>> def no_examples(v): |
| 413 | ... ''' no doctest examples ''' |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 414 | >>> finder.find(no_examples) # doctest: +ELLIPSIS |
| 415 | [<DocTest no_examples from ...:1 (no examples)>] |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 416 | |
| 417 | Finding Tests in Classes |
| 418 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
| 419 | For a class, DocTestFinder will create a test for the class's |
| 420 | docstring, and will recursively explore its contents, including |
| 421 | methods, classmethods, staticmethods, properties, and nested classes. |
| 422 | |
| 423 | >>> finder = doctest.DocTestFinder() |
| 424 | >>> tests = finder.find(SampleClass) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 425 | >>> for t in tests: |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 426 | ... print('%2s %s' % (len(t.examples), t.name)) |
Edward Loper | 4ae900f | 2004-09-21 03:20:34 +0000 | [diff] [blame] | 427 | 3 SampleClass |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 428 | 3 SampleClass.NestedClass |
| 429 | 1 SampleClass.NestedClass.__init__ |
| 430 | 1 SampleClass.__init__ |
| 431 | 2 SampleClass.a_classmethod |
| 432 | 1 SampleClass.a_property |
| 433 | 1 SampleClass.a_staticmethod |
| 434 | 1 SampleClass.double |
| 435 | 1 SampleClass.get |
| 436 | |
| 437 | New-style classes are also supported: |
| 438 | |
| 439 | >>> tests = finder.find(SampleNewStyleClass) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 440 | >>> for t in tests: |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 441 | ... print('%2s %s' % (len(t.examples), t.name)) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 442 | 1 SampleNewStyleClass |
| 443 | 1 SampleNewStyleClass.__init__ |
| 444 | 1 SampleNewStyleClass.double |
| 445 | 1 SampleNewStyleClass.get |
| 446 | |
| 447 | Finding Tests in Modules |
| 448 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
| 449 | For a module, DocTestFinder will create a test for the class's |
| 450 | docstring, and will recursively explore its contents, including |
| 451 | functions, classes, and the `__test__` dictionary, if it exists: |
| 452 | |
| 453 | >>> # A module |
Christian Heimes | 45f9af3 | 2007-11-27 21:50:00 +0000 | [diff] [blame] | 454 | >>> import types |
| 455 | >>> m = types.ModuleType('some_module') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 456 | >>> def triple(val): |
| 457 | ... ''' |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 458 | ... >>> print(triple(11)) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 459 | ... 33 |
| 460 | ... ''' |
| 461 | ... return val*3 |
| 462 | >>> m.__dict__.update({ |
| 463 | ... 'sample_func': sample_func, |
| 464 | ... 'SampleClass': SampleClass, |
| 465 | ... '__doc__': ''' |
| 466 | ... Module docstring. |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 467 | ... >>> print('module') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 468 | ... module |
| 469 | ... ''', |
| 470 | ... '__test__': { |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 471 | ... 'd': '>>> print(6)\n6\n>>> print(7)\n7\n', |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 472 | ... 'c': triple}}) |
| 473 | |
| 474 | >>> finder = doctest.DocTestFinder() |
| 475 | >>> # Use module=test.test_doctest, to prevent doctest from |
| 476 | >>> # ignoring the objects since they weren't defined in m. |
| 477 | >>> import test.test_doctest |
| 478 | >>> tests = finder.find(m, module=test.test_doctest) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 479 | >>> for t in tests: |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 480 | ... print('%2s %s' % (len(t.examples), t.name)) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 481 | 1 some_module |
Edward Loper | 4ae900f | 2004-09-21 03:20:34 +0000 | [diff] [blame] | 482 | 3 some_module.SampleClass |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 483 | 3 some_module.SampleClass.NestedClass |
| 484 | 1 some_module.SampleClass.NestedClass.__init__ |
| 485 | 1 some_module.SampleClass.__init__ |
| 486 | 2 some_module.SampleClass.a_classmethod |
| 487 | 1 some_module.SampleClass.a_property |
| 488 | 1 some_module.SampleClass.a_staticmethod |
| 489 | 1 some_module.SampleClass.double |
| 490 | 1 some_module.SampleClass.get |
Tim Peters | c568478 | 2004-09-13 01:07:12 +0000 | [diff] [blame] | 491 | 1 some_module.__test__.c |
| 492 | 2 some_module.__test__.d |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 493 | 1 some_module.sample_func |
| 494 | |
| 495 | Duplicate Removal |
| 496 | ~~~~~~~~~~~~~~~~~ |
| 497 | If a single object is listed twice (under different names), then tests |
| 498 | will only be generated for it once: |
| 499 | |
Tim Peters | f3f5747 | 2004-08-08 06:11:48 +0000 | [diff] [blame] | 500 | >>> from test import doctest_aliases |
Benjamin Peterson | 78565b2 | 2009-06-28 19:19:51 +0000 | [diff] [blame] | 501 | >>> assert doctest_aliases.TwoNames.f |
| 502 | >>> assert doctest_aliases.TwoNames.g |
Edward Loper | 32ddbf7 | 2004-09-13 05:47:24 +0000 | [diff] [blame] | 503 | >>> tests = excl_empty_finder.find(doctest_aliases) |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 504 | >>> print(len(tests)) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 505 | 2 |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 506 | >>> print(tests[0].name) |
Tim Peters | f3f5747 | 2004-08-08 06:11:48 +0000 | [diff] [blame] | 507 | test.doctest_aliases.TwoNames |
| 508 | |
| 509 | TwoNames.f and TwoNames.g are bound to the same object. |
| 510 | We can't guess which will be found in doctest's traversal of |
| 511 | TwoNames.__dict__ first, so we have to allow for either. |
| 512 | |
| 513 | >>> tests[1].name.split('.')[-1] in ['f', 'g'] |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 514 | True |
| 515 | |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 516 | Empty Tests |
| 517 | ~~~~~~~~~~~ |
| 518 | By default, an object with no doctests doesn't create any tests: |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 519 | |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 520 | >>> tests = doctest.DocTestFinder().find(SampleClass) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 521 | >>> for t in tests: |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 522 | ... print('%2s %s' % (len(t.examples), t.name)) |
Edward Loper | 4ae900f | 2004-09-21 03:20:34 +0000 | [diff] [blame] | 523 | 3 SampleClass |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 524 | 3 SampleClass.NestedClass |
| 525 | 1 SampleClass.NestedClass.__init__ |
Tim Peters | 958cc89 | 2004-09-13 14:53:28 +0000 | [diff] [blame] | 526 | 1 SampleClass.__init__ |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 527 | 2 SampleClass.a_classmethod |
| 528 | 1 SampleClass.a_property |
| 529 | 1 SampleClass.a_staticmethod |
Tim Peters | 958cc89 | 2004-09-13 14:53:28 +0000 | [diff] [blame] | 530 | 1 SampleClass.double |
| 531 | 1 SampleClass.get |
| 532 | |
| 533 | By default, that excluded objects with no doctests. exclude_empty=False |
| 534 | tells it to include (empty) tests for objects with no doctests. This feature |
| 535 | is really to support backward compatibility in what doctest.master.summarize() |
| 536 | displays. |
| 537 | |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 538 | >>> tests = doctest.DocTestFinder(exclude_empty=False).find(SampleClass) |
Tim Peters | 958cc89 | 2004-09-13 14:53:28 +0000 | [diff] [blame] | 539 | >>> for t in tests: |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 540 | ... print('%2s %s' % (len(t.examples), t.name)) |
Edward Loper | 4ae900f | 2004-09-21 03:20:34 +0000 | [diff] [blame] | 541 | 3 SampleClass |
Tim Peters | 958cc89 | 2004-09-13 14:53:28 +0000 | [diff] [blame] | 542 | 3 SampleClass.NestedClass |
| 543 | 1 SampleClass.NestedClass.__init__ |
Edward Loper | 32ddbf7 | 2004-09-13 05:47:24 +0000 | [diff] [blame] | 544 | 0 SampleClass.NestedClass.get |
| 545 | 0 SampleClass.NestedClass.square |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 546 | 1 SampleClass.__init__ |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 547 | 2 SampleClass.a_classmethod |
| 548 | 1 SampleClass.a_property |
| 549 | 1 SampleClass.a_staticmethod |
| 550 | 1 SampleClass.double |
| 551 | 1 SampleClass.get |
| 552 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 553 | Turning off Recursion |
| 554 | ~~~~~~~~~~~~~~~~~~~~~ |
| 555 | DocTestFinder can be told not to look for tests in contained objects |
| 556 | using the `recurse` flag: |
| 557 | |
| 558 | >>> tests = doctest.DocTestFinder(recurse=False).find(SampleClass) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 559 | >>> for t in tests: |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 560 | ... print('%2s %s' % (len(t.examples), t.name)) |
Edward Loper | 4ae900f | 2004-09-21 03:20:34 +0000 | [diff] [blame] | 561 | 3 SampleClass |
Edward Loper | b51b234 | 2004-08-17 16:37:12 +0000 | [diff] [blame] | 562 | |
| 563 | Line numbers |
| 564 | ~~~~~~~~~~~~ |
| 565 | DocTestFinder finds the line number of each example: |
| 566 | |
| 567 | >>> def f(x): |
| 568 | ... ''' |
| 569 | ... >>> x = 12 |
| 570 | ... |
| 571 | ... some text |
| 572 | ... |
| 573 | ... >>> # examples are not created for comments & bare prompts. |
| 574 | ... >>> |
| 575 | ... ... |
| 576 | ... |
| 577 | ... >>> for x in range(10): |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 578 | ... ... print(x, end=' ') |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 579 | ... 0 1 2 3 4 5 6 7 8 9 |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 580 | ... >>> x//2 |
| 581 | ... 6 |
Edward Loper | b51b234 | 2004-08-17 16:37:12 +0000 | [diff] [blame] | 582 | ... ''' |
| 583 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 584 | >>> [e.lineno for e in test.examples] |
| 585 | [1, 9, 12] |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 586 | """ |
| 587 | |
Edward Loper | 00f8da7 | 2004-08-26 18:05:07 +0000 | [diff] [blame] | 588 | def test_DocTestParser(): r""" |
| 589 | Unit tests for the `DocTestParser` class. |
| 590 | |
| 591 | DocTestParser is used to parse docstrings containing doctest examples. |
| 592 | |
| 593 | The `parse` method divides a docstring into examples and intervening |
| 594 | text: |
| 595 | |
| 596 | >>> s = ''' |
| 597 | ... >>> x, y = 2, 3 # no output expected |
| 598 | ... >>> if 1: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 599 | ... ... print(x) |
| 600 | ... ... print(y) |
Edward Loper | 00f8da7 | 2004-08-26 18:05:07 +0000 | [diff] [blame] | 601 | ... 2 |
| 602 | ... 3 |
| 603 | ... |
| 604 | ... Some text. |
| 605 | ... >>> x+y |
| 606 | ... 5 |
| 607 | ... ''' |
| 608 | >>> parser = doctest.DocTestParser() |
| 609 | >>> for piece in parser.parse(s): |
| 610 | ... if isinstance(piece, doctest.Example): |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 611 | ... print('Example:', (piece.source, piece.want, piece.lineno)) |
Edward Loper | 00f8da7 | 2004-08-26 18:05:07 +0000 | [diff] [blame] | 612 | ... else: |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 613 | ... print(' Text:', repr(piece)) |
Edward Loper | 00f8da7 | 2004-08-26 18:05:07 +0000 | [diff] [blame] | 614 | Text: '\n' |
| 615 | Example: ('x, y = 2, 3 # no output expected\n', '', 1) |
| 616 | Text: '' |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 617 | Example: ('if 1:\n print(x)\n print(y)\n', '2\n3\n', 2) |
Edward Loper | 00f8da7 | 2004-08-26 18:05:07 +0000 | [diff] [blame] | 618 | Text: '\nSome text.\n' |
| 619 | Example: ('x+y\n', '5\n', 9) |
| 620 | Text: '' |
| 621 | |
| 622 | The `get_examples` method returns just the examples: |
| 623 | |
| 624 | >>> for piece in parser.get_examples(s): |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 625 | ... print((piece.source, piece.want, piece.lineno)) |
Edward Loper | 00f8da7 | 2004-08-26 18:05:07 +0000 | [diff] [blame] | 626 | ('x, y = 2, 3 # no output expected\n', '', 1) |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 627 | ('if 1:\n print(x)\n print(y)\n', '2\n3\n', 2) |
Edward Loper | 00f8da7 | 2004-08-26 18:05:07 +0000 | [diff] [blame] | 628 | ('x+y\n', '5\n', 9) |
| 629 | |
| 630 | The `get_doctest` method creates a Test from the examples, along with the |
| 631 | given arguments: |
| 632 | |
| 633 | >>> test = parser.get_doctest(s, {}, 'name', 'filename', lineno=5) |
| 634 | >>> (test.name, test.filename, test.lineno) |
| 635 | ('name', 'filename', 5) |
| 636 | >>> for piece in test.examples: |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 637 | ... print((piece.source, piece.want, piece.lineno)) |
Edward Loper | 00f8da7 | 2004-08-26 18:05:07 +0000 | [diff] [blame] | 638 | ('x, y = 2, 3 # no output expected\n', '', 1) |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 639 | ('if 1:\n print(x)\n print(y)\n', '2\n3\n', 2) |
Edward Loper | 00f8da7 | 2004-08-26 18:05:07 +0000 | [diff] [blame] | 640 | ('x+y\n', '5\n', 9) |
| 641 | """ |
| 642 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 643 | class test_DocTestRunner: |
| 644 | def basics(): r""" |
| 645 | Unit tests for the `DocTestRunner` class. |
| 646 | |
| 647 | DocTestRunner is used to run DocTest test cases, and to accumulate |
| 648 | statistics. Here's a simple DocTest case we can use: |
| 649 | |
| 650 | >>> def f(x): |
| 651 | ... ''' |
| 652 | ... >>> x = 12 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 653 | ... >>> print(x) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 654 | ... 12 |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 655 | ... >>> x//2 |
| 656 | ... 6 |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 657 | ... ''' |
| 658 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 659 | |
| 660 | The main DocTestRunner interface is the `run` method, which runs a |
| 661 | given DocTest case in a given namespace (globs). It returns a tuple |
| 662 | `(f,t)`, where `f` is the number of failed tests and `t` is the number |
| 663 | of tried tests. |
| 664 | |
| 665 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 666 | TestResults(failed=0, attempted=3) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 667 | |
| 668 | If any example produces incorrect output, then the test runner reports |
| 669 | the failure and proceeds to the next example: |
| 670 | |
| 671 | >>> def f(x): |
| 672 | ... ''' |
| 673 | ... >>> x = 12 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 674 | ... >>> print(x) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 675 | ... 14 |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 676 | ... >>> x//2 |
| 677 | ... 6 |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 678 | ... ''' |
| 679 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 680 | >>> doctest.DocTestRunner(verbose=True).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 681 | ... # doctest: +ELLIPSIS |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 682 | Trying: |
| 683 | x = 12 |
| 684 | Expecting nothing |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 685 | ok |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 686 | Trying: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 687 | print(x) |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 688 | Expecting: |
| 689 | 14 |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 690 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 691 | File ..., line 4, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 692 | Failed example: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 693 | print(x) |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 694 | Expected: |
| 695 | 14 |
| 696 | Got: |
| 697 | 12 |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 698 | Trying: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 699 | x//2 |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 700 | Expecting: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 701 | 6 |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 702 | ok |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 703 | TestResults(failed=1, attempted=3) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 704 | """ |
| 705 | def verbose_flag(): r""" |
| 706 | The `verbose` flag makes the test runner generate more detailed |
| 707 | output: |
| 708 | |
| 709 | >>> def f(x): |
| 710 | ... ''' |
| 711 | ... >>> x = 12 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 712 | ... >>> print(x) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 713 | ... 12 |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 714 | ... >>> x//2 |
| 715 | ... 6 |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 716 | ... ''' |
| 717 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 718 | |
| 719 | >>> doctest.DocTestRunner(verbose=True).run(test) |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 720 | Trying: |
| 721 | x = 12 |
| 722 | Expecting nothing |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 723 | ok |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 724 | Trying: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 725 | print(x) |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 726 | Expecting: |
| 727 | 12 |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 728 | ok |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 729 | Trying: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 730 | x//2 |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 731 | Expecting: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 732 | 6 |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 733 | ok |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 734 | TestResults(failed=0, attempted=3) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 735 | |
| 736 | If the `verbose` flag is unspecified, then the output will be verbose |
| 737 | iff `-v` appears in sys.argv: |
| 738 | |
| 739 | >>> # Save the real sys.argv list. |
| 740 | >>> old_argv = sys.argv |
| 741 | |
| 742 | >>> # If -v does not appear in sys.argv, then output isn't verbose. |
| 743 | >>> sys.argv = ['test'] |
| 744 | >>> doctest.DocTestRunner().run(test) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 745 | TestResults(failed=0, attempted=3) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 746 | |
| 747 | >>> # If -v does appear in sys.argv, then output is verbose. |
| 748 | >>> sys.argv = ['test', '-v'] |
| 749 | >>> doctest.DocTestRunner().run(test) |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 750 | Trying: |
| 751 | x = 12 |
| 752 | Expecting nothing |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 753 | ok |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 754 | Trying: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 755 | print(x) |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 756 | Expecting: |
| 757 | 12 |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 758 | ok |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 759 | Trying: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 760 | x//2 |
Edward Loper | aacf083 | 2004-08-26 01:19:50 +0000 | [diff] [blame] | 761 | Expecting: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 762 | 6 |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 763 | ok |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 764 | TestResults(failed=0, attempted=3) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 765 | |
| 766 | >>> # Restore sys.argv |
| 767 | >>> sys.argv = old_argv |
| 768 | |
| 769 | In the remaining examples, the test runner's verbosity will be |
| 770 | explicitly set, to ensure that the test behavior is consistent. |
| 771 | """ |
| 772 | def exceptions(): r""" |
| 773 | Tests of `DocTestRunner`'s exception handling. |
| 774 | |
| 775 | An expected exception is specified with a traceback message. The |
| 776 | lines between the first line and the type/value may be omitted or |
| 777 | replaced with any other string: |
| 778 | |
| 779 | >>> def f(x): |
| 780 | ... ''' |
| 781 | ... >>> x = 12 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 782 | ... >>> print(x//0) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 783 | ... Traceback (most recent call last): |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 784 | ... ZeroDivisionError: integer division or modulo by zero |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 785 | ... ''' |
| 786 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 787 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 788 | TestResults(failed=0, attempted=2) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 789 | |
Edward Loper | 19b1958 | 2004-08-25 23:07:03 +0000 | [diff] [blame] | 790 | An example may not generate output before it raises an exception; if |
| 791 | it does, then the traceback message will not be recognized as |
| 792 | signaling an expected exception, so the example will be reported as an |
| 793 | unexpected exception: |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 794 | |
| 795 | >>> def f(x): |
| 796 | ... ''' |
| 797 | ... >>> x = 12 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 798 | ... >>> print('pre-exception output', x//0) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 799 | ... pre-exception output |
| 800 | ... Traceback (most recent call last): |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 801 | ... ZeroDivisionError: integer division or modulo by zero |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 802 | ... ''' |
| 803 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 804 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Edward Loper | 19b1958 | 2004-08-25 23:07:03 +0000 | [diff] [blame] | 805 | ... # doctest: +ELLIPSIS |
| 806 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 807 | File ..., line 4, in f |
Edward Loper | 19b1958 | 2004-08-25 23:07:03 +0000 | [diff] [blame] | 808 | Failed example: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 809 | print('pre-exception output', x//0) |
Edward Loper | 19b1958 | 2004-08-25 23:07:03 +0000 | [diff] [blame] | 810 | Exception raised: |
| 811 | ... |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 812 | ZeroDivisionError: integer division or modulo by zero |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 813 | TestResults(failed=1, attempted=2) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 814 | |
| 815 | Exception messages may contain newlines: |
| 816 | |
| 817 | >>> def f(x): |
| 818 | ... r''' |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 819 | ... >>> raise ValueError('multi\nline\nmessage') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 820 | ... Traceback (most recent call last): |
| 821 | ... ValueError: multi |
| 822 | ... line |
| 823 | ... message |
| 824 | ... ''' |
| 825 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 826 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 827 | TestResults(failed=0, attempted=1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 828 | |
| 829 | If an exception is expected, but an exception with the wrong type or |
| 830 | message is raised, then it is reported as a failure: |
| 831 | |
| 832 | >>> def f(x): |
| 833 | ... r''' |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 834 | ... >>> raise ValueError('message') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 835 | ... Traceback (most recent call last): |
| 836 | ... ValueError: wrong message |
| 837 | ... ''' |
| 838 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 839 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Edward Loper | 8e4a34b | 2004-08-12 02:34:27 +0000 | [diff] [blame] | 840 | ... # doctest: +ELLIPSIS |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 841 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 842 | File ..., line 3, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 843 | Failed example: |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 844 | raise ValueError('message') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 845 | Expected: |
| 846 | Traceback (most recent call last): |
| 847 | ValueError: wrong message |
| 848 | Got: |
| 849 | Traceback (most recent call last): |
Edward Loper | 8e4a34b | 2004-08-12 02:34:27 +0000 | [diff] [blame] | 850 | ... |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 851 | ValueError: message |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 852 | TestResults(failed=1, attempted=1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 853 | |
Tim Peters | 1fbf9c5 | 2004-09-04 17:21:02 +0000 | [diff] [blame] | 854 | However, IGNORE_EXCEPTION_DETAIL can be used to allow a mismatch in the |
| 855 | detail: |
| 856 | |
| 857 | >>> def f(x): |
| 858 | ... r''' |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 859 | ... >>> raise ValueError('message') #doctest: +IGNORE_EXCEPTION_DETAIL |
Tim Peters | 1fbf9c5 | 2004-09-04 17:21:02 +0000 | [diff] [blame] | 860 | ... Traceback (most recent call last): |
| 861 | ... ValueError: wrong message |
| 862 | ... ''' |
| 863 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 864 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 865 | TestResults(failed=0, attempted=1) |
Tim Peters | 1fbf9c5 | 2004-09-04 17:21:02 +0000 | [diff] [blame] | 866 | |
Nick Coghlan | 5e76e94 | 2010-06-12 13:42:46 +0000 | [diff] [blame] | 867 | IGNORE_EXCEPTION_DETAIL also ignores difference in exception formatting |
| 868 | between Python versions. For example, in Python 2.x, the module path of |
| 869 | the exception is not in the output, but this will fail under Python 3: |
| 870 | |
| 871 | >>> def f(x): |
| 872 | ... r''' |
| 873 | ... >>> from http.client import HTTPException |
| 874 | ... >>> raise HTTPException('message') |
| 875 | ... Traceback (most recent call last): |
| 876 | ... HTTPException: message |
| 877 | ... ''' |
| 878 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 879 | >>> doctest.DocTestRunner(verbose=False).run(test) |
| 880 | ... # doctest: +ELLIPSIS |
| 881 | ********************************************************************** |
| 882 | File ..., line 4, in f |
| 883 | Failed example: |
| 884 | raise HTTPException('message') |
| 885 | Expected: |
| 886 | Traceback (most recent call last): |
| 887 | HTTPException: message |
| 888 | Got: |
| 889 | Traceback (most recent call last): |
| 890 | ... |
| 891 | http.client.HTTPException: message |
| 892 | TestResults(failed=1, attempted=2) |
| 893 | |
| 894 | But in Python 3 the module path is included, and therefore a test must look |
| 895 | like the following test to succeed in Python 3. But that test will fail under |
| 896 | Python 2. |
| 897 | |
| 898 | >>> def f(x): |
| 899 | ... r''' |
| 900 | ... >>> from http.client import HTTPException |
| 901 | ... >>> raise HTTPException('message') |
| 902 | ... Traceback (most recent call last): |
| 903 | ... http.client.HTTPException: message |
| 904 | ... ''' |
| 905 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 906 | >>> doctest.DocTestRunner(verbose=False).run(test) |
| 907 | TestResults(failed=0, attempted=2) |
| 908 | |
| 909 | However, with IGNORE_EXCEPTION_DETAIL, the module name of the exception |
| 910 | (or its unexpected absence) will be ignored: |
| 911 | |
| 912 | >>> def f(x): |
| 913 | ... r''' |
| 914 | ... >>> from http.client import HTTPException |
| 915 | ... >>> raise HTTPException('message') #doctest: +IGNORE_EXCEPTION_DETAIL |
| 916 | ... Traceback (most recent call last): |
| 917 | ... HTTPException: message |
| 918 | ... ''' |
| 919 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 920 | >>> doctest.DocTestRunner(verbose=False).run(test) |
| 921 | TestResults(failed=0, attempted=2) |
| 922 | |
| 923 | The module path will be completely ignored, so two different module paths will |
| 924 | still pass if IGNORE_EXCEPTION_DETAIL is given. This is intentional, so it can |
| 925 | be used when exceptions have changed module. |
| 926 | |
| 927 | >>> def f(x): |
| 928 | ... r''' |
| 929 | ... >>> from http.client import HTTPException |
| 930 | ... >>> raise HTTPException('message') #doctest: +IGNORE_EXCEPTION_DETAIL |
| 931 | ... Traceback (most recent call last): |
| 932 | ... foo.bar.HTTPException: message |
| 933 | ... ''' |
| 934 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 935 | >>> doctest.DocTestRunner(verbose=False).run(test) |
| 936 | TestResults(failed=0, attempted=2) |
| 937 | |
Tim Peters | 1fbf9c5 | 2004-09-04 17:21:02 +0000 | [diff] [blame] | 938 | But IGNORE_EXCEPTION_DETAIL does not allow a mismatch in the exception type: |
| 939 | |
| 940 | >>> def f(x): |
| 941 | ... r''' |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 942 | ... >>> raise ValueError('message') #doctest: +IGNORE_EXCEPTION_DETAIL |
Tim Peters | 1fbf9c5 | 2004-09-04 17:21:02 +0000 | [diff] [blame] | 943 | ... Traceback (most recent call last): |
| 944 | ... TypeError: wrong type |
| 945 | ... ''' |
| 946 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 947 | >>> doctest.DocTestRunner(verbose=False).run(test) |
| 948 | ... # doctest: +ELLIPSIS |
| 949 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 950 | File ..., line 3, in f |
Tim Peters | 1fbf9c5 | 2004-09-04 17:21:02 +0000 | [diff] [blame] | 951 | Failed example: |
Collin Winter | 3add4d7 | 2007-08-29 23:37:32 +0000 | [diff] [blame] | 952 | raise ValueError('message') #doctest: +IGNORE_EXCEPTION_DETAIL |
Tim Peters | 1fbf9c5 | 2004-09-04 17:21:02 +0000 | [diff] [blame] | 953 | Expected: |
| 954 | Traceback (most recent call last): |
| 955 | TypeError: wrong type |
| 956 | Got: |
| 957 | Traceback (most recent call last): |
| 958 | ... |
| 959 | ValueError: message |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 960 | TestResults(failed=1, attempted=1) |
Tim Peters | 1fbf9c5 | 2004-09-04 17:21:02 +0000 | [diff] [blame] | 961 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 962 | If an exception is raised but not expected, then it is reported as an |
| 963 | unexpected exception: |
| 964 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 965 | >>> def f(x): |
| 966 | ... r''' |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 967 | ... >>> 1//0 |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 968 | ... 0 |
| 969 | ... ''' |
| 970 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 971 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 972 | ... # doctest: +ELLIPSIS |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 973 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 974 | File ..., line 3, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 975 | Failed example: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 976 | 1//0 |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 977 | Exception raised: |
| 978 | Traceback (most recent call last): |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 979 | ... |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 980 | ZeroDivisionError: integer division or modulo by zero |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 981 | TestResults(failed=1, attempted=1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 982 | """ |
| 983 | def optionflags(): r""" |
| 984 | Tests of `DocTestRunner`'s option flag handling. |
| 985 | |
| 986 | Several option flags can be used to customize the behavior of the test |
| 987 | runner. These are defined as module constants in doctest, and passed |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 988 | to the DocTestRunner constructor (multiple constants should be ORed |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 989 | together). |
| 990 | |
| 991 | The DONT_ACCEPT_TRUE_FOR_1 flag disables matches between True/False |
| 992 | and 1/0: |
| 993 | |
| 994 | >>> def f(x): |
| 995 | ... '>>> True\n1\n' |
| 996 | |
| 997 | >>> # Without the flag: |
| 998 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 999 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1000 | TestResults(failed=0, attempted=1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1001 | |
| 1002 | >>> # With the flag: |
| 1003 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1004 | >>> flags = doctest.DONT_ACCEPT_TRUE_FOR_1 |
| 1005 | >>> doctest.DocTestRunner(verbose=False, optionflags=flags).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1006 | ... # doctest: +ELLIPSIS |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1007 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1008 | File ..., line 2, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1009 | Failed example: |
| 1010 | True |
| 1011 | Expected: |
| 1012 | 1 |
| 1013 | Got: |
| 1014 | True |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1015 | TestResults(failed=1, attempted=1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1016 | |
| 1017 | The DONT_ACCEPT_BLANKLINE flag disables the match between blank lines |
| 1018 | and the '<BLANKLINE>' marker: |
| 1019 | |
| 1020 | >>> def f(x): |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1021 | ... '>>> print("a\\n\\nb")\na\n<BLANKLINE>\nb\n' |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1022 | |
| 1023 | >>> # Without the flag: |
| 1024 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1025 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1026 | TestResults(failed=0, attempted=1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1027 | |
| 1028 | >>> # With the flag: |
| 1029 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1030 | >>> flags = doctest.DONT_ACCEPT_BLANKLINE |
| 1031 | >>> doctest.DocTestRunner(verbose=False, optionflags=flags).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1032 | ... # doctest: +ELLIPSIS |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1033 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1034 | File ..., line 2, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1035 | Failed example: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1036 | print("a\n\nb") |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1037 | Expected: |
| 1038 | a |
| 1039 | <BLANKLINE> |
| 1040 | b |
| 1041 | Got: |
| 1042 | a |
| 1043 | <BLANKLINE> |
| 1044 | b |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1045 | TestResults(failed=1, attempted=1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1046 | |
| 1047 | The NORMALIZE_WHITESPACE flag causes all sequences of whitespace to be |
| 1048 | treated as equal: |
| 1049 | |
| 1050 | >>> def f(x): |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1051 | ... '>>> print(1, 2, 3)\n 1 2\n 3' |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1052 | |
| 1053 | >>> # Without the flag: |
| 1054 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1055 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1056 | ... # doctest: +ELLIPSIS |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1057 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1058 | File ..., line 2, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1059 | Failed example: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1060 | print(1, 2, 3) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1061 | Expected: |
| 1062 | 1 2 |
| 1063 | 3 |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1064 | Got: |
| 1065 | 1 2 3 |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1066 | TestResults(failed=1, attempted=1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1067 | |
| 1068 | >>> # With the flag: |
| 1069 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1070 | >>> flags = doctest.NORMALIZE_WHITESPACE |
| 1071 | >>> doctest.DocTestRunner(verbose=False, optionflags=flags).run(test) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1072 | TestResults(failed=0, attempted=1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1073 | |
Tim Peters | 026f8dc | 2004-08-19 16:38:58 +0000 | [diff] [blame] | 1074 | An example from the docs: |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1075 | >>> print(list(range(20))) #doctest: +NORMALIZE_WHITESPACE |
Tim Peters | 026f8dc | 2004-08-19 16:38:58 +0000 | [diff] [blame] | 1076 | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, |
| 1077 | 10, 11, 12, 13, 14, 15, 16, 17, 18, 19] |
| 1078 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1079 | The ELLIPSIS flag causes ellipsis marker ("...") in the expected |
| 1080 | output to match any substring in the actual output: |
| 1081 | |
| 1082 | >>> def f(x): |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1083 | ... '>>> print(list(range(15)))\n[0, 1, 2, ..., 14]\n' |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1084 | |
| 1085 | >>> # Without the flag: |
| 1086 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1087 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1088 | ... # doctest: +ELLIPSIS |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1089 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1090 | File ..., line 2, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1091 | Failed example: |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1092 | print(list(range(15))) |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1093 | Expected: |
| 1094 | [0, 1, 2, ..., 14] |
| 1095 | Got: |
| 1096 | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14] |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1097 | TestResults(failed=1, attempted=1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1098 | |
| 1099 | >>> # With the flag: |
| 1100 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1101 | >>> flags = doctest.ELLIPSIS |
| 1102 | >>> doctest.DocTestRunner(verbose=False, optionflags=flags).run(test) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1103 | TestResults(failed=0, attempted=1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1104 | |
Tim Peters | e594bee | 2004-08-22 01:47:51 +0000 | [diff] [blame] | 1105 | ... also matches nothing: |
Tim Peters | 1cf3aa6 | 2004-08-19 06:49:33 +0000 | [diff] [blame] | 1106 | |
Guido van Rossum | e0192e5 | 2007-02-09 23:39:59 +0000 | [diff] [blame] | 1107 | >>> if 1: |
| 1108 | ... for i in range(100): |
| 1109 | ... print(i**2, end=' ') #doctest: +ELLIPSIS |
| 1110 | ... print('!') |
| 1111 | 0 1...4...9 16 ... 36 49 64 ... 9801 ! |
Tim Peters | 1cf3aa6 | 2004-08-19 06:49:33 +0000 | [diff] [blame] | 1112 | |
Tim Peters | 026f8dc | 2004-08-19 16:38:58 +0000 | [diff] [blame] | 1113 | ... can be surprising; e.g., this test passes: |
Tim Peters | 26b3ebb | 2004-08-19 08:10:08 +0000 | [diff] [blame] | 1114 | |
Guido van Rossum | e0192e5 | 2007-02-09 23:39:59 +0000 | [diff] [blame] | 1115 | >>> if 1: #doctest: +ELLIPSIS |
| 1116 | ... for i in range(20): |
| 1117 | ... print(i, end=' ') |
| 1118 | ... print(20) |
Tim Peters | e594bee | 2004-08-22 01:47:51 +0000 | [diff] [blame] | 1119 | 0 1 2 ...1...2...0 |
Tim Peters | 26b3ebb | 2004-08-19 08:10:08 +0000 | [diff] [blame] | 1120 | |
Tim Peters | 026f8dc | 2004-08-19 16:38:58 +0000 | [diff] [blame] | 1121 | Examples from the docs: |
| 1122 | |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1123 | >>> print(list(range(20))) # doctest:+ELLIPSIS |
Tim Peters | 026f8dc | 2004-08-19 16:38:58 +0000 | [diff] [blame] | 1124 | [0, 1, ..., 18, 19] |
| 1125 | |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1126 | >>> print(list(range(20))) # doctest: +ELLIPSIS |
Tim Peters | 026f8dc | 2004-08-19 16:38:58 +0000 | [diff] [blame] | 1127 | ... # doctest: +NORMALIZE_WHITESPACE |
| 1128 | [0, 1, ..., 18, 19] |
| 1129 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1130 | The SKIP flag causes an example to be skipped entirely. I.e., the |
| 1131 | example is not run. It can be useful in contexts where doctest |
| 1132 | examples serve as both documentation and test cases, and an example |
| 1133 | should be included for documentation purposes, but should not be |
| 1134 | checked (e.g., because its output is random, or depends on resources |
| 1135 | which would be unavailable.) The SKIP flag can also be used for |
| 1136 | 'commenting out' broken examples. |
| 1137 | |
| 1138 | >>> import unavailable_resource # doctest: +SKIP |
| 1139 | >>> unavailable_resource.do_something() # doctest: +SKIP |
| 1140 | >>> unavailable_resource.blow_up() # doctest: +SKIP |
| 1141 | Traceback (most recent call last): |
| 1142 | ... |
| 1143 | UncheckedBlowUpError: Nobody checks me. |
| 1144 | |
| 1145 | >>> import random |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 1146 | >>> print(random.random()) # doctest: +SKIP |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1147 | 0.721216923889 |
| 1148 | |
Edward Loper | 71f55af | 2004-08-26 01:41:51 +0000 | [diff] [blame] | 1149 | The REPORT_UDIFF flag causes failures that involve multi-line expected |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1150 | and actual outputs to be displayed using a unified diff: |
| 1151 | |
| 1152 | >>> def f(x): |
| 1153 | ... r''' |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1154 | ... >>> print('\n'.join('abcdefg')) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1155 | ... a |
| 1156 | ... B |
| 1157 | ... c |
| 1158 | ... d |
| 1159 | ... f |
| 1160 | ... g |
| 1161 | ... h |
| 1162 | ... ''' |
| 1163 | |
| 1164 | >>> # Without the flag: |
| 1165 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1166 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1167 | ... # doctest: +ELLIPSIS |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1168 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1169 | File ..., line 3, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1170 | Failed example: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1171 | print('\n'.join('abcdefg')) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1172 | Expected: |
| 1173 | a |
| 1174 | B |
| 1175 | c |
| 1176 | d |
| 1177 | f |
| 1178 | g |
| 1179 | h |
| 1180 | Got: |
| 1181 | a |
| 1182 | b |
| 1183 | c |
| 1184 | d |
| 1185 | e |
| 1186 | f |
| 1187 | g |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1188 | TestResults(failed=1, attempted=1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1189 | |
| 1190 | >>> # With the flag: |
| 1191 | >>> test = doctest.DocTestFinder().find(f)[0] |
Edward Loper | 71f55af | 2004-08-26 01:41:51 +0000 | [diff] [blame] | 1192 | >>> flags = doctest.REPORT_UDIFF |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1193 | >>> doctest.DocTestRunner(verbose=False, optionflags=flags).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1194 | ... # doctest: +ELLIPSIS |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1195 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1196 | File ..., line 3, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1197 | Failed example: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1198 | print('\n'.join('abcdefg')) |
Edward Loper | 5662929 | 2004-08-26 01:31:56 +0000 | [diff] [blame] | 1199 | Differences (unified diff with -expected +actual): |
Tim Peters | e7edcb8 | 2004-08-26 05:44:27 +0000 | [diff] [blame] | 1200 | @@ -1,7 +1,7 @@ |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1201 | a |
| 1202 | -B |
| 1203 | +b |
| 1204 | c |
| 1205 | d |
| 1206 | +e |
| 1207 | f |
| 1208 | g |
| 1209 | -h |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1210 | TestResults(failed=1, attempted=1) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1211 | |
Edward Loper | 71f55af | 2004-08-26 01:41:51 +0000 | [diff] [blame] | 1212 | The REPORT_CDIFF flag causes failures that involve multi-line expected |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1213 | and actual outputs to be displayed using a context diff: |
| 1214 | |
Edward Loper | 71f55af | 2004-08-26 01:41:51 +0000 | [diff] [blame] | 1215 | >>> # Reuse f() from the REPORT_UDIFF example, above. |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1216 | >>> test = doctest.DocTestFinder().find(f)[0] |
Edward Loper | 71f55af | 2004-08-26 01:41:51 +0000 | [diff] [blame] | 1217 | >>> flags = doctest.REPORT_CDIFF |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1218 | >>> doctest.DocTestRunner(verbose=False, optionflags=flags).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1219 | ... # doctest: +ELLIPSIS |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1220 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1221 | File ..., line 3, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1222 | Failed example: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1223 | print('\n'.join('abcdefg')) |
Edward Loper | 5662929 | 2004-08-26 01:31:56 +0000 | [diff] [blame] | 1224 | Differences (context diff with expected followed by actual): |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1225 | *************** |
Tim Peters | e7edcb8 | 2004-08-26 05:44:27 +0000 | [diff] [blame] | 1226 | *** 1,7 **** |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1227 | a |
| 1228 | ! B |
| 1229 | c |
| 1230 | d |
| 1231 | f |
| 1232 | g |
| 1233 | - h |
Tim Peters | e7edcb8 | 2004-08-26 05:44:27 +0000 | [diff] [blame] | 1234 | --- 1,7 ---- |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1235 | a |
| 1236 | ! b |
| 1237 | c |
| 1238 | d |
| 1239 | + e |
| 1240 | f |
| 1241 | g |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1242 | TestResults(failed=1, attempted=1) |
Tim Peters | c6cbab0 | 2004-08-22 19:43:28 +0000 | [diff] [blame] | 1243 | |
| 1244 | |
Edward Loper | 71f55af | 2004-08-26 01:41:51 +0000 | [diff] [blame] | 1245 | The REPORT_NDIFF flag causes failures to use the difflib.Differ algorithm |
Tim Peters | c6cbab0 | 2004-08-22 19:43:28 +0000 | [diff] [blame] | 1246 | used by the popular ndiff.py utility. This does intraline difference |
| 1247 | marking, as well as interline differences. |
| 1248 | |
| 1249 | >>> def f(x): |
| 1250 | ... r''' |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1251 | ... >>> print("a b c d e f g h i j k l m") |
Tim Peters | c6cbab0 | 2004-08-22 19:43:28 +0000 | [diff] [blame] | 1252 | ... a b c d e f g h i j k 1 m |
| 1253 | ... ''' |
| 1254 | >>> test = doctest.DocTestFinder().find(f)[0] |
Edward Loper | 71f55af | 2004-08-26 01:41:51 +0000 | [diff] [blame] | 1255 | >>> flags = doctest.REPORT_NDIFF |
Tim Peters | c6cbab0 | 2004-08-22 19:43:28 +0000 | [diff] [blame] | 1256 | >>> doctest.DocTestRunner(verbose=False, optionflags=flags).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1257 | ... # doctest: +ELLIPSIS |
Tim Peters | c6cbab0 | 2004-08-22 19:43:28 +0000 | [diff] [blame] | 1258 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1259 | File ..., line 3, in f |
Tim Peters | c6cbab0 | 2004-08-22 19:43:28 +0000 | [diff] [blame] | 1260 | Failed example: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1261 | print("a b c d e f g h i j k l m") |
Tim Peters | c6cbab0 | 2004-08-22 19:43:28 +0000 | [diff] [blame] | 1262 | Differences (ndiff with -expected +actual): |
| 1263 | - a b c d e f g h i j k 1 m |
| 1264 | ? ^ |
| 1265 | + a b c d e f g h i j k l m |
| 1266 | ? + ++ ^ |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1267 | TestResults(failed=1, attempted=1) |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1268 | |
| 1269 | The REPORT_ONLY_FIRST_FAILURE supresses result output after the first |
| 1270 | failing example: |
| 1271 | |
| 1272 | >>> def f(x): |
| 1273 | ... r''' |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1274 | ... >>> print(1) # first success |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1275 | ... 1 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1276 | ... >>> print(2) # first failure |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1277 | ... 200 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1278 | ... >>> print(3) # second failure |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1279 | ... 300 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1280 | ... >>> print(4) # second success |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1281 | ... 4 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1282 | ... >>> print(5) # third failure |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1283 | ... 500 |
| 1284 | ... ''' |
| 1285 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1286 | >>> flags = doctest.REPORT_ONLY_FIRST_FAILURE |
| 1287 | >>> doctest.DocTestRunner(verbose=False, optionflags=flags).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1288 | ... # doctest: +ELLIPSIS |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1289 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1290 | File ..., line 5, in f |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1291 | Failed example: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1292 | print(2) # first failure |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1293 | Expected: |
| 1294 | 200 |
| 1295 | Got: |
| 1296 | 2 |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1297 | TestResults(failed=3, attempted=5) |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1298 | |
| 1299 | However, output from `report_start` is not supressed: |
| 1300 | |
| 1301 | >>> doctest.DocTestRunner(verbose=True, optionflags=flags).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1302 | ... # doctest: +ELLIPSIS |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1303 | Trying: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1304 | print(1) # first success |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1305 | Expecting: |
| 1306 | 1 |
| 1307 | ok |
| 1308 | Trying: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1309 | print(2) # first failure |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1310 | Expecting: |
| 1311 | 200 |
| 1312 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1313 | File ..., line 5, in f |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1314 | Failed example: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1315 | print(2) # first failure |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1316 | Expected: |
| 1317 | 200 |
| 1318 | Got: |
| 1319 | 2 |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1320 | TestResults(failed=3, attempted=5) |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1321 | |
| 1322 | For the purposes of REPORT_ONLY_FIRST_FAILURE, unexpected exceptions |
| 1323 | count as failures: |
| 1324 | |
| 1325 | >>> def f(x): |
| 1326 | ... r''' |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1327 | ... >>> print(1) # first success |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1328 | ... 1 |
| 1329 | ... >>> raise ValueError(2) # first failure |
| 1330 | ... 200 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1331 | ... >>> print(3) # second failure |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1332 | ... 300 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1333 | ... >>> print(4) # second success |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1334 | ... 4 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1335 | ... >>> print(5) # third failure |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1336 | ... 500 |
| 1337 | ... ''' |
| 1338 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1339 | >>> flags = doctest.REPORT_ONLY_FIRST_FAILURE |
| 1340 | >>> doctest.DocTestRunner(verbose=False, optionflags=flags).run(test) |
| 1341 | ... # doctest: +ELLIPSIS |
| 1342 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1343 | File ..., line 5, in f |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1344 | Failed example: |
| 1345 | raise ValueError(2) # first failure |
| 1346 | Exception raised: |
| 1347 | ... |
| 1348 | ValueError: 2 |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1349 | TestResults(failed=3, attempted=5) |
Edward Loper | a89f88d | 2004-08-26 02:45:51 +0000 | [diff] [blame] | 1350 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 1351 | New option flags can also be registered, via register_optionflag(). Here |
| 1352 | we reach into doctest's internals a bit. |
| 1353 | |
| 1354 | >>> unlikely = "UNLIKELY_OPTION_NAME" |
| 1355 | >>> unlikely in doctest.OPTIONFLAGS_BY_NAME |
| 1356 | False |
| 1357 | >>> new_flag_value = doctest.register_optionflag(unlikely) |
| 1358 | >>> unlikely in doctest.OPTIONFLAGS_BY_NAME |
| 1359 | True |
| 1360 | |
| 1361 | Before 2.4.4/2.5, registering a name more than once erroneously created |
| 1362 | more than one flag value. Here we verify that's fixed: |
| 1363 | |
| 1364 | >>> redundant_flag_value = doctest.register_optionflag(unlikely) |
| 1365 | >>> redundant_flag_value == new_flag_value |
| 1366 | True |
| 1367 | |
| 1368 | Clean up. |
| 1369 | >>> del doctest.OPTIONFLAGS_BY_NAME[unlikely] |
| 1370 | |
Tim Peters | c6cbab0 | 2004-08-22 19:43:28 +0000 | [diff] [blame] | 1371 | """ |
| 1372 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1373 | def option_directives(): r""" |
| 1374 | Tests of `DocTestRunner`'s option directive mechanism. |
| 1375 | |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1376 | Option directives can be used to turn option flags on or off for a |
| 1377 | single example. To turn an option on for an example, follow that |
| 1378 | example with a comment of the form ``# doctest: +OPTION``: |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1379 | |
| 1380 | >>> def f(x): r''' |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1381 | ... >>> print(list(range(10))) # should fail: no ellipsis |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1382 | ... [0, 1, ..., 9] |
| 1383 | ... |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1384 | ... >>> print(list(range(10))) # doctest: +ELLIPSIS |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1385 | ... [0, 1, ..., 9] |
| 1386 | ... ''' |
| 1387 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1388 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1389 | ... # doctest: +ELLIPSIS |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1390 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1391 | File ..., line 2, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1392 | Failed example: |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1393 | print(list(range(10))) # should fail: no ellipsis |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1394 | Expected: |
| 1395 | [0, 1, ..., 9] |
| 1396 | Got: |
| 1397 | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1398 | TestResults(failed=1, attempted=2) |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1399 | |
| 1400 | To turn an option off for an example, follow that example with a |
| 1401 | comment of the form ``# doctest: -OPTION``: |
| 1402 | |
| 1403 | >>> def f(x): r''' |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1404 | ... >>> print(list(range(10))) |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1405 | ... [0, 1, ..., 9] |
| 1406 | ... |
| 1407 | ... >>> # should fail: no ellipsis |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1408 | ... >>> print(list(range(10))) # doctest: -ELLIPSIS |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1409 | ... [0, 1, ..., 9] |
| 1410 | ... ''' |
| 1411 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1412 | >>> doctest.DocTestRunner(verbose=False, |
| 1413 | ... optionflags=doctest.ELLIPSIS).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1414 | ... # doctest: +ELLIPSIS |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1415 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1416 | File ..., line 6, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1417 | Failed example: |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1418 | print(list(range(10))) # doctest: -ELLIPSIS |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1419 | Expected: |
| 1420 | [0, 1, ..., 9] |
| 1421 | Got: |
| 1422 | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1423 | TestResults(failed=1, attempted=2) |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1424 | |
| 1425 | Option directives affect only the example that they appear with; they |
| 1426 | do not change the options for surrounding examples: |
Edward Loper | 8e4a34b | 2004-08-12 02:34:27 +0000 | [diff] [blame] | 1427 | |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1428 | >>> def f(x): r''' |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1429 | ... >>> print(list(range(10))) # Should fail: no ellipsis |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1430 | ... [0, 1, ..., 9] |
| 1431 | ... |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1432 | ... >>> print(list(range(10))) # doctest: +ELLIPSIS |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1433 | ... [0, 1, ..., 9] |
| 1434 | ... |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1435 | ... >>> print(list(range(10))) # Should fail: no ellipsis |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1436 | ... [0, 1, ..., 9] |
| 1437 | ... ''' |
| 1438 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1439 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1440 | ... # doctest: +ELLIPSIS |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1441 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1442 | File ..., line 2, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1443 | Failed example: |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1444 | print(list(range(10))) # Should fail: no ellipsis |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1445 | Expected: |
| 1446 | [0, 1, ..., 9] |
| 1447 | Got: |
| 1448 | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1449 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1450 | File ..., line 8, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1451 | Failed example: |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1452 | print(list(range(10))) # Should fail: no ellipsis |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1453 | Expected: |
| 1454 | [0, 1, ..., 9] |
| 1455 | Got: |
| 1456 | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1457 | TestResults(failed=2, attempted=3) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1458 | |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1459 | Multiple options may be modified by a single option directive. They |
| 1460 | may be separated by whitespace, commas, or both: |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1461 | |
| 1462 | >>> def f(x): r''' |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1463 | ... >>> print(list(range(10))) # Should fail |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1464 | ... [0, 1, ..., 9] |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1465 | ... >>> print(list(range(10))) # Should succeed |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1466 | ... ... # doctest: +ELLIPSIS +NORMALIZE_WHITESPACE |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1467 | ... [0, 1, ..., 9] |
| 1468 | ... ''' |
| 1469 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1470 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1471 | ... # doctest: +ELLIPSIS |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1472 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1473 | File ..., line 2, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1474 | Failed example: |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1475 | print(list(range(10))) # Should fail |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1476 | Expected: |
| 1477 | [0, 1, ..., 9] |
| 1478 | Got: |
| 1479 | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1480 | TestResults(failed=1, attempted=2) |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1481 | |
| 1482 | >>> def f(x): r''' |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1483 | ... >>> print(list(range(10))) # Should fail |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1484 | ... [0, 1, ..., 9] |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1485 | ... >>> print(list(range(10))) # Should succeed |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1486 | ... ... # doctest: +ELLIPSIS,+NORMALIZE_WHITESPACE |
| 1487 | ... [0, 1, ..., 9] |
| 1488 | ... ''' |
| 1489 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1490 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1491 | ... # doctest: +ELLIPSIS |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1492 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1493 | File ..., line 2, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1494 | Failed example: |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1495 | print(list(range(10))) # Should fail |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1496 | Expected: |
| 1497 | [0, 1, ..., 9] |
| 1498 | Got: |
| 1499 | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1500 | TestResults(failed=1, attempted=2) |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1501 | |
| 1502 | >>> def f(x): r''' |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1503 | ... >>> print(list(range(10))) # Should fail |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1504 | ... [0, 1, ..., 9] |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1505 | ... >>> print(list(range(10))) # Should succeed |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1506 | ... ... # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE |
| 1507 | ... [0, 1, ..., 9] |
| 1508 | ... ''' |
| 1509 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1510 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1511 | ... # doctest: +ELLIPSIS |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1512 | ********************************************************************** |
Tim Peters | 17b5637 | 2004-09-11 17:33:27 +0000 | [diff] [blame] | 1513 | File ..., line 2, in f |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1514 | Failed example: |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1515 | print(list(range(10))) # Should fail |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 1516 | Expected: |
| 1517 | [0, 1, ..., 9] |
| 1518 | Got: |
| 1519 | [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1520 | TestResults(failed=1, attempted=2) |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1521 | |
| 1522 | The option directive may be put on the line following the source, as |
| 1523 | long as a continuation prompt is used: |
| 1524 | |
| 1525 | >>> def f(x): r''' |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1526 | ... >>> print(list(range(10))) |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1527 | ... ... # doctest: +ELLIPSIS |
| 1528 | ... [0, 1, ..., 9] |
| 1529 | ... ''' |
| 1530 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1531 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1532 | TestResults(failed=0, attempted=1) |
Edward Loper | 8e4a34b | 2004-08-12 02:34:27 +0000 | [diff] [blame] | 1533 | |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1534 | For examples with multi-line source, the option directive may appear |
| 1535 | at the end of any line: |
| 1536 | |
| 1537 | >>> def f(x): r''' |
| 1538 | ... >>> for x in range(10): # doctest: +ELLIPSIS |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1539 | ... ... print(' ', x, end='', sep='') |
| 1540 | ... 0 1 2 ... 9 |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1541 | ... |
| 1542 | ... >>> for x in range(10): |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 1543 | ... ... print(' ', x, end='', sep='') # doctest: +ELLIPSIS |
| 1544 | ... 0 1 2 ... 9 |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1545 | ... ''' |
| 1546 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1547 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1548 | TestResults(failed=0, attempted=2) |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1549 | |
| 1550 | If more than one line of an example with multi-line source has an |
| 1551 | option directive, then they are combined: |
| 1552 | |
| 1553 | >>> def f(x): r''' |
| 1554 | ... Should fail (option directive not on the last line): |
| 1555 | ... >>> for x in range(10): # doctest: +ELLIPSIS |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1556 | ... ... print(x, end=' ') # doctest: +NORMALIZE_WHITESPACE |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1557 | ... 0 1 2...9 |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1558 | ... ''' |
| 1559 | >>> test = doctest.DocTestFinder().find(f)[0] |
| 1560 | >>> doctest.DocTestRunner(verbose=False).run(test) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1561 | TestResults(failed=0, attempted=1) |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1562 | |
| 1563 | It is an error to have a comment of the form ``# doctest:`` that is |
| 1564 | *not* followed by words of the form ``+OPTION`` or ``-OPTION``, where |
| 1565 | ``OPTION`` is an option that has been registered with |
| 1566 | `register_option`: |
| 1567 | |
| 1568 | >>> # Error: Option not registered |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1569 | >>> s = '>>> print(12) #doctest: +BADOPTION' |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1570 | >>> test = doctest.DocTestParser().get_doctest(s, {}, 's', 's.py', 0) |
| 1571 | Traceback (most recent call last): |
| 1572 | ValueError: line 1 of the doctest for s has an invalid option: '+BADOPTION' |
| 1573 | |
| 1574 | >>> # Error: No + or - prefix |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1575 | >>> s = '>>> print(12) #doctest: ELLIPSIS' |
Edward Loper | 74bca7a | 2004-08-12 02:27:44 +0000 | [diff] [blame] | 1576 | >>> test = doctest.DocTestParser().get_doctest(s, {}, 's', 's.py', 0) |
| 1577 | Traceback (most recent call last): |
| 1578 | ValueError: line 1 of the doctest for s has an invalid option: 'ELLIPSIS' |
| 1579 | |
| 1580 | It is an error to use an option directive on a line that contains no |
| 1581 | source: |
| 1582 | |
| 1583 | >>> s = '>>> # doctest: +ELLIPSIS' |
| 1584 | >>> test = doctest.DocTestParser().get_doctest(s, {}, 's', 's.py', 0) |
| 1585 | Traceback (most recent call last): |
| 1586 | ValueError: line 0 of the doctest for s has an option directive on a line with no example: '# doctest: +ELLIPSIS' |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1587 | """ |
| 1588 | |
| 1589 | def test_testsource(): r""" |
| 1590 | Unit tests for `testsource()`. |
| 1591 | |
| 1592 | The testsource() function takes a module and a name, finds the (first) |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1593 | test with that name in that module, and converts it to a script. The |
| 1594 | example code is converted to regular Python code. The surrounding |
| 1595 | words and expected output are converted to comments: |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1596 | |
| 1597 | >>> import test.test_doctest |
| 1598 | >>> name = 'test.test_doctest.sample_func' |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 1599 | >>> print(doctest.testsource(test.test_doctest, name)) |
Edward Loper | a5db600 | 2004-08-12 02:41:30 +0000 | [diff] [blame] | 1600 | # Blah blah |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1601 | # |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1602 | print(sample_func(22)) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1603 | # Expected: |
Edward Loper | a5db600 | 2004-08-12 02:41:30 +0000 | [diff] [blame] | 1604 | ## 44 |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1605 | # |
Edward Loper | a5db600 | 2004-08-12 02:41:30 +0000 | [diff] [blame] | 1606 | # Yee ha! |
Georg Brandl | ecf93c7 | 2005-06-26 23:09:51 +0000 | [diff] [blame] | 1607 | <BLANKLINE> |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1608 | |
| 1609 | >>> name = 'test.test_doctest.SampleNewStyleClass' |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 1610 | >>> print(doctest.testsource(test.test_doctest, name)) |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1611 | print('1\n2\n3') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1612 | # Expected: |
Edward Loper | a5db600 | 2004-08-12 02:41:30 +0000 | [diff] [blame] | 1613 | ## 1 |
| 1614 | ## 2 |
| 1615 | ## 3 |
Georg Brandl | ecf93c7 | 2005-06-26 23:09:51 +0000 | [diff] [blame] | 1616 | <BLANKLINE> |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1617 | |
| 1618 | >>> name = 'test.test_doctest.SampleClass.a_classmethod' |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 1619 | >>> print(doctest.testsource(test.test_doctest, name)) |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1620 | print(SampleClass.a_classmethod(10)) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1621 | # Expected: |
Edward Loper | a5db600 | 2004-08-12 02:41:30 +0000 | [diff] [blame] | 1622 | ## 12 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1623 | print(SampleClass(0).a_classmethod(10)) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1624 | # Expected: |
Edward Loper | a5db600 | 2004-08-12 02:41:30 +0000 | [diff] [blame] | 1625 | ## 12 |
Georg Brandl | ecf93c7 | 2005-06-26 23:09:51 +0000 | [diff] [blame] | 1626 | <BLANKLINE> |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1627 | """ |
| 1628 | |
| 1629 | def test_debug(): r""" |
| 1630 | |
| 1631 | Create a docstring that we want to debug: |
| 1632 | |
| 1633 | >>> s = ''' |
| 1634 | ... >>> x = 12 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1635 | ... >>> print(x) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1636 | ... 12 |
| 1637 | ... ''' |
| 1638 | |
| 1639 | Create some fake stdin input, to feed to the debugger: |
| 1640 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1641 | >>> real_stdin = sys.stdin |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1642 | >>> sys.stdin = _FakeInput(['next', 'print(x)', 'continue']) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1643 | |
| 1644 | Run the debugger on the docstring, and then restore sys.stdin. |
| 1645 | |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1646 | >>> try: doctest.debug_src(s) |
| 1647 | ... finally: sys.stdin = real_stdin |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 1648 | > <string>(1)<module>() |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1649 | (Pdb) next |
| 1650 | 12 |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1651 | --Return-- |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 1652 | > <string>(1)<module>()->None |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1653 | (Pdb) print(x) |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1654 | 12 |
| 1655 | (Pdb) continue |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 1656 | |
| 1657 | """ |
| 1658 | |
Jim Fulton | 356fd19 | 2004-08-09 11:34:47 +0000 | [diff] [blame] | 1659 | def test_pdb_set_trace(): |
Tim Peters | 50c6bdb | 2004-11-08 22:07:37 +0000 | [diff] [blame] | 1660 | """Using pdb.set_trace from a doctest. |
Jim Fulton | 356fd19 | 2004-08-09 11:34:47 +0000 | [diff] [blame] | 1661 | |
Tim Peters | 413ced6 | 2004-08-09 15:43:47 +0000 | [diff] [blame] | 1662 | You can use pdb.set_trace from a doctest. To do so, you must |
Jim Fulton | 356fd19 | 2004-08-09 11:34:47 +0000 | [diff] [blame] | 1663 | retrieve the set_trace function from the pdb module at the time |
Tim Peters | 413ced6 | 2004-08-09 15:43:47 +0000 | [diff] [blame] | 1664 | you use it. The doctest module changes sys.stdout so that it can |
| 1665 | capture program output. It also temporarily replaces pdb.set_trace |
| 1666 | with a version that restores stdout. This is necessary for you to |
Jim Fulton | 356fd19 | 2004-08-09 11:34:47 +0000 | [diff] [blame] | 1667 | see debugger output. |
| 1668 | |
| 1669 | >>> doc = ''' |
| 1670 | ... >>> x = 42 |
| 1671 | ... >>> import pdb; pdb.set_trace() |
| 1672 | ... ''' |
Edward Loper | a1ef611 | 2004-08-09 16:14:41 +0000 | [diff] [blame] | 1673 | >>> parser = doctest.DocTestParser() |
| 1674 | >>> test = parser.get_doctest(doc, {}, "foo", "foo.py", 0) |
Jim Fulton | 356fd19 | 2004-08-09 11:34:47 +0000 | [diff] [blame] | 1675 | >>> runner = doctest.DocTestRunner(verbose=False) |
| 1676 | |
| 1677 | To demonstrate this, we'll create a fake standard input that |
| 1678 | captures our debugger input: |
| 1679 | |
| 1680 | >>> import tempfile |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1681 | >>> real_stdin = sys.stdin |
| 1682 | >>> sys.stdin = _FakeInput([ |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1683 | ... 'print(x)', # print data defined by the example |
Jim Fulton | 356fd19 | 2004-08-09 11:34:47 +0000 | [diff] [blame] | 1684 | ... 'continue', # stop debugging |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1685 | ... '']) |
Jim Fulton | 356fd19 | 2004-08-09 11:34:47 +0000 | [diff] [blame] | 1686 | |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1687 | >>> try: runner.run(test) |
| 1688 | ... finally: sys.stdin = real_stdin |
Jim Fulton | 356fd19 | 2004-08-09 11:34:47 +0000 | [diff] [blame] | 1689 | --Return-- |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 1690 | > <doctest foo[1]>(1)<module>()->None |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1691 | -> import pdb; pdb.set_trace() |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1692 | (Pdb) print(x) |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1693 | 42 |
| 1694 | (Pdb) continue |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1695 | TestResults(failed=0, attempted=2) |
Jim Fulton | 356fd19 | 2004-08-09 11:34:47 +0000 | [diff] [blame] | 1696 | |
| 1697 | You can also put pdb.set_trace in a function called from a test: |
| 1698 | |
| 1699 | >>> def calls_set_trace(): |
| 1700 | ... y=2 |
| 1701 | ... import pdb; pdb.set_trace() |
| 1702 | |
| 1703 | >>> doc = ''' |
| 1704 | ... >>> x=1 |
| 1705 | ... >>> calls_set_trace() |
| 1706 | ... ''' |
Edward Loper | a1ef611 | 2004-08-09 16:14:41 +0000 | [diff] [blame] | 1707 | >>> test = parser.get_doctest(doc, globals(), "foo", "foo.py", 0) |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1708 | >>> real_stdin = sys.stdin |
| 1709 | >>> sys.stdin = _FakeInput([ |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1710 | ... 'print(y)', # print data defined in the function |
Jim Fulton | 356fd19 | 2004-08-09 11:34:47 +0000 | [diff] [blame] | 1711 | ... 'up', # out of function |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1712 | ... 'print(x)', # print data defined by the example |
Jim Fulton | 356fd19 | 2004-08-09 11:34:47 +0000 | [diff] [blame] | 1713 | ... 'continue', # stop debugging |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1714 | ... '']) |
Jim Fulton | 356fd19 | 2004-08-09 11:34:47 +0000 | [diff] [blame] | 1715 | |
Tim Peters | 50c6bdb | 2004-11-08 22:07:37 +0000 | [diff] [blame] | 1716 | >>> try: |
| 1717 | ... runner.run(test) |
| 1718 | ... finally: |
| 1719 | ... sys.stdin = real_stdin |
Jim Fulton | 356fd19 | 2004-08-09 11:34:47 +0000 | [diff] [blame] | 1720 | --Return-- |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1721 | > <doctest test.test_doctest.test_pdb_set_trace[8]>(3)calls_set_trace()->None |
| 1722 | -> import pdb; pdb.set_trace() |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1723 | (Pdb) print(y) |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1724 | 2 |
| 1725 | (Pdb) up |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 1726 | > <doctest foo[1]>(1)<module>() |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1727 | -> calls_set_trace() |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1728 | (Pdb) print(x) |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1729 | 1 |
| 1730 | (Pdb) continue |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1731 | TestResults(failed=0, attempted=2) |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1732 | |
| 1733 | During interactive debugging, source code is shown, even for |
| 1734 | doctest examples: |
| 1735 | |
| 1736 | >>> doc = ''' |
| 1737 | ... >>> def f(x): |
| 1738 | ... ... g(x*2) |
| 1739 | ... >>> def g(x): |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1740 | ... ... print(x+3) |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1741 | ... ... import pdb; pdb.set_trace() |
| 1742 | ... >>> f(3) |
| 1743 | ... ''' |
| 1744 | >>> test = parser.get_doctest(doc, globals(), "foo", "foo.py", 0) |
| 1745 | >>> real_stdin = sys.stdin |
| 1746 | >>> sys.stdin = _FakeInput([ |
| 1747 | ... 'list', # list source from example 2 |
| 1748 | ... 'next', # return from g() |
| 1749 | ... 'list', # list source from example 1 |
| 1750 | ... 'next', # return from f() |
| 1751 | ... 'list', # list source from example 3 |
| 1752 | ... 'continue', # stop debugging |
| 1753 | ... '']) |
| 1754 | >>> try: runner.run(test) |
| 1755 | ... finally: sys.stdin = real_stdin |
| 1756 | ... # doctest: +NORMALIZE_WHITESPACE |
| 1757 | --Return-- |
| 1758 | > <doctest foo[1]>(3)g()->None |
| 1759 | -> import pdb; pdb.set_trace() |
| 1760 | (Pdb) list |
| 1761 | 1 def g(x): |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1762 | 2 print(x+3) |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1763 | 3 -> import pdb; pdb.set_trace() |
| 1764 | [EOF] |
| 1765 | (Pdb) next |
| 1766 | --Return-- |
| 1767 | > <doctest foo[0]>(2)f()->None |
| 1768 | -> g(x*2) |
| 1769 | (Pdb) list |
| 1770 | 1 def f(x): |
| 1771 | 2 -> g(x*2) |
| 1772 | [EOF] |
| 1773 | (Pdb) next |
| 1774 | --Return-- |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 1775 | > <doctest foo[2]>(1)<module>()->None |
Edward Loper | 2de91ba | 2004-08-27 02:07:46 +0000 | [diff] [blame] | 1776 | -> f(3) |
| 1777 | (Pdb) list |
| 1778 | 1 -> f(3) |
| 1779 | [EOF] |
| 1780 | (Pdb) continue |
| 1781 | ********************************************************************** |
| 1782 | File "foo.py", line 7, in foo |
| 1783 | Failed example: |
| 1784 | f(3) |
| 1785 | Expected nothing |
| 1786 | Got: |
| 1787 | 9 |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1788 | TestResults(failed=1, attempted=3) |
Jim Fulton | 356fd19 | 2004-08-09 11:34:47 +0000 | [diff] [blame] | 1789 | """ |
| 1790 | |
Tim Peters | 50c6bdb | 2004-11-08 22:07:37 +0000 | [diff] [blame] | 1791 | def test_pdb_set_trace_nested(): |
| 1792 | """This illustrates more-demanding use of set_trace with nested functions. |
| 1793 | |
| 1794 | >>> class C(object): |
| 1795 | ... def calls_set_trace(self): |
| 1796 | ... y = 1 |
| 1797 | ... import pdb; pdb.set_trace() |
| 1798 | ... self.f1() |
| 1799 | ... y = 2 |
| 1800 | ... def f1(self): |
| 1801 | ... x = 1 |
| 1802 | ... self.f2() |
| 1803 | ... x = 2 |
| 1804 | ... def f2(self): |
| 1805 | ... z = 1 |
| 1806 | ... z = 2 |
| 1807 | |
| 1808 | >>> calls_set_trace = C().calls_set_trace |
| 1809 | |
| 1810 | >>> doc = ''' |
| 1811 | ... >>> a = 1 |
| 1812 | ... >>> calls_set_trace() |
| 1813 | ... ''' |
| 1814 | >>> parser = doctest.DocTestParser() |
| 1815 | >>> runner = doctest.DocTestRunner(verbose=False) |
| 1816 | >>> test = parser.get_doctest(doc, globals(), "foo", "foo.py", 0) |
| 1817 | >>> real_stdin = sys.stdin |
| 1818 | >>> sys.stdin = _FakeInput([ |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1819 | ... 'print(y)', # print data defined in the function |
| 1820 | ... 'step', 'step', 'step', 'step', 'step', 'step', 'print(z)', |
| 1821 | ... 'up', 'print(x)', |
| 1822 | ... 'up', 'print(y)', |
| 1823 | ... 'up', 'print(foo)', |
Tim Peters | 50c6bdb | 2004-11-08 22:07:37 +0000 | [diff] [blame] | 1824 | ... 'continue', # stop debugging |
| 1825 | ... '']) |
| 1826 | |
| 1827 | >>> try: |
| 1828 | ... runner.run(test) |
| 1829 | ... finally: |
| 1830 | ... sys.stdin = real_stdin |
Guido van Rossum | 4a625c3 | 2007-09-08 16:05:25 +0000 | [diff] [blame] | 1831 | ... # doctest: +REPORT_NDIFF |
Tim Peters | 50c6bdb | 2004-11-08 22:07:37 +0000 | [diff] [blame] | 1832 | > <doctest test.test_doctest.test_pdb_set_trace_nested[0]>(5)calls_set_trace() |
| 1833 | -> self.f1() |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1834 | (Pdb) print(y) |
Tim Peters | 50c6bdb | 2004-11-08 22:07:37 +0000 | [diff] [blame] | 1835 | 1 |
| 1836 | (Pdb) step |
| 1837 | --Call-- |
| 1838 | > <doctest test.test_doctest.test_pdb_set_trace_nested[0]>(7)f1() |
| 1839 | -> def f1(self): |
| 1840 | (Pdb) step |
| 1841 | > <doctest test.test_doctest.test_pdb_set_trace_nested[0]>(8)f1() |
| 1842 | -> x = 1 |
| 1843 | (Pdb) step |
| 1844 | > <doctest test.test_doctest.test_pdb_set_trace_nested[0]>(9)f1() |
| 1845 | -> self.f2() |
| 1846 | (Pdb) step |
| 1847 | --Call-- |
| 1848 | > <doctest test.test_doctest.test_pdb_set_trace_nested[0]>(11)f2() |
| 1849 | -> def f2(self): |
| 1850 | (Pdb) step |
| 1851 | > <doctest test.test_doctest.test_pdb_set_trace_nested[0]>(12)f2() |
| 1852 | -> z = 1 |
| 1853 | (Pdb) step |
| 1854 | > <doctest test.test_doctest.test_pdb_set_trace_nested[0]>(13)f2() |
| 1855 | -> z = 2 |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1856 | (Pdb) print(z) |
Tim Peters | 50c6bdb | 2004-11-08 22:07:37 +0000 | [diff] [blame] | 1857 | 1 |
| 1858 | (Pdb) up |
| 1859 | > <doctest test.test_doctest.test_pdb_set_trace_nested[0]>(9)f1() |
| 1860 | -> self.f2() |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1861 | (Pdb) print(x) |
Tim Peters | 50c6bdb | 2004-11-08 22:07:37 +0000 | [diff] [blame] | 1862 | 1 |
| 1863 | (Pdb) up |
| 1864 | > <doctest test.test_doctest.test_pdb_set_trace_nested[0]>(5)calls_set_trace() |
| 1865 | -> self.f1() |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1866 | (Pdb) print(y) |
Tim Peters | 50c6bdb | 2004-11-08 22:07:37 +0000 | [diff] [blame] | 1867 | 1 |
| 1868 | (Pdb) up |
Jeremy Hylton | 3e0055f | 2005-10-20 19:59:25 +0000 | [diff] [blame] | 1869 | > <doctest foo[1]>(1)<module>() |
Tim Peters | 50c6bdb | 2004-11-08 22:07:37 +0000 | [diff] [blame] | 1870 | -> calls_set_trace() |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 1871 | (Pdb) print(foo) |
Guido van Rossum | fd4a7de | 2007-09-05 03:26:38 +0000 | [diff] [blame] | 1872 | *** NameError: NameError("name 'foo' is not defined",) |
Tim Peters | 50c6bdb | 2004-11-08 22:07:37 +0000 | [diff] [blame] | 1873 | (Pdb) continue |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1874 | TestResults(failed=0, attempted=2) |
Tim Peters | 50c6bdb | 2004-11-08 22:07:37 +0000 | [diff] [blame] | 1875 | """ |
| 1876 | |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1877 | def test_DocTestSuite(): |
Tim Peters | 1e277ee | 2004-08-07 05:37:52 +0000 | [diff] [blame] | 1878 | """DocTestSuite creates a unittest test suite from a doctest. |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1879 | |
| 1880 | We create a Suite by providing a module. A module can be provided |
| 1881 | by passing a module object: |
| 1882 | |
| 1883 | >>> import unittest |
| 1884 | >>> import test.sample_doctest |
| 1885 | >>> suite = doctest.DocTestSuite(test.sample_doctest) |
| 1886 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1887 | <unittest.result.TestResult run=9 errors=0 failures=4> |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1888 | |
| 1889 | We can also supply the module by name: |
| 1890 | |
| 1891 | >>> suite = doctest.DocTestSuite('test.sample_doctest') |
| 1892 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1893 | <unittest.result.TestResult run=9 errors=0 failures=4> |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1894 | |
| 1895 | We can use the current module: |
| 1896 | |
| 1897 | >>> suite = test.sample_doctest.test_suite() |
| 1898 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1899 | <unittest.result.TestResult run=9 errors=0 failures=4> |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1900 | |
| 1901 | We can supply global variables. If we pass globs, they will be |
| 1902 | used instead of the module globals. Here we'll pass an empty |
| 1903 | globals, triggering an extra error: |
| 1904 | |
| 1905 | >>> suite = doctest.DocTestSuite('test.sample_doctest', globs={}) |
| 1906 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1907 | <unittest.result.TestResult run=9 errors=0 failures=5> |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1908 | |
| 1909 | Alternatively, we can provide extra globals. Here we'll make an |
| 1910 | error go away by providing an extra global variable: |
| 1911 | |
| 1912 | >>> suite = doctest.DocTestSuite('test.sample_doctest', |
| 1913 | ... extraglobs={'y': 1}) |
| 1914 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1915 | <unittest.result.TestResult run=9 errors=0 failures=3> |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1916 | |
| 1917 | You can pass option flags. Here we'll cause an extra error |
| 1918 | by disabling the blank-line feature: |
| 1919 | |
| 1920 | >>> suite = doctest.DocTestSuite('test.sample_doctest', |
Tim Peters | 1e277ee | 2004-08-07 05:37:52 +0000 | [diff] [blame] | 1921 | ... optionflags=doctest.DONT_ACCEPT_BLANKLINE) |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1922 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1923 | <unittest.result.TestResult run=9 errors=0 failures=5> |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1924 | |
Tim Peters | 1e277ee | 2004-08-07 05:37:52 +0000 | [diff] [blame] | 1925 | You can supply setUp and tearDown functions: |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1926 | |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 1927 | >>> def setUp(t): |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1928 | ... import test.test_doctest |
| 1929 | ... test.test_doctest.sillySetup = True |
| 1930 | |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 1931 | >>> def tearDown(t): |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1932 | ... import test.test_doctest |
| 1933 | ... del test.test_doctest.sillySetup |
| 1934 | |
| 1935 | Here, we installed a silly variable that the test expects: |
| 1936 | |
| 1937 | >>> suite = doctest.DocTestSuite('test.sample_doctest', |
| 1938 | ... setUp=setUp, tearDown=tearDown) |
| 1939 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1940 | <unittest.result.TestResult run=9 errors=0 failures=3> |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1941 | |
| 1942 | But the tearDown restores sanity: |
| 1943 | |
| 1944 | >>> import test.test_doctest |
| 1945 | >>> test.test_doctest.sillySetup |
| 1946 | Traceback (most recent call last): |
| 1947 | ... |
| 1948 | AttributeError: 'module' object has no attribute 'sillySetup' |
| 1949 | |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 1950 | The setUp and tearDown funtions are passed test objects. Here |
| 1951 | we'll use the setUp function to supply the missing variable y: |
| 1952 | |
| 1953 | >>> def setUp(test): |
| 1954 | ... test.globs['y'] = 1 |
| 1955 | |
| 1956 | >>> suite = doctest.DocTestSuite('test.sample_doctest', setUp=setUp) |
| 1957 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1958 | <unittest.result.TestResult run=9 errors=0 failures=3> |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 1959 | |
| 1960 | Here, we didn't need to use a tearDown function because we |
| 1961 | modified the test globals, which are a copy of the |
| 1962 | sample_doctest module dictionary. The test globals are |
| 1963 | automatically cleared for us after a test. |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1964 | """ |
| 1965 | |
| 1966 | def test_DocFileSuite(): |
| 1967 | """We can test tests found in text files using a DocFileSuite. |
| 1968 | |
| 1969 | We create a suite by providing the names of one or more text |
| 1970 | files that include examples: |
| 1971 | |
| 1972 | >>> import unittest |
| 1973 | >>> suite = doctest.DocFileSuite('test_doctest.txt', |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 1974 | ... 'test_doctest2.txt', |
| 1975 | ... 'test_doctest4.txt') |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1976 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1977 | <unittest.result.TestResult run=3 errors=0 failures=2> |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1978 | |
| 1979 | The test files are looked for in the directory containing the |
| 1980 | calling module. A package keyword argument can be provided to |
| 1981 | specify a different relative location. |
| 1982 | |
| 1983 | >>> import unittest |
| 1984 | >>> suite = doctest.DocFileSuite('test_doctest.txt', |
| 1985 | ... 'test_doctest2.txt', |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 1986 | ... 'test_doctest4.txt', |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1987 | ... package='test') |
| 1988 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1989 | <unittest.result.TestResult run=3 errors=0 failures=2> |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 1990 | |
Guido van Rossum | cd4d452 | 2007-11-22 00:30:02 +0000 | [diff] [blame] | 1991 | Support for using a package's __loader__.get_data() is also |
| 1992 | provided. |
| 1993 | |
| 1994 | >>> import unittest, pkgutil, test |
Guido van Rossum | 0d3fb8a | 2007-11-26 23:23:18 +0000 | [diff] [blame] | 1995 | >>> added_loader = False |
Guido van Rossum | cd4d452 | 2007-11-22 00:30:02 +0000 | [diff] [blame] | 1996 | >>> if not hasattr(test, '__loader__'): |
| 1997 | ... test.__loader__ = pkgutil.get_loader(test) |
| 1998 | ... added_loader = True |
| 1999 | >>> try: |
| 2000 | ... suite = doctest.DocFileSuite('test_doctest.txt', |
| 2001 | ... 'test_doctest2.txt', |
| 2002 | ... 'test_doctest4.txt', |
| 2003 | ... package='test') |
| 2004 | ... suite.run(unittest.TestResult()) |
| 2005 | ... finally: |
| 2006 | ... if added_loader: |
| 2007 | ... del test.__loader__ |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 2008 | <unittest.result.TestResult run=3 errors=0 failures=2> |
Guido van Rossum | cd4d452 | 2007-11-22 00:30:02 +0000 | [diff] [blame] | 2009 | |
Edward Loper | 0273f5b | 2004-09-18 20:27:04 +0000 | [diff] [blame] | 2010 | '/' should be used as a path separator. It will be converted |
| 2011 | to a native separator at run time: |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 2012 | |
| 2013 | >>> suite = doctest.DocFileSuite('../test/test_doctest.txt') |
| 2014 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 2015 | <unittest.result.TestResult run=1 errors=0 failures=1> |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 2016 | |
Edward Loper | 0273f5b | 2004-09-18 20:27:04 +0000 | [diff] [blame] | 2017 | If DocFileSuite is used from an interactive session, then files |
| 2018 | are resolved relative to the directory of sys.argv[0]: |
| 2019 | |
Christian Heimes | 45f9af3 | 2007-11-27 21:50:00 +0000 | [diff] [blame] | 2020 | >>> import types, os.path, test.test_doctest |
Edward Loper | 0273f5b | 2004-09-18 20:27:04 +0000 | [diff] [blame] | 2021 | >>> save_argv = sys.argv |
| 2022 | >>> sys.argv = [test.test_doctest.__file__] |
| 2023 | >>> suite = doctest.DocFileSuite('test_doctest.txt', |
Christian Heimes | 45f9af3 | 2007-11-27 21:50:00 +0000 | [diff] [blame] | 2024 | ... package=types.ModuleType('__main__')) |
Edward Loper | 0273f5b | 2004-09-18 20:27:04 +0000 | [diff] [blame] | 2025 | >>> sys.argv = save_argv |
| 2026 | |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2027 | By setting `module_relative=False`, os-specific paths may be |
| 2028 | used (including absolute paths and paths relative to the |
| 2029 | working directory): |
Edward Loper | 0273f5b | 2004-09-18 20:27:04 +0000 | [diff] [blame] | 2030 | |
| 2031 | >>> # Get the absolute path of the test package. |
| 2032 | >>> test_doctest_path = os.path.abspath(test.test_doctest.__file__) |
| 2033 | >>> test_pkg_path = os.path.split(test_doctest_path)[0] |
| 2034 | |
| 2035 | >>> # Use it to find the absolute path of test_doctest.txt. |
| 2036 | >>> test_file = os.path.join(test_pkg_path, 'test_doctest.txt') |
| 2037 | |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2038 | >>> suite = doctest.DocFileSuite(test_file, module_relative=False) |
Edward Loper | 0273f5b | 2004-09-18 20:27:04 +0000 | [diff] [blame] | 2039 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 2040 | <unittest.result.TestResult run=1 errors=0 failures=1> |
Edward Loper | 0273f5b | 2004-09-18 20:27:04 +0000 | [diff] [blame] | 2041 | |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2042 | It is an error to specify `package` when `module_relative=False`: |
| 2043 | |
| 2044 | >>> suite = doctest.DocFileSuite(test_file, module_relative=False, |
| 2045 | ... package='test') |
| 2046 | Traceback (most recent call last): |
| 2047 | ValueError: Package may only be specified for module-relative paths. |
| 2048 | |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 2049 | You can specify initial global variables: |
| 2050 | |
| 2051 | >>> suite = doctest.DocFileSuite('test_doctest.txt', |
| 2052 | ... 'test_doctest2.txt', |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 2053 | ... 'test_doctest4.txt', |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 2054 | ... globs={'favorite_color': 'blue'}) |
| 2055 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 2056 | <unittest.result.TestResult run=3 errors=0 failures=1> |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 2057 | |
| 2058 | In this case, we supplied a missing favorite color. You can |
| 2059 | provide doctest options: |
| 2060 | |
| 2061 | >>> suite = doctest.DocFileSuite('test_doctest.txt', |
| 2062 | ... 'test_doctest2.txt', |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 2063 | ... 'test_doctest4.txt', |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 2064 | ... optionflags=doctest.DONT_ACCEPT_BLANKLINE, |
| 2065 | ... globs={'favorite_color': 'blue'}) |
| 2066 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 2067 | <unittest.result.TestResult run=3 errors=0 failures=2> |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 2068 | |
| 2069 | And, you can provide setUp and tearDown functions: |
| 2070 | |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 2071 | >>> def setUp(t): |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 2072 | ... import test.test_doctest |
| 2073 | ... test.test_doctest.sillySetup = True |
| 2074 | |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 2075 | >>> def tearDown(t): |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 2076 | ... import test.test_doctest |
| 2077 | ... del test.test_doctest.sillySetup |
| 2078 | |
| 2079 | Here, we installed a silly variable that the test expects: |
| 2080 | |
| 2081 | >>> suite = doctest.DocFileSuite('test_doctest.txt', |
| 2082 | ... 'test_doctest2.txt', |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 2083 | ... 'test_doctest4.txt', |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 2084 | ... setUp=setUp, tearDown=tearDown) |
| 2085 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 2086 | <unittest.result.TestResult run=3 errors=0 failures=1> |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 2087 | |
| 2088 | But the tearDown restores sanity: |
| 2089 | |
| 2090 | >>> import test.test_doctest |
| 2091 | >>> test.test_doctest.sillySetup |
| 2092 | Traceback (most recent call last): |
| 2093 | ... |
| 2094 | AttributeError: 'module' object has no attribute 'sillySetup' |
| 2095 | |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 2096 | The setUp and tearDown funtions are passed test objects. |
| 2097 | Here, we'll use a setUp function to set the favorite color in |
| 2098 | test_doctest.txt: |
| 2099 | |
| 2100 | >>> def setUp(test): |
| 2101 | ... test.globs['favorite_color'] = 'blue' |
| 2102 | |
| 2103 | >>> suite = doctest.DocFileSuite('test_doctest.txt', setUp=setUp) |
| 2104 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 2105 | <unittest.result.TestResult run=1 errors=0 failures=0> |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 2106 | |
| 2107 | Here, we didn't need to use a tearDown function because we |
| 2108 | modified the test globals. The test globals are |
| 2109 | automatically cleared for us after a test. |
Tim Peters | df7a208 | 2004-08-29 00:38:17 +0000 | [diff] [blame] | 2110 | |
Fred Drake | 7c404a4 | 2004-12-21 23:46:34 +0000 | [diff] [blame] | 2111 | Tests in a file run using `DocFileSuite` can also access the |
| 2112 | `__file__` global, which is set to the name of the file |
| 2113 | containing the tests: |
| 2114 | |
| 2115 | >>> suite = doctest.DocFileSuite('test_doctest3.txt') |
| 2116 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 2117 | <unittest.result.TestResult run=1 errors=0 failures=0> |
Fred Drake | 7c404a4 | 2004-12-21 23:46:34 +0000 | [diff] [blame] | 2118 | |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 2119 | If the tests contain non-ASCII characters, we have to specify which |
| 2120 | encoding the file is encoded with. We do so by using the `encoding` |
| 2121 | parameter: |
| 2122 | |
| 2123 | >>> suite = doctest.DocFileSuite('test_doctest.txt', |
| 2124 | ... 'test_doctest2.txt', |
| 2125 | ... 'test_doctest4.txt', |
| 2126 | ... encoding='utf-8') |
| 2127 | >>> suite.run(unittest.TestResult()) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 2128 | <unittest.result.TestResult run=3 errors=0 failures=2> |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 2129 | |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 2130 | """ |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 2131 | |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 2132 | def test_trailing_space_in_test(): |
| 2133 | """ |
Tim Peters | a7def72 | 2004-08-23 22:13:22 +0000 | [diff] [blame] | 2134 | Trailing spaces in expected output are significant: |
Tim Peters | c6cbab0 | 2004-08-22 19:43:28 +0000 | [diff] [blame] | 2135 | |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 2136 | >>> x, y = 'foo', '' |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 2137 | >>> print(x, y) |
Jim Fulton | 07a349c | 2004-08-22 14:10:00 +0000 | [diff] [blame] | 2138 | foo \n |
| 2139 | """ |
Tim Peters | 19397e5 | 2004-08-06 22:02:59 +0000 | [diff] [blame] | 2140 | |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 2141 | |
| 2142 | def test_unittest_reportflags(): |
| 2143 | """Default unittest reporting flags can be set to control reporting |
| 2144 | |
| 2145 | Here, we'll set the REPORT_ONLY_FIRST_FAILURE option so we see |
| 2146 | only the first failure of each test. First, we'll look at the |
| 2147 | output without the flag. The file test_doctest.txt file has two |
| 2148 | tests. They both fail if blank lines are disabled: |
| 2149 | |
| 2150 | >>> suite = doctest.DocFileSuite('test_doctest.txt', |
| 2151 | ... optionflags=doctest.DONT_ACCEPT_BLANKLINE) |
| 2152 | >>> import unittest |
| 2153 | >>> result = suite.run(unittest.TestResult()) |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 2154 | >>> print(result.failures[0][1]) # doctest: +ELLIPSIS |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 2155 | Traceback ... |
| 2156 | Failed example: |
| 2157 | favorite_color |
| 2158 | ... |
| 2159 | Failed example: |
| 2160 | if 1: |
| 2161 | ... |
| 2162 | |
| 2163 | Note that we see both failures displayed. |
| 2164 | |
| 2165 | >>> old = doctest.set_unittest_reportflags( |
| 2166 | ... doctest.REPORT_ONLY_FIRST_FAILURE) |
| 2167 | |
| 2168 | Now, when we run the test: |
| 2169 | |
| 2170 | >>> result = suite.run(unittest.TestResult()) |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 2171 | >>> print(result.failures[0][1]) # doctest: +ELLIPSIS |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 2172 | Traceback ... |
| 2173 | Failed example: |
| 2174 | favorite_color |
| 2175 | Exception raised: |
| 2176 | ... |
| 2177 | NameError: name 'favorite_color' is not defined |
| 2178 | <BLANKLINE> |
| 2179 | <BLANKLINE> |
Tim Peters | df7a208 | 2004-08-29 00:38:17 +0000 | [diff] [blame] | 2180 | |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 2181 | We get only the first failure. |
| 2182 | |
| 2183 | If we give any reporting options when we set up the tests, |
| 2184 | however: |
| 2185 | |
| 2186 | >>> suite = doctest.DocFileSuite('test_doctest.txt', |
| 2187 | ... optionflags=doctest.DONT_ACCEPT_BLANKLINE | doctest.REPORT_NDIFF) |
| 2188 | |
| 2189 | Then the default eporting options are ignored: |
| 2190 | |
| 2191 | >>> result = suite.run(unittest.TestResult()) |
Guido van Rossum | 7131f84 | 2007-02-09 20:13:25 +0000 | [diff] [blame] | 2192 | >>> print(result.failures[0][1]) # doctest: +ELLIPSIS |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 2193 | Traceback ... |
| 2194 | Failed example: |
| 2195 | favorite_color |
| 2196 | ... |
| 2197 | Failed example: |
| 2198 | if 1: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 2199 | print('a') |
| 2200 | print() |
| 2201 | print('b') |
Jim Fulton | f54bad4 | 2004-08-28 14:57:56 +0000 | [diff] [blame] | 2202 | Differences (ndiff with -expected +actual): |
| 2203 | a |
| 2204 | - <BLANKLINE> |
| 2205 | + |
| 2206 | b |
| 2207 | <BLANKLINE> |
| 2208 | <BLANKLINE> |
| 2209 | |
| 2210 | |
| 2211 | Test runners can restore the formatting flags after they run: |
| 2212 | |
| 2213 | >>> ignored = doctest.set_unittest_reportflags(old) |
| 2214 | |
| 2215 | """ |
| 2216 | |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2217 | def test_testfile(): r""" |
| 2218 | Tests for the `testfile()` function. This function runs all the |
| 2219 | doctest examples in a given file. In its simple invokation, it is |
| 2220 | called with the name of a file, which is taken to be relative to the |
| 2221 | calling module. The return value is (#failures, #tests). |
| 2222 | |
Florent Xicluna | 5925085 | 2010-02-27 14:21:57 +0000 | [diff] [blame] | 2223 | We don't want `-v` in sys.argv for these tests. |
| 2224 | |
| 2225 | >>> save_argv = sys.argv |
| 2226 | >>> if '-v' in sys.argv: |
| 2227 | ... sys.argv = [arg for arg in save_argv if arg != '-v'] |
| 2228 | |
| 2229 | |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2230 | >>> doctest.testfile('test_doctest.txt') # doctest: +ELLIPSIS |
| 2231 | ********************************************************************** |
| 2232 | File "...", line 6, in test_doctest.txt |
| 2233 | Failed example: |
| 2234 | favorite_color |
| 2235 | Exception raised: |
| 2236 | ... |
| 2237 | NameError: name 'favorite_color' is not defined |
| 2238 | ********************************************************************** |
| 2239 | 1 items had failures: |
| 2240 | 1 of 2 in test_doctest.txt |
| 2241 | ***Test Failed*** 1 failures. |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 2242 | TestResults(failed=1, attempted=2) |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2243 | >>> doctest.master = None # Reset master. |
| 2244 | |
| 2245 | (Note: we'll be clearing doctest.master after each call to |
| 2246 | `doctest.testfile`, to supress warnings about multiple tests with the |
| 2247 | same name.) |
| 2248 | |
| 2249 | Globals may be specified with the `globs` and `extraglobs` parameters: |
| 2250 | |
| 2251 | >>> globs = {'favorite_color': 'blue'} |
| 2252 | >>> doctest.testfile('test_doctest.txt', globs=globs) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 2253 | TestResults(failed=0, attempted=2) |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2254 | >>> doctest.master = None # Reset master. |
| 2255 | |
| 2256 | >>> extraglobs = {'favorite_color': 'red'} |
| 2257 | >>> doctest.testfile('test_doctest.txt', globs=globs, |
| 2258 | ... extraglobs=extraglobs) # doctest: +ELLIPSIS |
| 2259 | ********************************************************************** |
| 2260 | File "...", line 6, in test_doctest.txt |
| 2261 | Failed example: |
| 2262 | favorite_color |
| 2263 | Expected: |
| 2264 | 'blue' |
| 2265 | Got: |
| 2266 | 'red' |
| 2267 | ********************************************************************** |
| 2268 | 1 items had failures: |
| 2269 | 1 of 2 in test_doctest.txt |
| 2270 | ***Test Failed*** 1 failures. |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 2271 | TestResults(failed=1, attempted=2) |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2272 | >>> doctest.master = None # Reset master. |
| 2273 | |
| 2274 | The file may be made relative to a given module or package, using the |
| 2275 | optional `module_relative` parameter: |
| 2276 | |
| 2277 | >>> doctest.testfile('test_doctest.txt', globs=globs, |
| 2278 | ... module_relative='test') |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 2279 | TestResults(failed=0, attempted=2) |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2280 | >>> doctest.master = None # Reset master. |
| 2281 | |
| 2282 | Verbosity can be increased with the optional `verbose` paremter: |
| 2283 | |
| 2284 | >>> doctest.testfile('test_doctest.txt', globs=globs, verbose=True) |
| 2285 | Trying: |
| 2286 | favorite_color |
| 2287 | Expecting: |
| 2288 | 'blue' |
| 2289 | ok |
| 2290 | Trying: |
| 2291 | if 1: |
Guido van Rossum | bdc36e4 | 2007-02-09 22:43:47 +0000 | [diff] [blame] | 2292 | print('a') |
| 2293 | print() |
| 2294 | print('b') |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2295 | Expecting: |
| 2296 | a |
| 2297 | <BLANKLINE> |
| 2298 | b |
| 2299 | ok |
| 2300 | 1 items passed all tests: |
| 2301 | 2 tests in test_doctest.txt |
| 2302 | 2 tests in 1 items. |
| 2303 | 2 passed and 0 failed. |
| 2304 | Test passed. |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 2305 | TestResults(failed=0, attempted=2) |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2306 | >>> doctest.master = None # Reset master. |
| 2307 | |
| 2308 | The name of the test may be specified with the optional `name` |
| 2309 | parameter: |
| 2310 | |
| 2311 | >>> doctest.testfile('test_doctest.txt', name='newname') |
| 2312 | ... # doctest: +ELLIPSIS |
| 2313 | ********************************************************************** |
| 2314 | File "...", line 6, in newname |
| 2315 | ... |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 2316 | TestResults(failed=1, attempted=2) |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2317 | >>> doctest.master = None # Reset master. |
| 2318 | |
| 2319 | The summary report may be supressed with the optional `report` |
| 2320 | parameter: |
| 2321 | |
| 2322 | >>> doctest.testfile('test_doctest.txt', report=False) |
| 2323 | ... # doctest: +ELLIPSIS |
| 2324 | ********************************************************************** |
| 2325 | File "...", line 6, in test_doctest.txt |
| 2326 | Failed example: |
| 2327 | favorite_color |
| 2328 | Exception raised: |
| 2329 | ... |
| 2330 | NameError: name 'favorite_color' is not defined |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 2331 | TestResults(failed=1, attempted=2) |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2332 | >>> doctest.master = None # Reset master. |
| 2333 | |
| 2334 | The optional keyword argument `raise_on_error` can be used to raise an |
| 2335 | exception on the first error (which may be useful for postmortem |
| 2336 | debugging): |
| 2337 | |
| 2338 | >>> doctest.testfile('test_doctest.txt', raise_on_error=True) |
| 2339 | ... # doctest: +ELLIPSIS |
| 2340 | Traceback (most recent call last): |
Guido van Rossum | 6a2a2a0 | 2006-08-26 20:37:44 +0000 | [diff] [blame] | 2341 | doctest.UnexpectedException: ... |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2342 | >>> doctest.master = None # Reset master. |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 2343 | |
| 2344 | If the tests contain non-ASCII characters, the tests might fail, since |
| 2345 | it's unknown which encoding is used. The encoding can be specified |
| 2346 | using the optional keyword argument `encoding`: |
| 2347 | |
Martin v. Löwis | b1a9f27 | 2007-07-20 07:13:39 +0000 | [diff] [blame] | 2348 | >>> doctest.testfile('test_doctest4.txt', encoding='latin-1') # doctest: +ELLIPSIS |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 2349 | ********************************************************************** |
| 2350 | File "...", line 7, in test_doctest4.txt |
| 2351 | Failed example: |
Martin v. Löwis | b1a9f27 | 2007-07-20 07:13:39 +0000 | [diff] [blame] | 2352 | '...' |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 2353 | Expected: |
Martin v. Löwis | b1a9f27 | 2007-07-20 07:13:39 +0000 | [diff] [blame] | 2354 | 'f\xf6\xf6' |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 2355 | Got: |
Martin v. Löwis | b1a9f27 | 2007-07-20 07:13:39 +0000 | [diff] [blame] | 2356 | 'f\xc3\xb6\xc3\xb6' |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 2357 | ********************************************************************** |
| 2358 | ... |
| 2359 | ********************************************************************** |
| 2360 | 1 items had failures: |
Martin v. Löwis | b1a9f27 | 2007-07-20 07:13:39 +0000 | [diff] [blame] | 2361 | 2 of 2 in test_doctest4.txt |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 2362 | ***Test Failed*** 2 failures. |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 2363 | TestResults(failed=2, attempted=2) |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 2364 | >>> doctest.master = None # Reset master. |
| 2365 | |
| 2366 | >>> doctest.testfile('test_doctest4.txt', encoding='utf-8') |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 2367 | TestResults(failed=0, attempted=2) |
Thomas Wouters | 4d70c3d | 2006-06-08 14:42:34 +0000 | [diff] [blame] | 2368 | >>> doctest.master = None # Reset master. |
Florent Xicluna | 5925085 | 2010-02-27 14:21:57 +0000 | [diff] [blame] | 2369 | |
| 2370 | Test the verbose output: |
| 2371 | |
| 2372 | >>> doctest.testfile('test_doctest4.txt', encoding='utf-8', verbose=True) |
| 2373 | Trying: |
| 2374 | 'föö' |
| 2375 | Expecting: |
| 2376 | 'f\xf6\xf6' |
| 2377 | ok |
| 2378 | Trying: |
| 2379 | 'bąr' |
| 2380 | Expecting: |
| 2381 | 'b\u0105r' |
| 2382 | ok |
| 2383 | 1 items passed all tests: |
| 2384 | 2 tests in test_doctest4.txt |
| 2385 | 2 tests in 1 items. |
| 2386 | 2 passed and 0 failed. |
| 2387 | Test passed. |
| 2388 | TestResults(failed=0, attempted=2) |
| 2389 | >>> doctest.master = None # Reset master. |
| 2390 | >>> sys.argv = save_argv |
Edward Loper | 052d0cd | 2004-09-19 17:19:33 +0000 | [diff] [blame] | 2391 | """ |
| 2392 | |
R. David Murray | 58641de | 2009-06-12 15:33:19 +0000 | [diff] [blame] | 2393 | def test_testmod(): r""" |
| 2394 | Tests for the testmod function. More might be useful, but for now we're just |
| 2395 | testing the case raised by Issue 6195, where trying to doctest a C module would |
| 2396 | fail with a UnicodeDecodeError because doctest tried to read the "source" lines |
| 2397 | out of the binary module. |
| 2398 | |
| 2399 | >>> import unicodedata |
Florent Xicluna | 5925085 | 2010-02-27 14:21:57 +0000 | [diff] [blame] | 2400 | >>> doctest.testmod(unicodedata, verbose=False) |
R. David Murray | 58641de | 2009-06-12 15:33:19 +0000 | [diff] [blame] | 2401 | TestResults(failed=0, attempted=0) |
| 2402 | """ |
| 2403 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 2404 | ###################################################################### |
| 2405 | ## Main |
| 2406 | ###################################################################### |
| 2407 | |
| 2408 | def test_main(): |
| 2409 | # Check the doctest cases in doctest itself: |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 2410 | support.run_doctest(doctest, verbosity=True) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 2411 | # Check the doctest cases defined here: |
| 2412 | from test import test_doctest |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 2413 | support.run_doctest(test_doctest, verbosity=True) |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 2414 | |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 2415 | import sys, re, io |
| 2416 | |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 2417 | def test_coverage(coverdir): |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 2418 | trace = support.import_module('trace') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 2419 | tracer = trace.Trace(ignoredirs=[sys.prefix, sys.exec_prefix,], |
| 2420 | trace=0, count=1) |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 2421 | tracer.run('test_main()') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 2422 | r = tracer.results() |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 2423 | print('Writing coverage results...') |
Tim Peters | 8485b56 | 2004-08-04 18:46:34 +0000 | [diff] [blame] | 2424 | r.write_results(show_missing=True, summary=True, |
| 2425 | coverdir=coverdir) |
| 2426 | |
| 2427 | if __name__ == '__main__': |
| 2428 | if '-c' in sys.argv: |
| 2429 | test_coverage('/tmp/doctest.cover') |
| 2430 | else: |
| 2431 | test_main() |