Merge pull request #7451 from tacaswell/fix_infinite_redraw_loop

efiring · web-flow · commit 08eccfb9c07d · 2016-11-23T15:23:11.000-10:00
API/FIX: mark figure as not stale on draw attempt
diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -155,6 +155,15 @@ where "ax" is an ``Axes3d`` object created with something like ::
    ax = plt.sublot(111, projection='3d')
 
 
+Stale figure behavior
+---------------------
+
+Attempting to draw the figure will now mark it as not stale (independent if
+the draw succeeds).  This change is to prevent repeatedly trying to re-draw a
+figure which is raising an error on draw.  The previous behavior would only mark
+a figure as not stale after a full re-draw succeeded.
+
+
 Changes in 1.5.3
 ================
 
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1091,19 +1091,6 @@ def draw(self, renderer):
         if not self.get_visible():
             return
 
-        renderer.open_group('figure')
-        # prevent triggering call backs during the draw process
-        self._stale = True
-        if self.get_tight_layout() and self.axes:
-            try:
-                self.tight_layout(renderer, **self._tight_parameters)
-            except ValueError:
-                pass
-                # ValueError can occur when resizing a window.
-
-        if self.frameon:
-            self.patch.draw(renderer)
-
         # a list of (zorder, func_to_call, list_of_args)
         dsu = []
 
@@ -1133,11 +1120,24 @@ def draw(self, renderer):
         dsu = [row for row in dsu if not row[1].get_animated()]
         dsu.sort(key=itemgetter(0))
 
-        mimage._draw_list_compositing_images(
-            renderer, self, dsu, self.suppressComposite)
+        try:
+            renderer.open_group('figure')
+            if self.get_tight_layout() and self.axes:
+                try:
+                    self.tight_layout(renderer, **self._tight_parameters)
+                except ValueError:
+                    pass
+                    # ValueError can occur when resizing a window.
+
+            if self.frameon:
+                self.patch.draw(renderer)
+
+            mimage._draw_list_compositing_images(
+                renderer, self, dsu, self.suppressComposite)
 
-        renderer.close_group('figure')
-        self.stale = False
+            renderer.close_group('figure')
+        finally:
+            self.stale = False
 
         self._cachedRenderer = renderer
         self.canvas.draw_event(renderer)
