Tighten/cleanup wx backend.

anntzer · anntzer · commit b7e77c4fde4f · 2020-03-27T16:38:20.000+01:00
- Deprecate get_gc, which doesn't exist in other backends, is just
  accessing the .gc attribute, and is not necessary anyways (draw_image
  gets the gc as argument, so doesn't need to get it separately).
- Inherit/cleanup more docstrings.
- Remove outdated comment.
diff --git a/doc/api/next_api_changes/deprecations.rst b/doc/api/next_api_changes/deprecations.rst
@@ -398,3 +398,7 @@ The qt4agg and qt4cairo backends are deprecated.
 
 *fontdict* and *minor* parameters of `.Axes.set_xticklabels` and `.Axes.set_yticklabels` will become keyword-only
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``RendererWx.get_gc``
+~~~~~~~~~~~~~~~~~~~~~
+This method is deprecated.  Access the ``gc`` attribute directly instead.
diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -56,9 +56,7 @@ def DEBUG_MSG(string, lvl=3, o=None):
 
 
 def error_msg_wx(msg, parent=None):
-    """
-    Signal an error condition -- in a GUI, popup a error dialog
-    """
+    """Signal an error condition with a popup error dialog."""
     dialog = wx.MessageDialog(parent=parent,
                               message=msg,
                               caption='Matplotlib backend_wx error',
@@ -240,7 +238,6 @@ def draw_image(self, gc, x, y, im):
             h = self.height
         rows, cols = im.shape[:2]
         bitmap = wx.Bitmap.FromBufferRGBA(cols, rows, im.tostring())
-        gc = self.get_gc()
         gc.select()
         gc.gfx_ctx.DrawBitmap(bitmap, int(l), int(self.height - b),
                               int(w), int(-h))
@@ -282,6 +279,7 @@ def new_gc(self):
         self.gc.unselect()
         return self.gc
 
+    @cbook.deprecated("3.3", alternative=".gc")
     def get_gc(self):
         """
         Fetch the locally cached gc.
@@ -417,7 +415,7 @@ def set_joinstyle(self, js):
         self.unselect()
 
     def get_wxcolour(self, color):
-        """Convert the given RGB(A) color to a wx.Colour."""
+        """Convert a RGB(A) color to a wx.Colour."""
         _log.debug("%s - get_wx_color()", type(self))
         if len(color) == 3:
             r, g, b = color
@@ -914,14 +912,6 @@ def _print_image(self, filename, filetype, *args, **kwargs):
         self.Refresh()
 
 
-########################################################################
-#
-# The following functions and classes are for pylab compatibility
-# mode (matplotlib.pylab) and implement figure managers, etc...
-#
-########################################################################
-
-
 class FigureFrameWx(wx.Frame):
     def __init__(self, num, fig):
         # On non-Windows platform, explicitly set the position - fix
@@ -1047,7 +1037,6 @@ class FigureManagerWx(FigureManagerBase):
         a FigureCanvasWx(wx.Panel) instance
     window : wxFrame
         a wxFrame instance - wxpython.org/Phoenix/docs/html/Frame.html
-
     """
 
     def __init__(self, canvas, num, frame):
@@ -1060,26 +1049,30 @@ def __init__(self, canvas, num, frame):
         self.toolbar = frame.GetToolBar()
 
     def show(self):
+        # docstring inherited
         self.frame.Show()
         self.canvas.draw()
         if mpl.rcParams['figure.raise_window']:
             self.frame.Raise()
 
     def destroy(self, *args):
+        # docstring inherited
         _log.debug("%s - destroy()", type(self))
         self.frame.Close()
         wxapp = wx.GetApp()
         if wxapp:
             wxapp.Yield()
 
     def get_window_title(self):
+        # docstring inherited
         return self.window.GetTitle()
 
     def set_window_title(self, title):
+        # docstring inherited
         self.window.SetTitle(title)
 
     def resize(self, width, height):
-        """Set the canvas size in pixels."""
+        # docstring inherited
         self.canvas.SetInitialSize(wx.Size(width, height))
         self.window.GetSizer().Fit(self.window)
 
