FIX: Handle AxesWidget cleanup after failed init #30935
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
QuLogic
reviewed
Jan 6, 2026
larrybradley
force-pushed
the
fix-axeswidget-del
branch
from
d65638e to
5bc69c9
Compare
timhoffm
reviewed
Jan 7, 2026
timhoffm
reviewed
Jan 8, 2026
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
timhoffm
approved these changes
Jan 8, 2026
Contributor
|
Maybe instead of defining diff --git i/lib/matplotlib/widgets.py w/lib/matplotlib/widgets.py
index 5e87abe08d..9418794dcf 100644
--- i/lib/matplotlib/widgets.py
+++ w/lib/matplotlib/widgets.py
@@ -120,16 +120,6 @@ class AxesWidget(Widget):
self._cids = []
self._blit_background_id = None
- def __del__(self):
- blit_background_id = getattr(self, '_blit_background_id', None)
- # __del__ may be called on a partially initialized object, e.g.,
- # when __init__ raises. Therefore, we handle missing attributes
- # gracefully.
- if blit_background_id is not None:
- canvas = getattr(self, 'canvas', None)
- if canvas is not None:
- canvas._release_blit_background_id(blit_background_id)
-
canvas = property(
lambda self: getattr(self.ax.get_figure(root=True), 'canvas', None)
)
@@ -170,7 +160,10 @@ class AxesWidget(Widget):
good enough for all existing widgets.
"""
if self._blit_background_id is None:
- self._blit_background_id = self.canvas._get_blit_background_id()
+ bbid = self.canvas._get_blit_background_id()
+ import weakref
+ weakref.finalize(self, self.canvas._release_blit_background_id, bbid)
+ self._blit_background_id = bbid
self.canvas._blit_backgrounds[self._blit_background_id] = background
def _load_blit_background(self):? |
Contributor
Author
Contributor
|
If my patch works as is (well, moving the import to where it should be) I'd rather have that in directly, otherwise it can be punted. |
Contributor
Author
|
@anntzer OK, thanks. I've updated this PR with your suggested fix. The test passes. |
larrybradley
force-pushed
the
fix-axeswidget-del
branch
from
668304d to
eeb61a5
Compare
larrybradley
force-pushed
the
fix-axeswidget-del
branch
from
eeb61a5 to
b60db73
Compare
Contributor
|
Looks like the pyi file needs to be updated for the removal of |
Contributor
Author
|
@anntzer Fixed, thanks! |
timhoffm
approved these changes
Jan 24, 2026
QuLogic
approved these changes
Jan 24, 2026
llohse
pushed a commit
to llohse/matplotlib
that referenced
this pull request
Feb 3, 2026
* FIX: Handle AxesWidget cleanup after failed init * Apply code review suggestions * Update lib/matplotlib/tests/test_widgets.py Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> * Remove __del__ method * Remove AxesWidget.__del__ from widgets.pyi --------- Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
llohse
pushed a commit
to llohse/matplotlib
that referenced
this pull request
Feb 3, 2026
* FIX: Handle AxesWidget cleanup after failed init * Apply code review suggestions * Update lib/matplotlib/tests/test_widgets.py Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> * Remove __del__ method * Remove AxesWidget.__del__ from widgets.pyi --------- Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
llohse
pushed a commit
to llohse/matplotlib
that referenced
this pull request
Feb 3, 2026
* FIX: Handle AxesWidget cleanup after failed init * Apply code review suggestions * Update lib/matplotlib/tests/test_widgets.py Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> * Remove __del__ method * Remove AxesWidget.__del__ from widgets.pyi --------- Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR summary
In 3.11.0.dev,
AxesWidget.__del__is called on partially constructed selectors when__init__raises early (e.g.,EllipseSelector(ax, foo="bar")with an invalid kwarg). Because__init__never runs, attributes like_blit_background_idandcanvasare not set, so__del__givesException ignored while calling deallocator <function AxesWidget.__del__ at 0x108598b40>:and raises anAttributeErrorduring garbage collection. This surfaces asPytestUnraisableExceptionWarningin tests in downstream packages.See, e.g., https://github.com/astropy/regions/actions/runs/20730257507/job/59516157314
This bug was introduced in #30591.
Minimal example (also added as a regression test):
PR checklist