Skip to content

Commit b81caa9

Browse files
committed
MNT: Make useblit a property in Widget classes
The goal is to skip trying to do anything with blitting when after the figure is closed a blitting-capable Canvas instance is swapped out for one that does not support blitting. closes matplotlib#30575 but in only a partial solution to the bigger issues with blitting and changing the canvas.
1 parent 9d04ff0 commit b81caa9

1 file changed

Lines changed: 40 additions & 18 deletions

File tree

‎lib/matplotlib/widgets.py‎

Lines changed: 40 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ class AxesWidget(Widget):
112112
active : bool
113113
If False, the widget does not respond to events.
114114
"""
115+
_useblit = False
115116

116117
def __init__(self, ax):
117118
self.ax = ax
@@ -121,6 +122,16 @@ def __init__(self, ax):
121122
lambda self: getattr(self.ax.get_figure(root=True), 'canvas', None)
122123
)
123124

125+
useblit = property(
126+
fget=lambda self: (
127+
self._useblit and
128+
(canvas := self.canvas) is not None and
129+
canvas.supports_blit
130+
),
131+
fset=lambda self, useblit: setattr(self, '_useblit', useblit),
132+
doc="If the user asked for blitting AND if the canvas supports it"
133+
)
134+
124135
def connect_event(self, event, callback):
125136
"""
126137
Connect a callback function with an event.
@@ -201,7 +212,7 @@ def __init__(self, ax, label, image=None,
201212
horizontalalignment='center',
202213
transform=ax.transAxes)
203214

204-
self._useblit = useblit and self.canvas.supports_blit
215+
self._useblit = useblit
205216

206217
self._observers = cbook.CallbackRegistry(signals=["clicked"])
207218

