Merge pull request matplotlib#19898 from QuLogic/remove-backend-deprecations

Remove 3.3 backend deprecations

Author: timhoffm

doc/api/next_api_changes/removals/19898-ES.rst

@@ -0,0 +1,70 @@
+NavigationToolbar2._init_toolbar
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Overriding this method to initialize third-party toolbars is no longer
+supported. Instead, the toolbar should be initialized in the ``__init__``
+method of the subclass (which should call the base-class' ``__init__`` as
+appropriate).
+
+NavigationToolbar2.press and .release
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+These methods were called when pressing or releasing a mouse button, but *only*
+when an interactive pan or zoom was occurring (contrary to what the docs
+stated). They are no longer called; if you write a backend which needs to
+customize such events, please directly override
+``press_pan``/``press_zoom``/``release_pan``/``release_zoom`` instead.
+
+NavigationToolbar2QT.parent and .basedir
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+These attributes have been removed. In order to access the parent window, use
+``toolbar.canvas.parent()`` or ``toolbar.parent()``. The base directory to the
+icons is ``os.path.join(mpl.get_data_path(), "images")``.
+
+NavigationToolbar2QT.ctx
+~~~~~~~~~~~~~~~~~~~~~~~~
+This attribute has been removed.
+
+NavigationToolbar2Wx attributes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The ``prevZoomRect``, ``retinaFix``, ``savedRetinaImage``, ``wxoverlay``,
+``zoomAxes``, ``zoomStartX``, and ``zoomStartY`` attributes have been removed.
+
+Statusbar classes and attributes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The ``statusbar`` attribute of `.FigureManagerBase`,  as well as
+``backend_bases.StatusbarBase`` and all its subclasses, and ``StatusBarWx``,
+have been removed, as messages are now displayed in the toolbar instead.
+
+Backend-specific internals
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following module-level classes/variables have been removed:
+
+* ``MODIFIER_KEYS``, ``SUPER``, ``ALT``, ``CTRL``, and ``SHIFT`` of
+  :mod:`matplotlib.backends.backend_qt5agg` and
+  :mod:`matplotlib.backends.backend_qt5cairo`
+* ``backend_pgf.GraphicsContextPgf``
+* ``backend_wx.DEBUG_MSG``
+
+The following parameters have been removed:
+
+* The *dummy* parameter of `.RendererPgf`
+
+The following class attributes have been removed:
+
+* ``RendererCairo.fontweights``, ``RendererCairo.fontangles``
+* ``backend_pgf.LatexManager.latex_stdin_utf8``
+* ``backend_pgf.PdfPages.metadata``
+* ``used_characters`` of `.RendererPdf`, `.PdfFile`, and `.RendererPS`
+
+The following class methods have been removed:
+
+* ``FigureCanvasGTK3._renderer_init``
+* ``track_characters`` and ``merge_used_characters`` of `.RendererPdf`,
+  `.PdfFile`, and `.RendererPS`
+* ``RendererWx.get_gc``
+
+Stricter PDF metadata keys in PGF
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Saving metadata in PDF with the PGF backend no longer changes keys to
+lowercase. Only the canonically cased keys listed in the PDF specification (and
+the `~.backend_pgf.PdfPages` documentation) are accepted.

doc/api/prev_api_changes/api_changes_3.3.0/deprecations.rst

@@ -351,7 +351,7 @@ PGF backend cleanups
 ~~~~~~~~~~~~~~~~~~~~
 The *dummy* parameter of `.RendererPgf` is deprecated.
 
-`.GraphicsContextPgf` is deprecated (use `.GraphicsContextBase` instead).
+``GraphicsContextPgf`` is deprecated (use `.GraphicsContextBase` instead).
 
 ``set_factor`` method of :mod:`mpl_toolkits.axisartist` locators
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -575,7 +575,7 @@ This is deprecated; pass keys as a list of strings instead.
 
 Statusbar classes and attributes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The ``statusbar`` attribute of `.FigureManagerBase`, `.StatusbarBase` and all
