Skip to content
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.

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

Backport PR #25097 on branch v3.7.x (fix FigureCanvasTkAgg memory leak via weakrefs) #25170

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 22 additions & 2 deletions lib/matplotlib/backends/_backend_tk.py
@@ -1,4 +1,5 @@
import uuid
import weakref
from contextlib import contextmanager
import logging
import math
Expand Down Expand Up @@ -198,14 +199,33 @@ def __init__(self, figure=None, master=None):
# event to the window containing the canvas instead.
# See https://wiki.tcl-lang.org/3893 (mousewheel) for details
root = self._tkcanvas.winfo_toplevel()
root.bind("<MouseWheel>", self.scroll_event_windows, "+")

# Prevent long-lived references via tkinter callback structure GH-24820
weakself = weakref.ref(self)
weakroot = weakref.ref(root)

def scroll_event_windows(event):
self = weakself()
if self is None:
root = weakroot()
if root is not None:
root.unbind("<MouseWheel>", scroll_event_windows_id)
return
return self.scroll_event_windows(event)
scroll_event_windows_id = root.bind("<MouseWheel>", scroll_event_windows, "+")

# Can't get destroy events by binding to _tkcanvas. Therefore, bind
# to the window and filter.
def filter_destroy(event):
self = weakself()
if self is None:
root = weakroot()
if root is not None:
root.unbind("<Destroy>", filter_destroy_id)
return
if event.widget is self._tkcanvas:
CloseEvent("close_event", self)._process()
root.bind("<Destroy>", filter_destroy, "+")
filter_destroy_id = root.bind("<Destroy>", filter_destroy, "+")

self._tkcanvas.focus_set()

Expand Down