@@ -235,7 +246,7 @@ def _motion(self, event):
235246
if not colors.same_color(c, self.ax.get_facecolor()):
236247
self.ax.set_facecolor(c)
237248
if self.drawon:
238-
if self._useblit:
249+
if self.useblit:
239250
self.ax.draw_artist(self.ax)
240251
self.canvas.blit(self.ax.bbox)
241252
else:
@@ -1057,7 +1068,7 @@ def __init__(self, ax, labels, actives=None, *, useblit=True,
10571068
if actives is None:
10581069
actives = [False] * len(labels)
10591070

1060-
self._useblit = useblit and self.canvas.supports_blit
1071+
self._useblit = useblit
10611072
self._background = None
10621073

10631074
ys = np.linspace(1, 0, len(labels)+2)[1:-1]
@@ -1086,7 +1097,7 @@ def __init__(self, ax, labels, actives=None, *, useblit=True,
10861097
**cbook.normalize_kwargs(check_props, collections.PathCollection),
10871098
'marker': 'x',
10881099
'transform': ax.transAxes,
1089-
'animated': self._useblit,
1100+
'animated': self.useblit,
10901101
}
10911102
check_props.setdefault('facecolor', check_props.pop('color', 'black'))
10921103
self._checks = ax.scatter([0.15] * len(ys), ys, **check_props)
@@ -1096,7 +1107,7 @@ def __init__(self, ax, labels, actives=None, *, useblit=True,
10961107
self._init_status(actives)
10971108

10981109
self.connect_event('button_press_event', self._clicked)
1099-
if self._useblit:
1110+
if self.useblit:
11001111
self.connect_event('draw_event', self._clear)
11011112

11021113
self._observers = cbook.CallbackRegistry(signals=["clicked"])
@@ -1105,7 +1116,8 @@ def _clear(self, event):
11051116
"""Internal event handler to clear the buttons."""
11061117
if self.ignore(event) or self.canvas.is_saving():
11071118
return
1108-
self._background = self.canvas.copy_from_bbox(self.ax.bbox)
1119+
if self.useblit:
1120+
self._background = self.canvas.copy_from_bbox(self.ax.bbox)
11091121
self.ax.draw_artist(self._checks)
11101122

11111123
def _clicked(self, event):
@@ -1209,7 +1221,7 @@ def set_active(self, index, state=None):
12091221
self._checks.set_facecolor(facecolors)
12101222

12111223
if self.drawon:
1212-
if self._useblit:
1224+
if self.useblit:
12131225
if self._background is not None:
12141226
self.canvas.restore_region(self._background)
12151227
self.ax.draw_artist(self._checks)
@@ -1644,7 +1656,7 @@ def __init__(self, ax, labels, active=0, activecolor=None, *,
16441656

16451657
ys = np.linspace(1, 0, len(labels) + 2)[1:-1]
16461658

1647-
self._useblit = useblit and self.canvas.supports_blit
1659+
self._useblit = useblit
16481660
self._background = None
16491661

16501662
label_props = _expand_text_props(label_props)
@@ -1660,7 +1672,7 @@ def __init__(self, ax, labels, active=0, activecolor=None, *,
16601672
**radio_props,
16611673
'marker': 'o',
16621674
'transform': ax.transAxes,
1663-
'animated': self._useblit,
1675+
'animated': self.useblit,
16641676
}
16651677
radio_props.setdefault('edgecolor', radio_props.get('color', 'black'))
16661678
radio_props.setdefault('facecolor',
@@ -1678,7 +1690,7 @@ def __init__(self, ax, labels, active=0, activecolor=None, *,
16781690
for i, activecolor in enumerate(self._active_colors)])
16791691

16801692
self.connect_event('button_press_event', self._clicked)
1681-
if self._useblit:
1693+
if self.useblit:
16821694
self.connect_event('draw_event', self._clear)
16831695

16841696
self._observers = cbook.CallbackRegistry(signals=["clicked"])
@@ -1687,7 +1699,8 @@ def _clear(self, event):
16871699
"""Internal event handler to clear the buttons."""
16881700
if self.ignore(event) or self.canvas.is_saving():
16891701
return
1690-
self._background = self.canvas.copy_from_bbox(self.ax.bbox)
1702+
if self.useblit:
1703+
self._background = self.canvas.copy_from_bbox(self.ax.bbox)
16911704
self.ax.draw_artist(self._buttons)
16921705

16931706
def _clicked(self, event):
@@ -1779,7 +1792,7 @@ def set_active(self, index):
17791792
self._buttons.set_facecolor(button_facecolors)
17801793

17811794
if self.drawon:
1782-
if self._useblit:
1795+
if self.useblit:
17831796
if self._background is not None:
17841797
self.canvas.restore_region(self._background)
17851798
self.ax.draw_artist(self._buttons)
@@ -1930,7 +1943,7 @@ def __init__(self, ax, *, horizOn=True, vertOn=True, useblit=False,
19301943
self.visible = True
19311944
self.horizOn = horizOn
19321945
self.vertOn = vertOn
1933-
self.useblit = useblit and self.canvas.supports_blit
1946+
self._useblit = useblit
19341947

19351948
if self.useblit:
19361949
lineprops['animated'] = True
@@ -2015,6 +2028,17 @@ class MultiCursor(Widget):
20152028
--------
20162029
See :doc:`/gallery/widgets/multicursor`.
20172030
"""
2031+
_useblit = False
2032+
2033+
@property
2034+
def useblit(self):
2035+
return (
2036+
self._useblit and all(canvas.supports_blit for canvas in self._canvas_infos)
2037+
)
2038+
2039+
@useblit.setter
2040+
def useblit(self, useblit):
2041+
self._useblit = useblit
20182042

20192043
def __init__(self, canvas, axes, *, useblit=True, horizOn=False, vertOn=True,
20202044
**lineprops):
@@ -2036,9 +2060,7 @@ def __init__(self, canvas, axes, *, useblit=True, horizOn=False, vertOn=True,
20362060
ymid = 0.5 * (ymin + ymax)
20372061

20382062
self.visible = True
2039-
self.useblit = (
2040-
useblit
2041-
and all(canvas.supports_blit for canvas in self._canvas_infos))
2063+
self._useblit = useblit
20422064

20432065
if self.useblit:
20442066
lineprops['animated'] = True
@@ -2123,7 +2145,7 @@ def __init__(self, ax, onselect=None, useblit=False, button=None,
21232145
self.onselect = lambda *args: None
21242146
else:
21252147
self.onselect = onselect
2126-
self.useblit = useblit and self.canvas.supports_blit
2148+
self._useblit = useblit
21272149
self.connect_default_events()
21282150

21292151
self._state_modifier_keys = dict(move=' ', clear='escape',
@@ -4157,7 +4179,7 @@ class Lasso(AxesWidget):
41574179
def __init__(self, ax, xy, callback, *, useblit=True, props=None):
41584180
super().__init__(ax)
41594181

4160-
self.useblit = useblit and self.canvas.supports_blit
4182+
self._useblit = useblit
41614183
if self.useblit:
41624184
self.background = self.canvas.copy_from_bbox(self.ax.bbox)
41634185

0 commit comments

Comments
 (0)