gh-111051: Check if file is modifed during debugging in pdb (#111052)

This commit is contained in:
Tian Gao 2024-01-25 08:48:50 -08:00 committed by GitHub
parent 07ef63fb6a
commit 8278fa2f56
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 103 additions and 0 deletions

View file

@ -233,6 +233,8 @@ class Pdb(bdb.Bdb, cmd.Cmd):
# but in case there are recursions, we stop at 999.
MAX_CHAINED_EXCEPTION_DEPTH = 999
_file_mtime_table = {}
def __init__(self, completekey='tab', stdin=None, stdout=None, skip=None,
nosigint=False, readrc=True):
bdb.Bdb.__init__(self, skip=skip)
@ -437,6 +439,20 @@ class Pdb(bdb.Bdb, cmd.Cmd):
except KeyboardInterrupt:
self.message('--KeyboardInterrupt--')
def _validate_file_mtime(self):
"""Check if the source file of the current frame has been modified since
the last time we saw it. If so, give a warning."""
try:
filename = self.curframe.f_code.co_filename
mtime = os.path.getmtime(filename)
except Exception:
return
if (filename in self._file_mtime_table and
mtime != self._file_mtime_table[filename]):
self.message(f"*** WARNING: file '{filename}' was edited, "
"running stale code until the program is rerun")
self._file_mtime_table[filename] = mtime
# Called before loop, handles display expressions
# Set up convenience variable containers
def preloop(self):
@ -681,6 +697,7 @@ class Pdb(bdb.Bdb, cmd.Cmd):
a breakpoint command list definition.
"""
if not self.commands_defining:
self._validate_file_mtime()
return cmd.Cmd.onecmd(self, line)
else:
return self.handle_command_def(line)
@ -2021,6 +2038,10 @@ class Pdb(bdb.Bdb, cmd.Cmd):
__main__.__dict__.clear()
__main__.__dict__.update(target.namespace)
# Clear the mtime table for program reruns, assume all the files
# are up to date.
self._file_mtime_table.clear()
self.run(target.code)
def _format_exc(self, exc: BaseException):