Skip to content

bpo-22577: in pdb, prevent changes to locals from being lost after a jump #11041

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
scotchka wants to merge 6 commits into from
Closed

bpo-22577: in pdb, prevent changes to locals from being lost after a jump #11041

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2a205b3
bpo-22577: in pdb, prevent changes to locals from being lost after a …
scotchka Dec 9, 2018
45103df
NEWS item added
scotchka Dec 9, 2018
ce391fc
regression test to ensure local variable change persists
scotchka Dec 9, 2018
c6f365b
undo change that caused regression error
scotchka Jan 10, 2019
9307a4e
project curframe_locals from jump by saving and restoring
scotchka Jan 10, 2019
e7a668f
move save/restore of locals to print_stack_entry to eliminate side ef…
scotchka Jan 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Lib/pdb.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1449,9 +1449,18 @@ def print_stack_entry(self, frame_lineno, prompt_prefix=line_prefix):
prefix = '> '
else:
prefix = ' '

# Save copy of curframe_locals because format_stack_entry
# causes a .f_locals access
curframe_locals_copy = dict(self.curframe_locals)

self.message(prefix +
self.format_stack_entry(frame_lineno, prompt_prefix))

# Restore from copy
self.curframe_locals.clear()
self.curframe_locals.update(curframe_locals_copy)

# Provide help

def do_help(self, arg):
Expand Down
46 changes: 46 additions & 0 deletions Lib/test/test_pdb.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1144,6 +1144,52 @@ def test_pdb_issue_20766():
pdb 2: <built-in function default_int_handler>
"""

def test_issue22577():
"""Test that local variable change not lost after jump.

>>> def test_function(x):
... import pdb; pdb.Pdb(nosigint=True, readrc=False).set_trace()
... lineno = 3
... lineno = 4

>>> with PdbTestInput(['x = 123',
... 'jump 4',
... 'x',
... 'continue']):
... test_function(1)
> <doctest test.test_pdb.test_issue22577[0]>(3)test_function()
-> lineno = 3
(Pdb) x = 123
(Pdb) jump 4
> <doctest test.test_pdb.test_issue22577[0]>(4)test_function()
-> lineno = 4
(Pdb) x
123
(Pdb) continue
"""

def test_local_variable_change():
"""Test that local variable change persists after step.

>>> def test_function(x):
... import pdb; pdb.Pdb(nosigint=True, readrc=False).set_trace()
... print(x)

>>> with PdbTestInput(['x = 123',
... 'step',
... 'continue']):
... test_function(1)
> <doctest test.test_pdb.test_local_variable_change[0]>(3)test_function()
-> print(x)
(Pdb) x = 123
(Pdb) step
123
--Return--
> <doctest test.test_pdb.test_local_variable_change[0]>(3)test_function()->None
-> print(x)
(Pdb) continue
"""


class PdbTestCase(unittest.TestCase):
def tearDown(self):
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2018-12-08-20-24-07.bpo-22577.5ggVNs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fix the loss of changes to local variables after a jump command in a PDB
session. Patch by Henry Chen.