Deprecate RendererBase.strip_math.

anntzer · anntzer · commit b6dc44fe77f9 · 2018-10-09T17:16:19.000+02:00
This function exists as cbook.strip_math and has no reason to be a
Renderer (static) method.
diff --git a/doc/api/api_changes/2018-10-09-AL-deprecations.rst b/doc/api/api_changes/2018-10-09-AL-deprecations.rst
@@ -0,0 +1,5 @@
+Deprecations
+````````````
+
+The ``backend_bases.RendererBase.strip_math`` method is deprecated.  Use
+`.cbook.strip_math` instead.
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -695,6 +695,7 @@ def points_to_pixels(self, points):
         """
         return points
 
+    @cbook.deprecated("3.1", alternative="cbook.strip_math")
     def strip_math(self, s):
         return cbook.strip_math(s)
 
diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -21,7 +21,6 @@
 from matplotlib.backend_bases import _has_pil
 
 from matplotlib._pylab_helpers import Gcf
-from matplotlib.cbook import is_writable_file_like, warn_deprecated
 from matplotlib.figure import Figure
 from matplotlib.path import Path
 from matplotlib.transforms import Affine2D
@@ -196,15 +195,11 @@ class RendererWx(RendererBase):
     }
 
     def __init__(self, bitmap, dpi):
-        """
-        Initialise a wxWindows renderer instance.
-        """
-        warn_deprecated('2.0', message="The WX backend is "
-                        "deprecated. It's untested "
-                        "and will be removed in Matplotlib 3.0. "
-                        "Use the WXAgg backend instead. "
-                        "See Matplotlib usage FAQ for more info on backends.",
-                        alternative='WXAgg')
+        """Initialise a wxWindows renderer instance."""
+        cbook.warn_deprecated(
+            "2.0", name="wx", obj_type="backend", removal="the future",
+            alternative="wxagg", addendum="See the Matplotlib usage FAQ for "
+            "more info on backends.")
         RendererBase.__init__(self)
         DEBUG_MSG("__init__()", 1, self)
         self.width = bitmap.GetWidth()
@@ -225,9 +220,8 @@ def get_text_width_height_descent(self, s, prop, ismath):
         get the width and height in display coords of the string s
         with FontPropertry prop
         """
-        # return 1, 1
         if ismath:
-            s = self.strip_math(s)
+            s = cbook.strip_math(s)
 
         if self.gc is None:
             gc = self.new_gc()
@@ -307,7 +301,7 @@ def draw_image(self, gc, x, y, im):
 
     def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
         if ismath:
-            s = self.strip_math(s)
+            s = cbook.strip_math(s)
         DEBUG_MSG("draw_text()", 1, self)
         gc.select()
         self.handle_clip_rectangle(gc)
@@ -1107,7 +1101,7 @@ def _print_image(self, filename, filetype, *args, **kwargs):
                 raise RuntimeError(
                     'Could not save figure to %s\n' %
                     (filename))
-        elif is_writable_file_like(filename):
+        elif cbook.is_writable_file_like(filename):
             if not isinstance(image, wx.Image):
                 image = image.ConvertToImage()
             if not image.SaveStream(filename, filetype):