+The ``statusbar`` attribute of `.FigureManagerBase`, ``StatusbarBase`` and all
 its subclasses, and ``StatusBarWx``, are deprecated, as messages are now
 displayed in the toolbar instead.
 

lib/matplotlib/backend_bases.py

@@ -2776,8 +2776,6 @@ class FigureManagerBase:
                 figure.canvas.manager.button_press_handler_id)
     """
 
-    statusbar = _api.deprecated("3.3")(property(lambda self: None))
-
     def __init__(self, canvas, num):
         self.canvas = canvas
         canvas.manager = self  # store a pointer to parent
@@ -2943,14 +2941,6 @@ def __init__(self, canvas):
         # This cursor will be set after the initial draw.
         self._lastCursor = cursors.POINTER
 
-        init = _api.deprecate_method_override(
-            __class__._init_toolbar, self, allow_empty=True, since="3.3",
-            addendum="Please fully initialize the toolbar in your subclass' "
-            "__init__; a fully empty _init_toolbar implementation may be kept "
-            "for compatibility with earlier versions of Matplotlib.")
-        if init:
-            init()
-
         self._id_press = self.canvas.mpl_connect(
             'button_press_event', self._zoom_pan_handler)
         self._id_release = self.canvas.mpl_connect(
@@ -3012,29 +3002,6 @@ def forward(self, *args):
         self.set_history_buttons()
         self._update_view()
 
-    @_api.deprecated("3.3", alternative="__init__")
-    def _init_toolbar(self):
-        """
-        This is where you actually build the GUI widgets (called by
-        __init__).  The icons ``home.xpm``, ``back.xpm``, ``forward.xpm``,
-        ``hand.xpm``, ``zoom_to_rect.xpm`` and ``filesave.xpm`` are standard
-        across backends (there are ppm versions in CVS also).
-
-        You just need to set the callbacks
-
-        home         : self.home
-        back         : self.back
-        forward      : self.forward
-        hand         : self.pan
-        zoom_to_rect : self.zoom
-        filesave     : self.save_figure
-
-        You only need to define the last one - the others are in the base
-        class implementation.
-
-        """
-        raise NotImplementedError
-
     def _update_cursor(self, event):
         """
         Update the cursor after a mouse move event or a tool (de)activation.
@@ -3116,14 +3083,6 @@ def _zoom_pan_handler(self, event):
             elif event.name == "button_release_event":
                 self.release_zoom(event)
 
