https://github.com/python/cpython/commit/8fe586d27abda29188cac6def55a04bf15242891
commit: 8fe586d27abda29188cac6def55a04bf15242891
branch: 3.12
author: Serhiy Storchaka <storch...@gmail.com>
committer: serhiy-storchaka <storch...@gmail.com>
date: 2024-08-23T09:27:03+03:00
summary:
[3.12] gh-122478: Remove internal frames from tracebacks in REPL (GH-122528)
(GH-122816)
Frames of methods in code and codeop modules was show with non-default
sys.excepthook.
Save correct tracebacks in sys.last_traceback and update __traceback__
attribute of sys.last_value and sys.last_exc.
(cherry picked from commit e73e7a7abdc3fed252affcb1629df1b3c8fff2ef)
files:
A Misc/NEWS.d/next/Library/2024-07-31-20-43-21.gh-issue-122478.sCU2Le.rst
M Lib/code.py
M Lib/test/test_code_module.py
diff --git a/Lib/code.py b/Lib/code.py
index b4b1ef3b8b96fb..cb7dd44b0a38c0 100644
--- a/Lib/code.py
+++ b/Lib/code.py
@@ -105,29 +105,21 @@ def showsyntaxerror(self, filename=None):
The output is written by self.write(), below.
"""
- type, value, tb = sys.exc_info()
- sys.last_exc = value
- sys.last_type = type
- sys.last_value = value
- sys.last_traceback = tb
- if filename and type is SyntaxError:
- # Work hard to stuff the correct filename in the exception
- try:
- msg, (dummy_filename, lineno, offset, line) = value.args
- except ValueError:
- # Not the format we expect; leave it alone
- pass
- else:
- # Stuff in the right filename
- value = SyntaxError(msg, (filename, lineno, offset, line))
- sys.last_exc = sys.last_value = value
- if sys.excepthook is sys.__excepthook__:
- lines = traceback.format_exception_only(type, value)
- self.write(''.join(lines))
- else:
- # If someone has set sys.excepthook, we let that take precedence
- # over self.write
- self._call_excepthook(type, value, tb)
+ try:
+ typ, value, tb = sys.exc_info()
+ if filename and typ is SyntaxError:
+ # Work hard to stuff the correct filename in the exception
+ try:
+ msg, (dummy_filename, lineno, offset, line) = value.args
+ except ValueError:
+ # Not the format we expect; leave it alone
+ pass
+ else:
+ # Stuff in the right filename
+ value = SyntaxError(msg, (filename, lineno, offset, line))
+ self._showtraceback(typ, value, None)
+ finally:
+ typ = value = tb = None
def showtraceback(self):
"""Display the exception that just occurred.
@@ -137,32 +129,34 @@ def showtraceback(self):
The output is written by self.write(), below.
"""
- sys.last_type, sys.last_value, last_tb = ei = sys.exc_info()
- sys.last_traceback = last_tb
- sys.last_exc = ei[1]
try:
- if sys.excepthook is sys.__excepthook__:
- lines = traceback.format_exception(ei[0], ei[1],
last_tb.tb_next)
- self.write(''.join(lines))
- else:
- # If someone has set sys.excepthook, we let that take
precedence
- # over self.write
- self._call_excepthook(ei[0], ei[1], last_tb)
+ typ, value, tb = sys.exc_info()
+ self._showtraceback(typ, value, tb.tb_next)
finally:
- last_tb = ei = None
+ typ = value = tb = None
- def _call_excepthook(self, typ, value, tb):
- try:
- sys.excepthook(typ, value, tb)
- except SystemExit:
- raise
- except BaseException as e:
- e.__context__ = None
- print('Error in sys.excepthook:', file=sys.stderr)
- sys.__excepthook__(type(e), e, e.__traceback__.tb_next)
- print(file=sys.stderr)
- print('Original exception was:', file=sys.stderr)
- sys.__excepthook__(typ, value, tb)
+ def _showtraceback(self, typ, value, tb):
+ sys.last_type = typ
+ sys.last_traceback = tb
+ sys.last_exc = sys.last_value = value = value.with_traceback(tb)
+ if sys.excepthook is sys.__excepthook__:
+ lines = traceback.format_exception(typ, value, tb)
+ self.write(''.join(lines))
+ else:
+ # If someone has set sys.excepthook, we let that take precedence
+ # over self.write
+ try:
+ sys.excepthook(typ, value, tb)
+ except SystemExit:
+ raise
+ except BaseException as e:
+ e.__context__ = None
+ e = e.with_traceback(e.__traceback__.tb_next)
+ print('Error in sys.excepthook:', file=sys.stderr)
+ sys.__excepthook__(type(e), e, e.__traceback__)
+ print(file=sys.stderr)
+ print('Original exception was:', file=sys.stderr)
+ sys.__excepthook__(typ, value, tb)
def write(self, data):
"""Write a string.
diff --git a/Lib/test/test_code_module.py b/Lib/test/test_code_module.py
index 6082abe898633e..06a1ba494be131 100644
--- a/Lib/test/test_code_module.py
+++ b/Lib/test/test_code_module.py
@@ -1,5 +1,6 @@
"Test InteractiveConsole and InteractiveInterpreter from code module"
import sys
+import traceback
import unittest
from textwrap import dedent
from contextlib import ExitStack
@@ -11,6 +12,7 @@
class TestInteractiveConsole(unittest.TestCase):
+ maxDiff = None
def setUp(self):
self.console = code.InteractiveConsole()
@@ -58,21 +60,118 @@ def test_console_stderr(self):
raise AssertionError("no console stdout")
def test_syntax_error(self):
- self.infunc.side_effect = ["undefined", EOFError('Finished')]
+ self.infunc.side_effect = ["def f():",
+ " x = ?",
+ "",
+ EOFError('Finished')]
self.console.interact()
- for call in self.stderr.method_calls:
- if 'NameError' in ''.join(call[1]):
- break
- else:
- raise AssertionError("No syntax error from console")
+ output = ''.join(''.join(call[1]) for call in self.stderr.method_calls)
+ output = output[output.index('(InteractiveConsole)'):]
+ output = output[:output.index('\nnow exiting')]
+ self.assertEqual(output.splitlines()[1:], [
+ ' File "<console>", line 2',
+ ' x = ?',
+ ' ^',
+ 'SyntaxError: invalid syntax'])
+ self.assertIs(self.sysmod.last_type, SyntaxError)
+ self.assertIs(type(self.sysmod.last_value), SyntaxError)
+ self.assertIsNone(self.sysmod.last_traceback)
+ self.assertIsNone(self.sysmod.last_value.__traceback__)
+ self.assertIs(self.sysmod.last_exc, self.sysmod.last_value)
+
+ def test_indentation_error(self):
+ self.infunc.side_effect = [" 1", EOFError('Finished')]
+ self.console.interact()
+ output = ''.join(''.join(call[1]) for call in self.stderr.method_calls)
+ output = output[output.index('(InteractiveConsole)'):]
+ output = output[:output.index('\nnow exiting')]
+ self.assertEqual(output.splitlines()[1:], [
+ ' File "<console>", line 1',
+ ' 1',
+ 'IndentationError: unexpected indent'])
+ self.assertIs(self.sysmod.last_type, IndentationError)
+ self.assertIs(type(self.sysmod.last_value), IndentationError)
+ self.assertIsNone(self.sysmod.last_traceback)
+ self.assertIsNone(self.sysmod.last_value.__traceback__)
+ self.assertIs(self.sysmod.last_exc, self.sysmod.last_value)
+
+ def test_unicode_error(self):
+ self.infunc.side_effect = ["'\ud800'", EOFError('Finished')]
+ self.console.interact()
+ output = ''.join(''.join(call[1]) for call in self.stderr.method_calls)
+ output = output[output.index('(InteractiveConsole)'):]
+ output = output[output.index('\n') + 1:]
+ self.assertTrue(output.startswith('UnicodeEncodeError: '), output)
+ self.assertIs(self.sysmod.last_type, UnicodeEncodeError)
+ self.assertIs(type(self.sysmod.last_value), UnicodeEncodeError)
+ self.assertIsNone(self.sysmod.last_traceback)
+ self.assertIsNone(self.sysmod.last_value.__traceback__)
+ self.assertIs(self.sysmod.last_exc, self.sysmod.last_value)
def test_sysexcepthook(self):
- self.infunc.side_effect = ["raise ValueError('')",
+ self.infunc.side_effect = ["def f():",
+ " raise ValueError('BOOM!')",
+ "",
+ "f()",
EOFError('Finished')]
hook = mock.Mock()
self.sysmod.excepthook = hook
self.console.interact()
- self.assertTrue(hook.called)
+ hook.assert_called()
+ hook.assert_called_with(self.sysmod.last_type,
+ self.sysmod.last_value,
+ self.sysmod.last_traceback)
+ self.assertIs(self.sysmod.last_type, ValueError)
+ self.assertIs(type(self.sysmod.last_value), ValueError)
+ self.assertIs(self.sysmod.last_traceback,
self.sysmod.last_value.__traceback__)
+ self.assertIs(self.sysmod.last_exc, self.sysmod.last_value)
+ self.assertEqual(traceback.format_exception(self.sysmod.last_exc), [
+ 'Traceback (most recent call last):\n',
+ ' File "<console>", line 1, in <module>\n',
+ ' File "<console>", line 2, in f\n',
+ 'ValueError: BOOM!\n'])
+
+ def test_sysexcepthook_syntax_error(self):
+ self.infunc.side_effect = ["def f():",
+ " x = ?",
+ "",
+ EOFError('Finished')]
+ hook = mock.Mock()
+ self.sysmod.excepthook = hook
+ self.console.interact()
+ hook.assert_called()
+ hook.assert_called_with(self.sysmod.last_type,
+ self.sysmod.last_value,
+ self.sysmod.last_traceback)
+ self.assertIs(self.sysmod.last_type, SyntaxError)
+ self.assertIs(type(self.sysmod.last_value), SyntaxError)
+ self.assertIsNone(self.sysmod.last_traceback)
+ self.assertIsNone(self.sysmod.last_value.__traceback__)
+ self.assertIs(self.sysmod.last_exc, self.sysmod.last_value)
+ self.assertEqual(traceback.format_exception(self.sysmod.last_exc), [
+ ' File "<console>", line 2\n',
+ ' x = ?\n',
+ ' ^\n',
+ 'SyntaxError: invalid syntax\n'])
+
+ def test_sysexcepthook_indentation_error(self):
+ self.infunc.side_effect = [" 1", EOFError('Finished')]
+ hook = mock.Mock()
+ self.sysmod.excepthook = hook
+ self.console.interact()
+ hook.assert_called()
+ hook.assert_called_with(self.sysmod.last_type,
+ self.sysmod.last_value,
+ self.sysmod.last_traceback)
+ self.assertIs(self.sysmod.last_type, IndentationError)
+ self.assertIs(type(self.sysmod.last_value), IndentationError)
+ self.assertIsNone(self.sysmod.last_traceback)
+ self.assertIsNone(self.sysmod.last_value.__traceback__)
+ self.assertIs(self.sysmod.last_exc, self.sysmod.last_value)
+ self.assertEqual(traceback.format_exception(self.sysmod.last_exc), [
+ ' File "<console>", line 1\n',
+ ' 1\n',
+ 'IndentationError: unexpected indent\n'])
def test_sysexcepthook_crashing_doesnt_close_repl(self):
self.infunc.side_effect = ["1/0", "a = 123", "print(a)",
EOFError('Finished')]
@@ -164,6 +263,11 @@ def test_cause_tb(self):
ValueError
""")
self.assertIn(expected, output)
+ self.assertIs(self.sysmod.last_type, ValueError)
+ self.assertIs(type(self.sysmod.last_value), ValueError)
+ self.assertIs(self.sysmod.last_traceback,
self.sysmod.last_value.__traceback__)
+ self.assertIsNotNone(self.sysmod.last_traceback)
+ self.assertIs(self.sysmod.last_exc, self.sysmod.last_value)
def test_context_tb(self):
self.infunc.side_effect = ["try: ham\nexcept: eggs\n",
@@ -182,6 +286,11 @@ def test_context_tb(self):
NameError: name 'eggs' is not defined
""")
self.assertIn(expected, output)
+ self.assertIs(self.sysmod.last_type, NameError)
+ self.assertIs(type(self.sysmod.last_value), NameError)
+ self.assertIs(self.sysmod.last_traceback,
self.sysmod.last_value.__traceback__)
+ self.assertIsNotNone(self.sysmod.last_traceback)
+ self.assertIs(self.sysmod.last_exc, self.sysmod.last_value)
if __name__ == "__main__":
diff --git
a/Misc/NEWS.d/next/Library/2024-07-31-20-43-21.gh-issue-122478.sCU2Le.rst
b/Misc/NEWS.d/next/Library/2024-07-31-20-43-21.gh-issue-122478.sCU2Le.rst
new file mode 100644
index 00000000000000..6071324593a9ed
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2024-07-31-20-43-21.gh-issue-122478.sCU2Le.rst
@@ -0,0 +1,3 @@
+Remove internal frames from tracebacks shown in
+:class:`code.InteractiveInterpreter` with non-default :func:`sys.excepthook`.
+Save correct tracebacks in :attr:`sys.last_traceback` and update
``__traceback__`` attribute of :attr:`sys.last_value` and :attr:`sys.last_exc`.
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
