Skip to content

gh-93883: elide traceback indicators when possible #93994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pablogsal merged 13 commits into from
Jul 11, 2022
Merged

gh-93883: elide traceback indicators when possible #93994

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
bd99c32
gh-93883: elide traceback indicators when possible
belm0 Jun 19, 2022
bba12b1
fix test_idle
belm0 Jun 19, 2022
6a8f56d
traceback.c: fix doc typo; simplify expression
belm0 Jun 23, 2022
94be186
traceback.c implementation
belm0 Jun 23, 2022
c06257b
fix test_cmd_line_script
belm0 Jun 24, 2022
87fafa6
📜🤖 Added by blurb_it.
blurb-it[bot] Jun 24, 2022
a64635c
remove stray maxDiff from test
belm0 Jun 24, 2022
361da86
change testing strategy
belm0 Jun 24, 2022
d392332
update doc examples
belm0 Jun 24, 2022
f6927cd
Apply suggestions: doc formatting
belm0 Jun 28, 2022
4ff4b77
test_doctest: remove unneeded has_no_debug_ranges()
belm0 Jun 28, 2022
28d95b4
traceback.c: refactor elide check
belm0 Jun 28, 2022
8ac461f
doc additions:
belm0 Jun 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
change testing strategy 
Rather than going out of our way to provide indicator coverage
in every traceback test suite, the indicator test suite should
be responible for sufficient coverage (e.g. by adding a basic
exception group test to ensure that margin strings are covered).
  • Loading branch information
@belm0
belm0 committed Jun 24, 2022
commit 361da86601904784f7b6505ce8f014954598ae6b
127 changes: 62 additions & 65 deletions Lib/test/test_traceback.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,6 +625,28 @@ def f_with_subscript():
result_lines = self.get_exception(f_with_subscript)
self.assertEqual(result_lines, expected_error.splitlines())

def test_caret_exception_group(self):
# especially, this covers whether indicators handle margin strings correctly
Comment thread
belm0 marked this conversation as resolved.
Outdated

def exc():
if True: raise ExceptionGroup("eg", [ValueError(1), TypeError(2)])

expected_error = (
f' + Exception Group Traceback (most recent call last):\n'
f' | File "{__file__}", line {self.callable_line}, in get_exception\n'
f' | callable()\n'
f' | File "{__file__}", line {exc.__code__.co_firstlineno + 1}, in exc\n'
f' | if True: raise ExceptionGroup("eg", [ValueError(1), TypeError(2)])\n'
f' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n'
f' | ExceptionGroup: eg (2 sub-exceptions)\n'
f' +-+---------------- 1 ----------------\n'
f' | ValueError: 1\n'
f' +---------------- 2 ----------------\n'
f' | TypeError: 2\n')

result_lines = self.get_exception(exc)
self.assertEqual(result_lines, expected_error.splitlines())

def assertSpecialized(self, func, expected_specialization):
result_lines = self.get_exception(func)
specialization_line = result_lines[-1]
Expand Down Expand Up @@ -726,13 +748,13 @@ def get_exception(self, callable):
class TracebackFormatTests(unittest.TestCase):

def some_exception(self):
if True: raise KeyError('blah')
raise KeyError('blah')

@cpython_only
def check_traceback_format(self, cleanup_func=None):
from _testcapi import traceback_print
try:
if True: self.some_exception()
self.some_exception()
except KeyError:
type_, value, tb = sys.exc_info()
if cleanup_func is not None:
Expand Down Expand Up @@ -767,15 +789,11 @@ def check_traceback_format(self, cleanup_func=None):
# Make sure that the traceback is properly indented.
tb_lines = python_fmt.splitlines()
banner = tb_lines[0]
if has_no_debug_ranges():
self.assertEqual(len(tb_lines), 5)
location, source_line = tb_lines[-2], tb_lines[-1]
else:
self.assertEqual(len(tb_lines), 7)
location, source_line = tb_lines[-3], tb_lines[-2]
self.assertEqual(len(tb_lines), 5)
location, source_line = tb_lines[-2], tb_lines[-1]
self.assertTrue(banner.startswith('Traceback'))
self.assertTrue(location.startswith(' File'))
self.assertTrue(source_line.startswith(' if True: raise'))
self.assertTrue(source_line.startswith(' raise'))

