FIX: prevent recursive draws with plt.ion not in IPython with qt5agg

tacaswell · tacaswell · commit 36448e8dceea · 2017-12-31T21:50:35.000-05:00
In 9b8a944 the latch logic was moved above the call to `self.draw` to de-latch the call to `__draw_idle_agg` in `paintEvent` to protect against `blit` calls during a draw. However, this now fails to properly latch the base draw so with `plt.ion` (not in IPython) the stale callback will cause a (possibly infinite) recursion in the draw due to stale being set as part of the draw call (which will re-trigger the draw). This adds a second flag to track if we are currently rendering and bail. closes #10140
diff --git a/lib/matplotlib/backends/backend_qt5agg.py b/lib/matplotlib/backends/backend_qt5agg.py
@@ -35,6 +35,7 @@ def __init__(self, figure):
         super(FigureCanvasQTAggBase, self).__init__(figure=figure)
         self.setAttribute(QtCore.Qt.WA_OpaquePaintEvent)
         self._agg_draw_pending = False
+        self._agg_is_drawing = False
         self._bbox_queue = []
         self._drawRect = None
 
@@ -124,7 +125,14 @@ def draw(self):
         """
         # The Agg draw is done here; delaying causes problems with code that
         # uses the result of the draw() to update plot elements.
-        super(FigureCanvasQTAggBase, self).draw()
+        if self._agg_is_drawing:
+            return
+
+        self._agg_is_drawing = True
+        try:
+            super(FigureCanvasQTAggBase, self).draw()
+        finally:
+            self._agg_is_drawing = False
         self.update()
 
     def draw_idle(self):
@@ -135,7 +143,7 @@ def draw_idle(self):
         # current event loop in order to ensure thread affinity and to
         # accumulate multiple draw requests from event handling.
         # TODO: queued signal connection might be safer than singleShot
-        if not self._agg_draw_pending:
+        if not (self._agg_draw_pending or self._agg_is_drawing):
             self._agg_draw_pending = True
             QtCore.QTimer.singleShot(0, self.__draw_idle_agg)
 
@@ -146,6 +154,7 @@ def __draw_idle_agg(self, *args):
         # we have now tried this function at least once, do not run
         # again until re-armed.  Doing this here rather than after
         # protects against recursive calls triggered through self.draw
+        # The recursive call is via `repaintEvent`
         self._agg_draw_pending = False
         # if negative size, bail
         if self.height() < 0 or self.width() < 0:
