gh-103023: Add SyntaxError check in pdb's display command (#103024)

Co-authored-by: Łukasz Langa <[email protected]>

Author: gaogaotiantian

Lib/pdb.py

@@ -399,7 +399,7 @@ def preloop(self):
         displaying = self.displaying.get(self.curframe)
         if displaying:
             for expr, oldvalue in displaying.items():
-                newvalue = self._getval_except(expr)
+                newvalue, _ = self._getval_except(expr)
                 # check for identity first; this prevents custom __eq__ to
                 # be called at every loop, and also prevents instances whose
                 # fields are changed to be displayed
@@ -1246,13 +1246,12 @@ def _getval(self, arg):
     def _getval_except(self, arg, frame=None):
         try:
             if frame is None:
-                return eval(arg, self.curframe.f_globals, self.curframe_locals)
+                return eval(arg, self.curframe.f_globals, self.curframe_locals), None
             else:
-                return eval(arg, frame.f_globals, frame.f_locals)
-        except:
-            exc_info = sys.exc_info()[:2]
-            err = traceback.format_exception_only(*exc_info)[-1].strip()
-            return _rstr('** raised %s **' % err)
+                return eval(arg, frame.f_globals, frame.f_locals), None
+        except BaseException as exc:
+            err = traceback.format_exception_only(exc)[-1].strip()
+            return _rstr('** raised %s **' % err), exc
 
     def _error_exc(self):
         exc_info = sys.exc_info()[:2]
@@ -1437,13 +1436,19 @@ def do_display(self, arg):
         Without expression, list all display expressions for the current frame.
         """
         if not arg:
-            self.message('Currently displaying:')
-            for item in self.displaying.get(self.curframe, {}).items():
-                self.message('%s: %r' % item)
+            if self.displaying:
+                self.message('Currently displaying:')
+                for item in self.displaying.get(self.curframe, {}).items():
+                    self.message('%s: %r' % item)
+            else:
+                self.message('No expression is being displayed')
         else:
-            val = self._getval_except(arg)
-            self.displaying.setdefault(self.curframe, {})[arg] = val
-            self.message('display %s: %r' % (arg, val))
+            val, exc = self._getval_except(arg)
+            if isinstance(exc, SyntaxError):
+                self.message('Unable to display %s: %r' % (arg, val))
+            else:
+                self.displaying.setdefault(self.curframe, {})[arg] = val
+                self.message('display %s: %r' % (arg, val))
 
     complete_display = _complete_expression
 

Lib/test/test_pdb.py

@@ -586,6 +586,8 @@ def test_pdb_display_command():
     ...     a = 4
 
     >>> with PdbTestInput([  # doctest: +ELLIPSIS
+    ...     'display +',
+    ...     'display',
     ...     'display a',
     ...     'n',
     ...     'display',
@@ -600,6 +602,10 @@ def test_pdb_display_command():
     ...    test_function()
     > <doctest test.test_pdb.test_pdb_display_command[0]>(4)test_function()
     -> a = 1
+    (Pdb) display +
+    Unable to display +: ** raised SyntaxError: invalid syntax **
+    (Pdb) display
+    No expression is being displayed
     (Pdb) display a
     display a: 0
     (Pdb) n

Misc/NEWS.d/next/Library/2023-03-25-02-08-05.gh-issue-103023.Qfn7Hl.rst

@@ -0,0 +1,2 @@
+It's no longer possible to register expressions to display in
+:class:`~pdb.Pdb` that raise :exc:`SyntaxError`. Patch by Tian Gao.