gh-125884: Support breakpoint on functions with annotations (#125892)

This commit is contained in:
Tian Gao 2024-10-23 15:04:30 -07:00 committed by GitHub
parent 13c9fa3d64
commit 8f2c0f7a03
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 42 additions and 2 deletions

View File

@ -118,7 +118,7 @@ def find_first_executable_line(code):
return code.co_firstlineno return code.co_firstlineno
def find_function(funcname, filename): def find_function(funcname, filename):
cre = re.compile(r'def\s+%s\s*[(]' % re.escape(funcname)) cre = re.compile(r'def\s+%s(\s*\[.+\])?\s*[(]' % re.escape(funcname))
try: try:
fp = tokenize.open(filename) fp = tokenize.open(filename)
except OSError: except OSError:
@ -138,9 +138,12 @@ def find_function(funcname, filename):
if funcdef: if funcdef:
try: try:
funccode = compile(funcdef, filename, 'exec').co_consts[0] code = compile(funcdef, filename, 'exec')
except SyntaxError: except SyntaxError:
continue continue
# We should always be able to find the code object here
funccode = next(c for c in code.co_consts if
isinstance(c, CodeType) and c.co_name == funcname)
lineno_offset = find_first_executable_line(funccode) lineno_offset = find_first_executable_line(funccode)
return funcname, filename, funcstart + lineno_offset - 1 return funcname, filename, funcstart + lineno_offset - 1
return None return None

View File

@ -363,6 +363,42 @@ def test_pdb_breakpoint_commands():
4 4
""" """
def test_pdb_breakpoint_on_annotated_function_def():
"""Test breakpoints on function definitions with annotation.
>>> def foo[T]():
... return 0
>>> def bar() -> int:
... return 0
>>> def foobar[T]() -> int:
... return 0
>>> reset_Breakpoint()
>>> def test_function():
... import pdb; pdb.Pdb(nosigint=True, readrc=False).set_trace()
... pass
>>> with PdbTestInput([ # doctest: +NORMALIZE_WHITESPACE
... 'break foo',
... 'break bar',
... 'break foobar',
... 'continue',
... ]):
... test_function()
> <doctest test.test_pdb.test_pdb_breakpoint_on_annotated_function_def[4]>(2)test_function()
-> import pdb; pdb.Pdb(nosigint=True, readrc=False).set_trace()
(Pdb) break foo
Breakpoint 1 at <doctest test.test_pdb.test_pdb_breakpoint_on_annotated_function_def[0]>:2
(Pdb) break bar
Breakpoint 2 at <doctest test.test_pdb.test_pdb_breakpoint_on_annotated_function_def[1]>:2
(Pdb) break foobar
Breakpoint 3 at <doctest test.test_pdb.test_pdb_breakpoint_on_annotated_function_def[2]>:2
(Pdb) continue
"""
def test_pdb_commands(): def test_pdb_commands():
"""Test the commands command of pdb. """Test the commands command of pdb.

View File

@ -0,0 +1 @@
Fixed the bug for :mod:`pdb` where it can't set breakpoints on functions with certain annotations.