Extend the example to plt.plot and plt.errorbar

efiring · efiring · commit 91f55475fddd · 2015-02-07T21:22:53.000-10:00
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -214,6 +214,31 @@ def _forward_ilshift(self, other):
         'numpy %s or later is required; you have %s' % (
             __version__numpy__, numpy.__version__))
 
+import functools
+def _interactive(func):
+    """
+    Decorator for Figure and Axes methods that will be wrapped in pyplot.
+
+    Methods so decorated no longer need a call to `draw_if_interactive`
+    in their pyplot wrappers, and are interactive when invoked as
+    methods with a gui backend in interactive mode.
+
+    Figure and Axes must define the methods `check_interactive`,
+    `draw_if_interactive`, and `clear_interactive` used in this
+    decorator.
+    """
+    @functools.wraps(func)
+    def inner(self, *args, **kw):
+        outer = self.check_interactive()
+        drawn = True  # default in "finally" clause is to clear.
+        try:
+            ret = func(self, *args, **kw)
+            drawn = self.draw_if_interactive(outer)
+        finally:
+            self.clear_interactive(drawn)
+        return ret
+    return inner
+
 
 def _is_writable_dir(p):
     """
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -40,6 +40,9 @@
 from matplotlib.axes._base import _AxesBase
 from matplotlib.axes._base import _process_plot_format
 
+from matplotlib import _interactive  # decorator
+
+
 iterable = cbook.iterable
 is_string_like = cbook.is_string_like
 is_sequence_of_strings = cbook.is_sequence_of_strings
@@ -1234,6 +1237,7 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
         return colls
 
     #### Basic plotting
+    @_interactive
     @docstring.dedent_interpd
     def plot(self, *args, **kwargs):
         """
@@ -2529,6 +2533,7 @@ def pie(self, x, explode=None, labels=None, colors=None,
         else:
             return slices, texts, autotexts
 
+    @_interactive
     @docstring.dedent_interpd
     def errorbar(self, x, y, yerr=None, xerr=None,
                  fmt='', ecolor=None, elinewidth=None, capsize=3,
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -32,9 +32,10 @@
 import matplotlib.image as mimage
 from matplotlib.artist import allow_rasterization
 
-
 from matplotlib.cbook import iterable
 
+from matplotlib import is_interactive
+
 
 is_string_like = cbook.is_string_like
 is_sequence_of_strings = cbook.is_sequence_of_strings
@@ -442,6 +443,7 @@ def __init__(self, fig, rect,
         self.set_cursor_props((1, 'k'))  # set the cursor properties for axes
 
         self._cachedRenderer = None
+        self._in_outer_method = False
         self.set_navigate(True)
         self.set_navigate_mode(None)
 
@@ -461,6 +463,40 @@ def __init__(self, fig, rect,
             self._ycid = self.yaxis.callbacks.connect('units finalize',
                                                       self.relim)
 
+
+    def draw_if_interactive(self, outer=False):
+        print("entering draw_if_interactive in axes/_base, outer = ", outer)
+        # Not sure whether this should be public or private...
+        if not outer or not is_interactive():
+            return False
+        # Leave out the following check for now; it probably
+        # has to be modified so that it does not require importing
+        # all the available interactive backends just to make
+        # the list of canvases.  Instead, the check could be based
+        # on the str() or (repr) of self.canvas.
+        #if not isinstance(self.canvas, interactive_canvases):
+        #    return
+        self.figure.canvas.draw()
+        print("drawing complete in axes/_base")
+        return True
+
+    def check_interactive(self):
+        """
+        Return True upon entering an outer method, and set the
+        flag; return False if already in an outer method.
+        """
+        if not self._in_outer_method:
+            self._in_outer_method = True
+            print("checking: toggled _in_outer_method to True")
+            return True
+        print("checking: already _in_outer_method; returning False")
+        return False
+
+    def clear_interactive(self, drawn):
+        if drawn:
+            self._in_outer_method = False
+
+
     def __setstate__(self, state):
         self.__dict__ = state
         # put the _remove_method back on all artists contained within the axes
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -24,7 +24,9 @@
 from matplotlib import rcParams
 from matplotlib import docstring
 from matplotlib import __version__ as _mpl_version
+
 from matplotlib import is_interactive
+from matplotlib import _interactive  # decorator
 
 import matplotlib.artist as martist
 from matplotlib.artist import Artist, allow_rasterization
@@ -234,20 +236,6 @@ def _update_this(self, s, val):
 
         setattr(self, s, val)
 
-import functools
-def _interactive(func):
-    @functools.wraps(func)
-    def inner(self, *args, **kw):
-        outer = self.check_interactive()
-        drawn = True  # default in "finally" clause is to clear.
-        try:
-            ret = func(self, *args, **kw)
-            drawn = self.draw_if_interactive(outer)
-        finally:
-            self.clear_interactive(drawn)
-        return ret
-    return inner
-
 class Figure(Artist):
 
     """
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -2761,7 +2761,7 @@ def errorbar(x, y, yerr=None, xerr=None, fmt='', ecolor=None, elinewidth=None,
                           barsabove=barsabove, lolims=lolims, uplims=uplims,
                           xlolims=xlolims, xuplims=xuplims,
                           errorevery=errorevery, capthick=capthick, **kwargs)
-        draw_if_interactive()
+        #draw_if_interactive()
     finally:
         ax.hold(washold)
 
@@ -3095,7 +3095,7 @@ def plot(*args, **kwargs):
         ax.hold(hold)
     try:
         ret = ax.plot(*args, **kwargs)
-        draw_if_interactive()
+        #draw_if_interactive()
     finally:
         ax.hold(washold)
 
