Skip to content

[3.12] gh-58956: Fix a frame refleak in bdb (GH-128190) #128953

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

Merged
merged 4 commits into from
Jan 17, 2025
Merged

[3.12] gh-58956: Fix a frame refleak in bdb (GH-128190) #128953

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
58d7a18
[3.12] gh-58956: Fix a frame refleak in bdb (GH-128190)
gaogaotiantian Jan 17, 2025
056361f
Fix conflicts and remove extra tests
gaogaotiantian Jan 17, 2025
e7e5037
Clear curframe_locals
gaogaotiantian Jan 17, 2025
7121fb4
3.12 has a different breakpoint
gaogaotiantian Jan 17, 2025
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
2 changes: 2 additions & 0 deletions Lib/bdb.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,7 @@ def set_trace(self, frame=None):
self.botframe = frame
frame = frame.f_back
self.set_step()
self.enterframe = None
sys.settrace(self.trace_dispatch)

def set_continue(self):
Expand All @@ -356,6 +357,7 @@ def set_continue(self):
while frame and frame is not self.botframe:
del frame.f_trace
frame = frame.f_back
self.enterframe = None

def set_quit(self):
"""Set quitting attribute to True.
Expand Down
1 change: 1 addition & 0 deletions Lib/pdb.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,7 @@ def forget(self):
if hasattr(self, 'curframe') and self.curframe:
self.curframe.f_globals.pop('__pdb_convenience_variables', None)
self.curframe = None
self.curframe_locals = {}
self.tb_lineno.clear()

def setup(self, f, tb):
Expand Down
52 changes: 52 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 @@ -1981,6 +1981,58 @@ def test_pdb_ambiguous_statements():
(Pdb) continue
"""

def test_pdb_frame_refleak():
"""
pdb should not leak reference to frames

>>> def frame_leaker(container):
... import sys
... container.append(sys._getframe())
... import pdb; pdb.Pdb(nosigint=True, readrc=False).set_trace()
... pass

>>> def test_function():
... import gc
... container = []
... frame_leaker(container) # c
... print(len(gc.get_referrers(container[0])))
... container = []
... frame_leaker(container) # n c
... print(len(gc.get_referrers(container[0])))
... container = []
... frame_leaker(container) # r c
... print(len(gc.get_referrers(container[0])))

>>> with PdbTestInput([ # doctest: +NORMALIZE_WHITESPACE
... 'continue',
... 'next',
... 'continue',
... 'return',
... 'continue',
... ]):
... test_function()
> <doctest test.test_pdb.test_pdb_frame_refleak[0]>(5)frame_leaker()
-> pass
(Pdb) continue
1
> <doctest test.test_pdb.test_pdb_frame_refleak[0]>(5)frame_leaker()
-> pass
(Pdb) next
--Return--
> <doctest test.test_pdb.test_pdb_frame_refleak[0]>(5)frame_leaker()->None
-> pass
(Pdb) continue
1
> <doctest test.test_pdb.test_pdb_frame_refleak[0]>(5)frame_leaker()
-> pass
(Pdb) return
--Return--
> <doctest test.test_pdb.test_pdb_frame_refleak[0]>(5)frame_leaker()->None
-> pass
(Pdb) continue
1
"""

def test_pdb_issue_gh_65052():
"""See GH-65052

Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2024-12-23-02-09-44.gh-issue-58956.4OdMdT.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fixed a frame reference leak in :mod:`bdb`.
Loading