def test_traceback_format(self):
self.check_traceback_format()
Expand Down Expand Up @@ -821,11 +839,11 @@ def _check_recursive_traceback_display(self, render_exc):

# Check hitting the recursion limit
def f():
if True: f()
f()

with captured_output("stderr") as stderr_f:
try:
if True: f()
f()
except RecursionError:
render_exc()
else:
Expand All @@ -835,17 +853,13 @@ def f():
result_f = (
'Traceback (most recent call last):\n'
f' File "{__file__}", line {lineno_f+5}, in _check_recursive_traceback_display\n'
' if True: f()\n'
' ^^^\n'
' f()\n'
f' File "{__file__}", line {lineno_f+1}, in f\n'
' if True: f()\n'
' ^^^\n'
' f()\n'
f' File "{__file__}", line {lineno_f+1}, in f\n'
' if True: f()\n'
' ^^^\n'
' f()\n'
f' File "{__file__}", line {lineno_f+1}, in f\n'
' if True: f()\n'
' ^^^\n'
' f()\n'
# XXX: The following line changes depending on whether the tests
# are run through the interactive interpreter or with -m
# It also varies depending on the platform (stack size)
Expand Down Expand Up @@ -876,7 +890,7 @@ def g(count=10):

with captured_output("stderr") as stderr_g:
try:
if True: g()
g()
except ValueError:
render_exc()
else:
Expand All @@ -901,8 +915,7 @@ def g(count=10):
tb_line = (
'Traceback (most recent call last):\n'
f' File "{__file__}", line {lineno_g+7}, in _check_recursive_traceback_display\n'
' if True: g()\n'
' ^^^\n'
' g()\n'
)
expected = (tb_line + result_g).splitlines()
actual = stderr_g.getvalue().splitlines()
Expand All @@ -912,11 +925,11 @@ def g(count=10):
def h(count=10):
if count:
return h(count-1)
if True: g()
g()

with captured_output("stderr") as stderr_h:
try:
if True: h()
h()
except ValueError:
render_exc()
else:
Expand All @@ -926,8 +939,7 @@ def h(count=10):
result_h = (
'Traceback (most recent call last):\n'
f' File "{__file__}", line {lineno_h+7}, in _check_recursive_traceback_display\n'
' if True: h()\n'
' ^^^\n'
' h()\n'
f' File "{__file__}", line {lineno_h+2}, in h\n'
' return h(count-1)\n'
' ^^^^^^^^^^\n'
Expand All @@ -939,8 +951,7 @@ def h(count=10):
' ^^^^^^^^^^\n'
' [Previous line repeated 7 more times]\n'
f' File "{__file__}", line {lineno_h+3}, in h\n'
' if True: g()\n'
' ^^^\n'
' g()\n'
)
expected = (result_h + result_g).splitlines()
actual = stderr_h.getvalue().splitlines()
Expand All @@ -949,7 +960,7 @@ def h(count=10):
# Check the boundary conditions. First, test just below the cutoff.
with captured_output("stderr") as stderr_g:
try:
if True: g(traceback._RECURSIVE_CUTOFF)
g(traceback._RECURSIVE_CUTOFF)
except ValueError:
render_exc()
else:
Expand All @@ -970,9 +981,8 @@ def h(count=10):
)
tb_line = (
'Traceback (most recent call last):\n'
f' File "{__file__}", line {lineno_g+80}, in _check_recursive_traceback_display\n'
' if True: g(traceback._RECURSIVE_CUTOFF)\n'
' ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n'
f' File "{__file__}", line {lineno_g+77}, in _check_recursive_traceback_display\n'
' g(traceback._RECURSIVE_CUTOFF)\n'
)
expected = (tb_line + result_g).splitlines()
actual = stderr_g.getvalue().splitlines()
Expand All @@ -981,7 +991,7 @@ def h(count=10):
# Second, test just above the cutoff.
with captured_output("stderr") as stderr_g:
try:
if True: g(traceback._RECURSIVE_CUTOFF + 1)
g(traceback._RECURSIVE_CUTOFF + 1)
except ValueError:
render_exc()
else:
Expand All @@ -1003,9 +1013,8 @@ def h(count=10):
)
tb_line = (
'Traceback (most recent call last):\n'
f' File "{__file__}", line {lineno_g+112}, in _check_recursive_traceback_display\n'
' if True: g(traceback._RECURSIVE_CUTOFF + 1)\n'
' ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n'
f' File "{__file__}", line {lineno_g+108}, in _check_recursive_traceback_display\n'
' g(traceback._RECURSIVE_CUTOFF + 1)\n'
)
expected = (tb_line + result_g).splitlines()
actual = stderr_g.getvalue().splitlines()
Expand Down Expand Up @@ -1193,16 +1202,12 @@ def test_context_suppression(self):
try:
raise Exception
except:
if True: raise ZeroDivisionError from None
raise ZeroDivisionError from None
except ZeroDivisionError as _:
e = _
lines = self.get_report(e).splitlines()
if has_no_debug_ranges():
self.assertEqual(len(lines), 4)
self.assertTrue(lines[3].startswith('ZeroDivisionError'))
else:
self.assertEqual(len(lines), 5)
self.assertTrue(lines[4].startswith('ZeroDivisionError'))
self.assertEqual(len(lines), 4)
self.assertTrue(lines[3].startswith('ZeroDivisionError'))
self.assertTrue(lines[0].startswith('Traceback'))
self.assertTrue(lines[1].startswith(' File'))
self.assertIn('ZeroDivisionError from None', lines[2])
Expand Down Expand Up @@ -1446,15 +1451,14 @@ def __str__(self):