-    @_api.deprecated("3.3")
-    def press(self, event):
-        """Called whenever a mouse button is pressed."""
-
-    @_api.deprecated("3.3")
-    def release(self, event):
-        """Callback for mouse button release."""
-
     def pan(self, *args):
         """
         Toggle the pan/zoom tool.
@@ -3159,12 +3118,6 @@ def press_pan(self, event):
         id_drag = self.canvas.mpl_connect("motion_notify_event", self.drag_pan)
         self._pan_info = self._PanInfo(
             button=event.button, axes=axes, cid=id_drag)
-        press = _api.deprecate_method_override(
-            __class__.press, self, since="3.3", message="Calling an "
-            "overridden press() at pan start is deprecated since %(since)s "
-            "and will be removed %(removal)s; override press_pan() instead.")
-        if press is not None:
-            press(event)
 
     def drag_pan(self, event):
         """Callback for dragging in pan/zoom mode."""
@@ -3183,12 +3136,6 @@ def release_pan(self, event):
             'motion_notify_event', self.mouse_move)
         for ax in self._pan_info.axes:
             ax.end_pan()
-        release = _api.deprecate_method_override(
-            __class__.press, self, since="3.3", message="Calling an "
-            "overridden release() at pan stop is deprecated since %(since)s "
-            "and will be removed %(removal)s; override release_pan() instead.")
-        if release is not None:
-            release(event)
         self._draw()
         self._pan_info = None
         self.push_current()
@@ -3223,12 +3170,6 @@ def press_zoom(self, event):
         self._zoom_info = self._ZoomInfo(
             direction="in" if event.button == 1 else "out",
             start_xy=(event.x, event.y), axes=axes, cid=id_zoom)
-        press = _api.deprecate_method_override(
-            __class__.press, self, since="3.3", message="Calling an "
-            "overridden press() at zoom start is deprecated since %(since)s "
-            "and will be removed %(removal)s; override press_zoom() instead.")
-        if press is not None:
-            press(event)
 
     def drag_zoom(self, event):
         """Callback for dragging in zoom mode."""
@@ -3259,13 +3200,6 @@ def release_zoom(self, event):
                 or (abs(event.y - start_y) < 5 and event.key != "x")):
             self._draw()
             self._zoom_info = None
-            release = _api.deprecate_method_override(
-                __class__.press, self, since="3.3", message="Calling an "
-                "overridden release() at zoom stop is deprecated since "
-                "%(since)s and will be removed %(removal)s; override "
-                "release_zoom() instead.")
-            if release is not None:
-                release(event)
             return
 
         for i, ax in enumerate(self._zoom_info.axes):
@@ -3283,14 +3217,6 @@ def release_zoom(self, event):
         self._zoom_info = None
         self.push_current()
 
-        release = _api.deprecate_method_override(
-            __class__.release, self, since="3.3", message="Calling an "
-            "overridden release() at zoom stop is deprecated since %(since)s "
-            "and will be removed %(removal)s; override release_zoom() "
-            "instead.")
-        if release is not None:
-            release(event)
-
     def push_current(self):
         """Push the current view limits and position onto the stack."""
         self._nav_stack.push(
@@ -3524,29 +3450,6 @@ def set_message(self, s):
         raise NotImplementedError
 
 
-@_api.deprecated("3.3")
-class StatusbarBase:
-    """Base class for the statusbar."""
-    def __init__(self, toolmanager):
-        self.toolmanager = toolmanager
-        self.toolmanager.toolmanager_connect('tool_message_event',
-                                             self._message_cbk)
-
-    def _message_cbk(self, event):
-        """Capture the 'tool_message_event' and set the message."""
-        self.set_message(event.message)
-
-    def set_message(self, s):
-        """
-        Display a message on toolbar or in status bar.
-
-        Parameters
-        ----------
-        s : str
-            Message text.
-        """
-
-
 class _Backend:
     # A backend can be defined by using the following pattern:
     #

lib/matplotlib/backends/_backend_pdf_ps.py

@@ -5,7 +5,6 @@
 import functools
 
 import matplotlib as mpl
-from matplotlib import _api
 from .. import font_manager, ft2font
 from ..afm import AFM
 from ..backend_bases import RendererBase
@@ -28,15 +27,6 @@ class CharacterTracker:
     def __init__(self):
         self.used = {}
 
-    @_api.deprecated("3.3")
-    @property
-    def used_characters(self):
-        d = {}
-        for fname, chars in self.used.items():
-            realpath, stat_key = mpl.cbook.get_realpath_and_stat(fname)
-            d[stat_key] = (realpath, chars)
-        return d
-
     def track(self, font, s):
         """Record that string *s* is being typeset using font *font*."""
         if isinstance(font, str):

lib/matplotlib/backends/_backend_tk.py

@@ -15,7 +15,7 @@
 from matplotlib import _api, backend_tools, cbook, _c_internal_utils
 from matplotlib.backend_bases import (
     _Backend, FigureCanvasBase, FigureManagerBase, NavigationToolbar2,
-    StatusbarBase, TimerBase, ToolContainerBase, cursors, _Mode)
+    TimerBase, ToolContainerBase, cursors, _Mode)
 from matplotlib._pylab_helpers import Gcf
 from matplotlib.figure import Figure
 from matplotlib.widgets import SubplotTool
@@ -771,24 +771,6 @@ def set_message(self, s):
         self._message.set(s)
 
 
-@_api.deprecated("3.3")
-class StatusbarTk(StatusbarBase, tk.Frame):
-    def __init__(self, window, *args, **kwargs):
-        StatusbarBase.__init__(self, *args, **kwargs)
-        xmin, xmax = self.toolmanager.canvas.figure.bbox.intervalx
-        height, width = 50, xmax - xmin
-        tk.Frame.__init__(self, master=window,
-                          width=int(width), height=int(height),
-                          borderwidth=2)
-        self._message = tk.StringVar(master=self)
-        self._message_label = tk.Label(master=self, textvariable=self._message)
-        self._message_label.pack(side=tk.RIGHT)
-        self.pack(side=tk.TOP, fill=tk.X)
-
-    def set_message(self, s):
-        self._message.set(s)
-
-
 class SaveFigureTk(backend_tools.SaveFigureBase):
     def trigger(self, *args):
         NavigationToolbar2Tk.save_figure(

lib/matplotlib/backends/backend_cairo.py

@@ -123,8 +123,6 @@ def attr(field):
 
 
 class RendererCairo(RendererBase):
-    fontweights = _api.deprecated("3.3")(property(lambda self: {*_f_weights}))
-    fontangles = _api.deprecated("3.3")(property(lambda self: {*_f_angles}))
     mathtext_parser = _api.deprecated("3.4")(
         property(lambda self: MathTextParser('Cairo')))
 

lib/matplotlib/backends/backend_gtk3.py

@@ -9,7 +9,7 @@
 from matplotlib._pylab_helpers import Gcf
 from matplotlib.backend_bases import (
     _Backend, FigureCanvasBase, FigureManagerBase, NavigationToolbar2,
-    StatusbarBase, TimerBase, ToolContainerBase, cursors)
+    TimerBase, ToolContainerBase, cursors)
 from matplotlib.figure import Figure
 from matplotlib.widgets import SubplotTool
 
@@ -133,19 +133,6 @@ def __init__(self, figure=None):
         style_ctx.add_provider(css, Gtk.STYLE_PROVIDER_PRIORITY_APPLICATION)
         style_ctx.add_class("matplotlib-canvas")
 
-        renderer_init = _api.deprecate_method_override(
-            __class__._renderer_init, self, allow_empty=True, since="3.3",
-            addendum="Please initialize the renderer, if needed, in the "
-            "subclass' __init__; a fully empty _renderer_init implementation "
-            "may be kept for compatibility with earlier versions of "
-            "Matplotlib.")
-        if renderer_init:
-            renderer_init()
-
-    @_api.deprecated("3.3", alternative="__init__")
-    def _renderer_init(self):
-        pass
-
     def destroy(self):
         #Gtk.DrawingArea.destroy(self)
         self.close_event()
@@ -443,9 +430,6 @@ def resize(self, width, height):
 
 
 class NavigationToolbar2GTK3(NavigationToolbar2, Gtk.Toolbar):
-    ctx = _api.deprecated("3.3")(property(
-        lambda self: self.canvas.get_property("window").cairo_create()))
-
     def __init__(self, canvas, window):
         self.win = window
         GObject.GObject.__init__(self)
@@ -666,18 +650,6 @@ def set_message(self, s):
         self._message.set_label(s)
 
 
-@_api.deprecated("3.3")
-class StatusbarGTK3(StatusbarBase, Gtk.Statusbar):
-    def __init__(self, *args, **kwargs):
-        StatusbarBase.__init__(self, *args, **kwargs)
-        Gtk.Statusbar.__init__(self)
-        self._context = self.get_context_id('message')
-
-    def set_message(self, s):
-        self.pop(self._context)
-        self.push(self._context, s)
-
-
 class RubberbandGTK3(backend_tools.RubberbandBase):
     def draw_rubberband(self, x0, y0, x1, y1):
         NavigationToolbar2GTK3.draw_rubberband(