/
test_formatting.py
398 lines (346 loc) · 13.1 KB
/
test_formatting.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
import sys
from typing import NoReturn
import pytest
from _pytest.capture import CaptureFixture
from _pytest.fixtures import SubRequest
from _pytest.monkeypatch import MonkeyPatch
from exceptiongroup import ExceptionGroup
def raise_excgroup() -> NoReturn:
exceptions = []
try:
raise ValueError("foo")
except ValueError as exc:
exceptions.append(exc)
try:
raise RuntimeError("bar")
except RuntimeError as exc:
exc.__notes__ = ["Note from bar handler"]
exceptions.append(exc)
exc = ExceptionGroup("test message", exceptions)
exc.add_note("Displays notes attached to the group too")
raise exc
@pytest.fixture(
params=[
pytest.param(True, id="patched"),
pytest.param(
False,
id="unpatched",
marks=[
pytest.mark.skipif(
sys.version_info >= (3, 11),
reason="No patching is done on Python >= 3.11",
)
],
),
],
)
def patched(request: SubRequest) -> bool:
return request.param
@pytest.fixture(
params=[pytest.param(False, id="newstyle"), pytest.param(True, id="oldstyle")]
)
def old_argstyle(request: SubRequest) -> bool:
return request.param
def test_exceptionhook(capsys: CaptureFixture) -> None:
try:
raise_excgroup()
except ExceptionGroup as exc:
sys.excepthook(type(exc), exc, exc.__traceback__)
local_lineno = test_exceptionhook.__code__.co_firstlineno
lineno = raise_excgroup.__code__.co_firstlineno
module_prefix = "" if sys.version_info >= (3, 11) else "exceptiongroup."
output = capsys.readouterr().err
assert output == (
f"""\
+ Exception Group Traceback (most recent call last):
| File "{__file__}", line {local_lineno + 2}, in test_exceptionhook
| raise_excgroup()
| File "{__file__}", line {lineno + 15}, in raise_excgroup
| raise exc
| {module_prefix}ExceptionGroup: test message (2 sub-exceptions)
| Displays notes attached to the group too
+-+---------------- 1 ----------------
| Traceback (most recent call last):
| File "{__file__}", line {lineno + 3}, in raise_excgroup
| raise ValueError("foo")
| ValueError: foo
+---------------- 2 ----------------
| Traceback (most recent call last):
| File "{__file__}", line {lineno + 8}, in raise_excgroup
| raise RuntimeError("bar")
| RuntimeError: bar
| Note from bar handler
+------------------------------------
"""
)
def test_exceptiongroup_as_cause(capsys: CaptureFixture) -> None:
try:
raise Exception() from ExceptionGroup("", (Exception(),))
except Exception as exc:
sys.excepthook(type(exc), exc, exc.__traceback__)
lineno = test_exceptiongroup_as_cause.__code__.co_firstlineno
module_prefix = "" if sys.version_info >= (3, 11) else "exceptiongroup."
output = capsys.readouterr().err
assert output == (
f"""\
| {module_prefix}ExceptionGroup: (1 sub-exception)
+-+---------------- 1 ----------------
| Exception
+------------------------------------
The above exception was the direct cause of the following exception:
Traceback (most recent call last):
File "{__file__}", line {lineno + 2}, in test_exceptiongroup_as_cause
raise Exception() from ExceptionGroup("", (Exception(),))
Exception
"""
)
def test_exceptiongroup_loop(capsys: CaptureFixture) -> None:
e0 = Exception("e0")
eg0 = ExceptionGroup("eg0", (e0,))
eg1 = ExceptionGroup("eg1", (eg0,))
try:
raise eg0 from eg1
except ExceptionGroup as exc:
sys.excepthook(type(exc), exc, exc.__traceback__)
lineno = test_exceptiongroup_loop.__code__.co_firstlineno + 6
module_prefix = "" if sys.version_info >= (3, 11) else "exceptiongroup."
output = capsys.readouterr().err
assert output == (
f"""\
| {module_prefix}ExceptionGroup: eg1 (1 sub-exception)
+-+---------------- 1 ----------------
| Exception Group Traceback (most recent call last):
| File "{__file__}", line {lineno}, in test_exceptiongroup_loop
| raise eg0 from eg1
| {module_prefix}ExceptionGroup: eg0 (1 sub-exception)
+-+---------------- 1 ----------------
| Exception: e0
+------------------------------------
The above exception was the direct cause of the following exception:
+ Exception Group Traceback (most recent call last):
| File "{__file__}", line {lineno}, in test_exceptiongroup_loop
| raise eg0 from eg1
| {module_prefix}ExceptionGroup: eg0 (1 sub-exception)
+-+---------------- 1 ----------------
| Exception: e0
+------------------------------------
"""
)
def test_exceptionhook_format_exception_only(capsys: CaptureFixture) -> None:
try:
raise_excgroup()
except ExceptionGroup as exc:
sys.excepthook(type(exc), exc, exc.__traceback__)
local_lineno = test_exceptionhook_format_exception_only.__code__.co_firstlineno
lineno = raise_excgroup.__code__.co_firstlineno
module_prefix = "" if sys.version_info >= (3, 11) else "exceptiongroup."
output = capsys.readouterr().err
assert output == (
f"""\
+ Exception Group Traceback (most recent call last):
| File "{__file__}", line {local_lineno + 2}, in \
test_exceptionhook_format_exception_only
| raise_excgroup()
| File "{__file__}", line {lineno + 15}, in raise_excgroup
| raise exc
| {module_prefix}ExceptionGroup: test message (2 sub-exceptions)
| Displays notes attached to the group too
+-+---------------- 1 ----------------
| Traceback (most recent call last):
| File "{__file__}", line {lineno + 3}, in raise_excgroup
| raise ValueError("foo")
| ValueError: foo
+---------------- 2 ----------------
| Traceback (most recent call last):
| File "{__file__}", line {lineno + 8}, in raise_excgroup
| raise RuntimeError("bar")
| RuntimeError: bar
| Note from bar handler
+------------------------------------
"""
)
def test_formatting_syntax_error(capsys: CaptureFixture) -> None:
try:
exec("//serser")
except SyntaxError as exc:
sys.excepthook(type(exc), exc, exc.__traceback__)
if sys.version_info >= (3, 10):
underline = "\n ^^"
elif sys.version_info >= (3, 8):
underline = "\n ^"
else:
underline = "\n ^"
lineno = test_formatting_syntax_error.__code__.co_firstlineno
output = capsys.readouterr().err
assert output == (
f"""\
Traceback (most recent call last):
File "{__file__}", line {lineno + 2}, \
in test_formatting_syntax_error
exec("//serser")
File "<string>", line 1
//serser{underline}
SyntaxError: invalid syntax
"""
)
def test_format_exception(
patched: bool, old_argstyle: bool, monkeypatch: MonkeyPatch
) -> None:
if not patched:
# Block monkey patching, then force the module to be re-imported
del sys.modules["traceback"]
del sys.modules["exceptiongroup"]
del sys.modules["exceptiongroup._formatting"]
monkeypatch.setattr(sys, "excepthook", lambda *args: sys.__excepthook__(*args))
from exceptiongroup import format_exception
exceptions = []
try:
raise ValueError("foo")
except ValueError as exc:
exceptions.append(exc)
try:
raise RuntimeError("bar")
except RuntimeError as exc:
exc.__notes__ = ["Note from bar handler"]
exceptions.append(exc)
try:
raise_excgroup()
except ExceptionGroup as exc:
if old_argstyle:
lines = format_exception(type(exc), exc, exc.__traceback__)
else:
lines = format_exception(exc)
local_lineno = test_format_exception.__code__.co_firstlineno
lineno = raise_excgroup.__code__.co_firstlineno
assert isinstance(lines, list)
module_prefix = "" if sys.version_info >= (3, 11) else "exceptiongroup."
assert "".join(lines) == (
f"""\
+ Exception Group Traceback (most recent call last):
| File "{__file__}", line {local_lineno + 25}, in test_format_exception
| raise_excgroup()
| File "{__file__}", line {lineno + 15}, in raise_excgroup
| raise exc
| {module_prefix}ExceptionGroup: test message (2 sub-exceptions)
| Displays notes attached to the group too
+-+---------------- 1 ----------------
| Traceback (most recent call last):
| File "{__file__}", line {lineno + 3}, in raise_excgroup
| raise ValueError("foo")
| ValueError: foo
+---------------- 2 ----------------
| Traceback (most recent call last):
| File "{__file__}", line {lineno + 8}, in raise_excgroup
| raise RuntimeError("bar")
| RuntimeError: bar
| Note from bar handler
+------------------------------------
"""
)
def test_format_exception_only(
patched: bool, old_argstyle: bool, monkeypatch: MonkeyPatch
) -> None:
if not patched:
# Block monkey patching, then force the module to be re-imported
del sys.modules["traceback"]
del sys.modules["exceptiongroup"]
del sys.modules["exceptiongroup._formatting"]
monkeypatch.setattr(sys, "excepthook", lambda *args: sys.__excepthook__(*args))
from exceptiongroup import format_exception_only
try:
raise_excgroup()
except ExceptionGroup as exc:
if old_argstyle:
output = format_exception_only(type(exc), exc)
else:
output = format_exception_only(exc)
module_prefix = "" if sys.version_info >= (3, 11) else "exceptiongroup."
assert output == [
f"{module_prefix}ExceptionGroup: test message (2 sub-exceptions)\n",
"Displays notes attached to the group too\n",
]
def test_print_exception(
patched: bool, old_argstyle: bool, monkeypatch: MonkeyPatch, capsys: CaptureFixture
) -> None:
if not patched:
# Block monkey patching, then force the module to be re-imported
del sys.modules["traceback"]
del sys.modules["exceptiongroup"]
del sys.modules["exceptiongroup._formatting"]
monkeypatch.setattr(sys, "excepthook", lambda *args: sys.__excepthook__(*args))
from exceptiongroup import print_exception
try:
raise_excgroup()
except ExceptionGroup as exc:
if old_argstyle:
print_exception(type(exc), exc, exc.__traceback__)
else:
print_exception(exc)
local_lineno = test_print_exception.__code__.co_firstlineno
lineno = raise_excgroup.__code__.co_firstlineno
module_prefix = "" if sys.version_info >= (3, 11) else "exceptiongroup."
output = capsys.readouterr().err
assert output == (
f"""\
+ Exception Group Traceback (most recent call last):
| File "{__file__}", line {local_lineno + 13}, in test_print_exception
| raise_excgroup()
| File "{__file__}", line {lineno + 15}, in raise_excgroup
| raise exc
| {module_prefix}ExceptionGroup: test message (2 sub-exceptions)
| Displays notes attached to the group too
+-+---------------- 1 ----------------
| Traceback (most recent call last):
| File "{__file__}", line {lineno + 3}, in raise_excgroup
| raise ValueError("foo")
| ValueError: foo
+---------------- 2 ----------------
| Traceback (most recent call last):
| File "{__file__}", line {lineno + 8}, in raise_excgroup
| raise RuntimeError("bar")
| RuntimeError: bar
| Note from bar handler
+------------------------------------
"""
)
def test_print_exc(
patched: bool, monkeypatch: MonkeyPatch, capsys: CaptureFixture
) -> None:
if not patched:
# Block monkey patching, then force the module to be re-imported
del sys.modules["traceback"]
del sys.modules["exceptiongroup"]
del sys.modules["exceptiongroup._formatting"]
monkeypatch.setattr(sys, "excepthook", lambda *args: sys.__excepthook__(*args))
from exceptiongroup import print_exc
try:
raise_excgroup()
except ExceptionGroup:
print_exc()
local_lineno = test_print_exc.__code__.co_firstlineno
lineno = raise_excgroup.__code__.co_firstlineno
module_prefix = "" if sys.version_info >= (3, 11) else "exceptiongroup."
output = capsys.readouterr().err
assert output == (
f"""\
+ Exception Group Traceback (most recent call last):
| File "{__file__}", line {local_lineno + 13}, in test_print_exc
| raise_excgroup()
| File "{__file__}", line {lineno + 15}, in raise_excgroup
| raise exc
| {module_prefix}ExceptionGroup: test message (2 sub-exceptions)
| Displays notes attached to the group too
+-+---------------- 1 ----------------
| Traceback (most recent call last):
| File "{__file__}", line {lineno + 3}, in raise_excgroup
| raise ValueError("foo")
| ValueError: foo
+---------------- 2 ----------------
| Traceback (most recent call last):
| File "{__file__}", line {lineno + 8}, in raise_excgroup
| raise RuntimeError("bar")
| RuntimeError: bar
| Note from bar handler
+------------------------------------
"""
)