def test_exception_group_basic(self):
def exc():
if True: raise ExceptionGroup("eg", [ValueError(1), TypeError(2)])
raise ExceptionGroup("eg", [ValueError(1), TypeError(2)])

expected = (
f' + Exception Group Traceback (most recent call last):\n'
f' | File "{__file__}", line {self.callable_line}, in get_exception\n'
f' | exception_or_callable()\n'
f' | File "{__file__}", line {exc.__code__.co_firstlineno + 1}, in exc\n'
f' | if True: raise ExceptionGroup("eg", [ValueError(1), TypeError(2)])\n'
f' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n'
f' | raise ExceptionGroup("eg", [ValueError(1), TypeError(2)])\n'
f' | ExceptionGroup: eg (2 sub-exceptions)\n'
f' +-+---------------- 1 ----------------\n'
f' | ValueError: 1\n'
Expand All @@ -1469,14 +1473,13 @@ def test_exception_group_cause(self):
def exc():
EG = ExceptionGroup
try:
if True: raise EG("eg1", [ValueError(1), TypeError(2)])
raise EG("eg1", [ValueError(1), TypeError(2)])
except Exception as e:
raise EG("eg2", [ValueError(3), TypeError(4)]) from e

expected = (f' + Exception Group Traceback (most recent call last):\n'
f' | File "{__file__}", line {exc.__code__.co_firstlineno + 3}, in exc\n'
f' | if True: raise EG("eg1", [ValueError(1), TypeError(2)])\n'
f' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n'
f' | raise EG("eg1", [ValueError(1), TypeError(2)])\n'
f' | ExceptionGroup: eg1 (2 sub-exceptions)\n'
f' +-+---------------- 1 ----------------\n'
f' | ValueError: 1\n'
Expand Down Expand Up @@ -1506,7 +1509,7 @@ def exc():
EG = ExceptionGroup
try:
try:
if True: raise EG("eg1", [ValueError(1), TypeError(2)])
raise EG("eg1", [ValueError(1), TypeError(2)])
except:
raise EG("eg2", [ValueError(3), TypeError(4)])
except:
Expand All @@ -1515,8 +1518,7 @@ def exc():
expected = (
f' + Exception Group Traceback (most recent call last):\n'
f' | File "{__file__}", line {exc.__code__.co_firstlineno + 4}, in exc\n'
f' | if True: raise EG("eg1", [ValueError(1), TypeError(2)])\n'
f' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n'
f' | raise EG("eg1", [ValueError(1), TypeError(2)])\n'
f' | ExceptionGroup: eg1 (2 sub-exceptions)\n'
f' +-+---------------- 1 ----------------\n'
f' | ValueError: 1\n'
Expand Down Expand Up @@ -1555,7 +1557,7 @@ def exc():
TE = TypeError
try:
try:
if True: raise EG("nested", [TE(2), TE(3)])
raise EG("nested", [TE(2), TE(3)])
except Exception as e:
exc = e
raise EG("eg", [VE(1), exc, VE(4)])
Expand All @@ -1571,8 +1573,7 @@ def exc():
f' +---------------- 2 ----------------\n'
f' | Exception Group Traceback (most recent call last):\n'
f' | File "{__file__}", line {exc.__code__.co_firstlineno + 6}, in exc\n'
f' | if True: raise EG("nested", [TE(2), TE(3)])\n'
f' | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n'
f' | raise EG("nested", [TE(2), TE(3)])\n'
f' | ExceptionGroup: nested (2 sub-exceptions)\n'
f' +-+---------------- 1 ----------------\n'
f' | TypeError: 2\n'
Expand Down Expand Up @@ -1730,7 +1731,7 @@ def exc():
excs = []
for msg in ['bad value', 'terrible value']:
try:
if True: raise ValueError(msg)
raise ValueError(msg)
except ValueError as e:
e.add_note(f'the {msg}')
excs.append(e)
Expand Down Expand Up @@ -1759,15 +1760,13 @@ def exc():
f' +-+---------------- 1 ----------------\n'
f' | Traceback (most recent call last):\n'
f' | File "{__file__}", line {exc.__code__.co_firstlineno + 5}, in exc\n'
f' | if True: raise ValueError(msg)\n'
f' | ^^^^^^^^^^^^^^^^^^^^^\n'
f' | raise ValueError(msg)\n'
f' | ValueError: bad value\n'
f' | the bad value\n'
f' +---------------- 2 ----------------\n'
f' | Traceback (most recent call last):\n'
f' | File "{__file__}", line {exc.__code__.co_firstlineno + 5}, in exc\n'
f' | if True: raise ValueError(msg)\n'
f' | ^^^^^^^^^^^^^^^^^^^^^\n'
f' | raise ValueError(msg)\n'
f' | ValueError: terrible value\n'
f' | the terrible value\n'
f' +------------------------------------\n')
Expand All @@ -1781,7 +1780,7 @@ def exc():
excs = []
for msg in ['bad value', 'terrible value']:
try:
if True: raise ValueError(msg)
raise ValueError(msg)
except ValueError as e:
e.add_note(f'the {msg}')
e.add_note(f'Goodbye {msg}')
Expand Down Expand Up @@ -1813,16 +1812,14 @@ def exc():
f' +-+---------------- 1 ----------------\n'
f' | Traceback (most recent call last):\n'
f' | File "{__file__}", line {exc.__code__.co_firstlineno + 5}, in exc\n'
f' | if True: raise ValueError(msg)\n'
f' | ^^^^^^^^^^^^^^^^^^^^^\n'
f' | raise ValueError(msg)\n'
f' | ValueError: bad value\n'
f' | the bad value\n'
f' | Goodbye bad value\n'
f' +---------------- 2 ----------------\n'
f' | Traceback (most recent call last):\n'
f' | File "{__file__}", line {exc.__code__.co_firstlineno + 5}, in exc\n'
f' | if True: raise ValueError(msg)\n'
f' | ^^^^^^^^^^^^^^^^^^^^^\n'
f' | raise ValueError(msg)\n'
f' | ValueError: terrible value\n'
f' | the terrible value\n'
f' | Goodbye terrible value\n'
Expand Down