FIX: ensure axes marked stale when added text

tacaswell · tacaswell · commit 48c028cea374 · 2015-11-16T12:23:43.000-05:00
Slightly reduced duplicate code The `_add_text` is private because this should be refactored out when we move to a single draw tree in the Axes. Closes #5476
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -609,16 +609,14 @@ def text(self, x, y, s, fontdict=None,
         else:
             t = mtext.Text(
                 x=x, y=y, text=s)
-        self._set_artist_props(t)
 
         t.update(default)
         if fontdict is not None:
             t.update(fontdict)
         t.update(kwargs)
-        self.texts.append(t)
-        t._remove_method = lambda h: self.texts.remove(h)
 
         t.set_clip_path(self.patch)
+        self._add_text(t)
         return t
 
     @docstring.dedent_interpd
@@ -674,11 +672,9 @@ def annotate(self, *args, **kwargs):
         """
         a = mtext.Annotation(*args, **kwargs)
         a.set_transform(mtransforms.IdentityTransform())
-        self._set_artist_props(a)
         if 'clip_on' in kwargs:
             a.set_clip_path(self.patch)
-        self.texts.append(a)
-        a._remove_method = lambda h: self.texts.remove(h)
+        self._add_text(a)
         return a
 
     #### Lines and spans
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1703,6 +1703,16 @@ def add_line(self, line):
         line._remove_method = lambda h: self.lines.remove(h)
         return line
 
+    def _add_text(self, txt):
+        """
+
+        """
+        self._set_artist_props(txt)
+        self.texts.append(txt)
+        txt._remove_method = lambda h: self.texts.remove(h)
+        self.stale = True
+        return txt
+
     def _update_line_limits(self, line):
         """
         Figures out the data limit of the given line, updating self.dataLim.
diff --git a/lib/matplotlib/tests/test_text.py b/lib/matplotlib/tests/test_text.py
@@ -369,3 +369,27 @@ def test_annotation_negative_fig_coords():
                 xytext=[-50, 100], textcoords='figure pixels',
                 xy=[-50, 100], xycoords='figure pixels', fontsize=32,
                 va='top')
+
+
+@cleanup
+def test_text_stale():
+    fig, (ax1, ax2) = plt.subplots(1, 2)
+    plt.draw_all()
+    assert not ax1.stale
+    assert not ax2.stale
+    assert not fig.stale
+
+    txt1 = ax1.text(.5, .5, 'aardvark')
+    assert ax1.stale
+    assert txt1.stale
+    assert fig.stale
+
+    ann1 = ax2.annotate('aardvark', xy=[.5, .5])
+    assert ax2.stale
+    assert ann1.stale
+    assert fig.stale
+
+    plt.draw_all()
+    assert not ax1.stale
+    assert not ax2.stale
+    assert not fig.stale
