gh-65052: Prevent pdb from crashing when trying to display objects (#110578)

This commit is contained in:
Tian Gao 2023-10-11 10:52:14 -07:00 committed by GitHub
parent de956b263b
commit c523ce0f43
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 62 additions and 7 deletions

View file

@ -431,8 +431,9 @@ class Pdb(bdb.Bdb, cmd.Cmd):
# fields are changed to be displayed # fields are changed to be displayed
if newvalue is not oldvalue and newvalue != oldvalue: if newvalue is not oldvalue and newvalue != oldvalue:
displaying[expr] = newvalue displaying[expr] = newvalue
self.message('display %s: %r [old: %r]' % self.message('display %s: %s [old: %s]' %
(expr, newvalue, oldvalue)) (expr, self._safe_repr(newvalue, expr),
self._safe_repr(oldvalue, expr)))
def _get_tb_and_exceptions(self, tb_or_exc): def _get_tb_and_exceptions(self, tb_or_exc):
""" """
@ -1460,7 +1461,7 @@ class Pdb(bdb.Bdb, cmd.Cmd):
for i in range(n): for i in range(n):
name = co.co_varnames[i] name = co.co_varnames[i]
if name in dict: if name in dict:
self.message('%s = %r' % (name, dict[name])) self.message('%s = %s' % (name, self._safe_repr(dict[name], name)))
else: else:
self.message('%s = *** undefined ***' % (name,)) self.message('%s = *** undefined ***' % (name,))
do_a = do_args do_a = do_args
@ -1474,7 +1475,7 @@ class Pdb(bdb.Bdb, cmd.Cmd):
self._print_invalid_arg(arg) self._print_invalid_arg(arg)
return return
if '__return__' in self.curframe_locals: if '__return__' in self.curframe_locals:
self.message(repr(self.curframe_locals['__return__'])) self.message(self._safe_repr(self.curframe_locals['__return__'], "retval"))
else: else:
self.error('Not yet returned!') self.error('Not yet returned!')
do_rv = do_retval do_rv = do_retval
@ -1509,6 +1510,12 @@ class Pdb(bdb.Bdb, cmd.Cmd):
except: except:
self._error_exc() self._error_exc()
def _safe_repr(self, obj, expr):
try:
return repr(obj)
except Exception as e:
return _rstr(f"*** repr({expr}) failed: {self._format_exc(e)} ***")
def do_p(self, arg): def do_p(self, arg):
"""p expression """p expression
@ -1688,8 +1695,8 @@ class Pdb(bdb.Bdb, cmd.Cmd):
if not arg: if not arg:
if self.displaying: if self.displaying:
self.message('Currently displaying:') self.message('Currently displaying:')
for item in self.displaying.get(self.curframe, {}).items(): for key, val in self.displaying.get(self.curframe, {}).items():
self.message('%s: %r' % item) self.message('%s: %s' % (key, self._safe_repr(val, key)))
else: else:
self.message('No expression is being displayed') self.message('No expression is being displayed')
else: else:
@ -1698,7 +1705,7 @@ class Pdb(bdb.Bdb, cmd.Cmd):
else: else:
val = self._getval_except(arg) val = self._getval_except(arg)
self.displaying.setdefault(self.curframe, {})[arg] = val self.displaying.setdefault(self.curframe, {})[arg] = val
self.message('display %s: %r' % (arg, val)) self.message('display %s: %s' % (arg, self._safe_repr(val, arg)))
complete_display = _complete_expression complete_display = _complete_expression

View file

@ -2350,6 +2350,53 @@ def test_pdb_ambiguous_statements():
(Pdb) continue (Pdb) continue
""" """
def test_pdb_issue_gh_65052():
"""See GH-65052
args, retval and display should not crash if the object is not displayable
>>> class A:
... def __new__(cls):
... import pdb; pdb.Pdb(nosigint=True, readrc=False).set_trace()
... return object.__new__(cls)
... def __init__(self):
... import pdb; pdb.Pdb(nosigint=True, readrc=False).set_trace()
... self.a = 1
... def __repr__(self):
... return self.a
>>> def test_function():
... A()
>>> with PdbTestInput([ # doctest: +ELLIPSIS +NORMALIZE_WHITESPACE
... 's',
... 'retval',
... 'continue',
... 'args',
... 'display self',
... 'display',
... 'continue',
... ]):
... test_function()
> <doctest test.test_pdb.test_pdb_issue_gh_65052[0]>(4)__new__()
-> return object.__new__(cls)
(Pdb) s
--Return--
> <doctest test.test_pdb.test_pdb_issue_gh_65052[0]>(4)__new__()-><A instance at ...>
-> return object.__new__(cls)
(Pdb) retval
*** repr(retval) failed: AttributeError: 'A' object has no attribute 'a' ***
(Pdb) continue
> <doctest test.test_pdb.test_pdb_issue_gh_65052[0]>(7)__init__()
-> self.a = 1
(Pdb) args
self = *** repr(self) failed: AttributeError: 'A' object has no attribute 'a' ***
(Pdb) display self
display self: *** repr(self) failed: AttributeError: 'A' object has no attribute 'a' ***
(Pdb) display
Currently displaying:
self: *** repr(self) failed: AttributeError: 'A' object has no attribute 'a' ***
(Pdb) continue
"""
@support.requires_subprocess() @support.requires_subprocess()
class PdbTestCase(unittest.TestCase): class PdbTestCase(unittest.TestCase):

View file

@ -0,0 +1 @@
Prevent :mod:`pdb` from crashing when trying to display undisplayable objects