Skip to content

gh-75666: Fix a reference leak in tkinter event bindings #151808

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

Open
serhiy-storchaka wants to merge 1 commit into
base: main
Choose a base branch
from
+32 −15
Open

gh-75666: Fix a reference leak in tkinter event bindings #151808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions Lib/idlelib/idle_test/test_iomenu.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,10 @@ def setUpClass(cls):
cls.root = Tk()
cls.root.withdraw()
cls.editwin = EditorWindow(root=cls.root)
cls.io = iomenu.IOBinding(cls.editwin)
cls.io = cls.editwin.io

@classmethod
def tearDownClass(cls):
cls.io.close()
cls.editwin._close()
del cls.editwin
cls.root.update_idletasks()
Expand Down
18 changes: 10 additions & 8 deletions Lib/test/test_tkinter/test_misc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1486,6 +1486,8 @@ def test3(e): pass
self.assertNotIn(funcid, script)
self.assertNotIn(funcid2, script)
self.assertIn(funcid3, script)
self.assertCommandNotExist(funcid)
self.assertCommandNotExist(funcid2)
self.assertCommandExist(funcid3)

def test_bind_class(self):
Expand Down Expand Up @@ -1530,8 +1532,8 @@ def test2(e): pass
unbind_class('Test', event)
self.assertEqual(bind_class('Test', event), '')
self.assertEqual(bind_class('Test'), ())
self.assertCommandExist(funcid)
self.assertCommandExist(funcid2)
self.assertCommandNotExist(funcid)
self.assertCommandNotExist(funcid2)

unbind_class('Test', event) # idempotent

Expand Down Expand Up @@ -1559,8 +1561,8 @@ def test3(e): pass
self.assertNotIn(funcid, script)
self.assertNotIn(funcid2, script)
self.assertIn(funcid3, script)
self.assertCommandExist(funcid)
self.assertCommandExist(funcid2)
self.assertCommandNotExist(funcid)
self.assertCommandNotExist(funcid2)
self.assertCommandExist(funcid3)

def test_bind_all(self):
Expand Down Expand Up @@ -1602,8 +1604,8 @@ def test2(e): pass
unbind_all(event)
self.assertEqual(bind_all(event), '')
self.assertNotIn(event, bind_all())
self.assertCommandExist(funcid)
self.assertCommandExist(funcid2)
self.assertCommandNotExist(funcid)
self.assertCommandNotExist(funcid2)

unbind_all(event) # idempotent

Expand Down Expand Up @@ -1631,8 +1633,8 @@ def test3(e): pass
self.assertNotIn(funcid, script)
self.assertNotIn(funcid2, script)
self.assertIn(funcid3, script)
self.assertCommandExist(funcid)
self.assertCommandExist(funcid2)
self.assertCommandNotExist(funcid)
self.assertCommandNotExist(funcid2)
self.assertCommandExist(funcid3)

def _test_tag_bind(self, w):
Expand Down
24 changes: 19 additions & 5 deletions Lib/tkinter/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1503,13 +1503,26 @@ def bindtags(self, tagList=None):
else:
self.tk.call('bindtags', self._w, tagList)

def _bind(self, what, sequence, func, add, needcleanup=1):
def _delete_bind_commands(self, *what):
lines = self.tk.call(what).split('\n')
p = re.compile(r'if \{"\[([^ ]+) .*\]" == "break"\} break')
for line in lines:
m = p.fullmatch(line)
if m:
funcid = m[1]
try:
self.deletecommand(funcid)
except TclError:
pass

def _bind(self, what, sequence, func, add):
"""Internal function."""
if isinstance(func, str):
self.tk.call(what + (sequence, func))
elif func:
funcid = self._register(func, self._substitute,
needcleanup)
if not add:
self._delete_bind_commands(*what, sequence)
funcid = self._register(func, self._substitute, needcleanup=True)
cmd = ('%sif {"[%s %s]" == "break"} break\n'
%
(add and '+' or '',
Expand Down Expand Up @@ -1575,6 +1588,7 @@ def unbind(self, sequence, funcid=None):

def _unbind(self, what, funcid=None):
if funcid is None:
self._delete_bind_commands(*what)
self.tk.call(*what, '')
else:
lines = self.tk.call(what).split('\n')
Expand All @@ -1591,7 +1605,7 @@ def bind_all(self, sequence=None, func=None, add=None):
An additional boolean parameter ADD specifies whether FUNC will
be called additionally to the other bound function or whether
it will replace the previous function. See bind for the return value."""
return self._root()._bind(('bind', 'all'), sequence, func, add, True)
return self._root()._bind(('bind', 'all'), sequence, func, add)

def unbind_all(self, sequence):
"""Unbind for all widgets for event SEQUENCE all functions."""
Expand All @@ -1605,7 +1619,7 @@ def bind_class(self, className, sequence=None, func=None, add=None):
whether it will replace the previous function. See bind for
the return value."""

return self._root()._bind(('bind', className), sequence, func, add, True)
return self._root()._bind(('bind', className), sequence, func, add)

def unbind_class(self, className, sequence):
"""Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2026-06-20-15-00-00.gh-issue-75666.Kt9xQ2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fix a reference leak in :mod:`tkinter`: the Tcl commands created for event
callbacks are now deleted when a binding is replaced or unbound.
Loading