Ensure that all toolbar (old/new) subclasses can be init'ed consistently

i.e. with the same signature: with `canvas` as sole arg for the
old-style toolbars, with `toolmanager` as sole arg for the new ones.

Subclasses that explicitly support setting a parent widget keep that
support (except for gtk, which stashed that in the `.win` attribute but
never used it), but that argument is always optional now; the default is
the canvas' parent.

The goal is to later replace all _get_toolbar implementations by a
simple call (always with the same signature (dependent on the value of
rcParams["toolbar"])) to the correct class in the FigureManagerBase
constructor.

Author: anntzer

doc/api/next_api_changes/deprecations/22021-AL.rst

@@ -0,0 +1,9 @@
+``NavigationToolbar2GTK3`` window
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The *window* parameter to ``NavigationToolbar2GTK3`` had no effect, and is now
+deprecated; likewise, the ``win`` attribute is deprecated.
+
+``NavigationToolbar2Tk`` window
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The *window* attribute to ``NavigationToolbar2GTK3`` is deprecated.  Use
+``toolbar.master`` instead.

lib/matplotlib/backends/_backend_tk.py

@@ -432,9 +432,9 @@ def __init__(self, canvas, num, window):
 
     def _get_toolbar(self):
         if mpl.rcParams['toolbar'] == 'toolbar2':
-            toolbar = NavigationToolbar2Tk(self.canvas, self.window)
+            toolbar = NavigationToolbar2Tk(self.canvas)
         elif mpl.rcParams['toolbar'] == 'toolmanager':
-            toolbar = ToolbarTk(self.toolmanager, self.window)
+            toolbar = ToolbarTk(self.toolmanager)
         else:
             toolbar = None
         return toolbar
@@ -506,24 +506,26 @@ def full_screen_toggle(self):
 
 
 class NavigationToolbar2Tk(NavigationToolbar2, tk.Frame):
-    """
-    Attributes
-    ----------
-    canvas : `FigureCanvas`
-        The figure canvas on which to operate.
-    win : tk.Window
-        The tk.Window which owns this toolbar.
-    pack_toolbar : bool, default: True
-        If True, add the toolbar to the parent's pack manager's packing list
-        during initialization with ``side='bottom'`` and ``fill='x'``.
-        If you want to use the toolbar with a different layout manager, use
-        ``pack_toolbar=False``.
-    """
-    def __init__(self, canvas, window, *, pack_toolbar=True):
-        # Avoid using self.window (prefer self.canvas.get_tk_widget().master),
-        # so that Tool implementations can reuse the methods.
-        self.window = window
+    window = _api.deprecated("3.6", alternative="self.master")(
+        property(lambda self: self.master))
+
+    def __init__(self, canvas, window=None, *, pack_toolbar=True):
+        """
+        Parameters
+        ----------
+        canvas : `FigureCanvas`
+            The figure canvas on which to operate.
+        window : tk.Window
+            The tk.Window which owns this toolbar.
+        pack_toolbar : bool, default: True
+            If True, add the toolbar to the parent's pack manager's packing
+            list during initialization with ``side="bottom"`` and ``fill="x"``.
+            If you want to use the toolbar with a different layout manager, use
+            ``pack_toolbar=False``.
+        """
 
+        if window is None:
+            window = canvas.get_tk_widget().master
         tk.Frame.__init__(self, master=window, borderwidth=2,
                           width=int(canvas.figure.bbox.width), height=50)
 
@@ -809,8 +811,10 @@ def set_cursor(self, cursor):
 
 
 class ToolbarTk(ToolContainerBase, tk.Frame):
-    def __init__(self, toolmanager, window):
+    def __init__(self, toolmanager, window=None):
         ToolContainerBase.__init__(self, toolmanager)
+        if window is None:
+            window = self.toolmanager.canvas.get_tk_widget().master
         xmin, xmax = self.toolmanager.canvas.figure.bbox.intervalx
         height, width = 50, xmax - xmin
         tk.Frame.__init__(self, master=window,

lib/matplotlib/backends/backend_gtk3.py

@@ -393,7 +393,7 @@ def _get_toolbar(self):
         # must be inited after the window, drawingArea and figure
         # attrs are set
         if mpl.rcParams['toolbar'] == 'toolbar2':
-            toolbar = NavigationToolbar2GTK3(self.canvas, self.window)
+            toolbar = NavigationToolbar2GTK3(self.canvas)
         elif mpl.rcParams['toolbar'] == 'toolmanager':
             toolbar = ToolbarGTK3(self.toolmanager)
         else:
@@ -425,8 +425,9 @@ def resize(self, width, height):
 
 
 class NavigationToolbar2GTK3(_NavigationToolbar2GTK, Gtk.Toolbar):
-    def __init__(self, canvas, window):
-        self.win = window
+    @_api.delete_parameter("3.6", "window")
+    def __init__(self, canvas, window=None):
+        self._win = window
         GObject.GObject.__init__(self)
 
         self.set_style(Gtk.ToolbarStyle.ICONS)
@@ -474,6 +475,8 @@ def __init__(self, canvas, window):
 
         _NavigationToolbar2GTK.__init__(self, canvas)
 
+    win = _api.deprecated("3.6")(property(lambda self: self._win))
+
     def save_figure(self, *args):
         dialog = Gtk.FileChooserDialog(
             title="Save the figure",

lib/matplotlib/backends/backend_gtk4.py

@@ -339,7 +339,7 @@ def _get_toolbar(self):
         # must be inited after the window, drawingArea and figure
         # attrs are set
         if mpl.rcParams['toolbar'] == 'toolbar2':
-            toolbar = NavigationToolbar2GTK4(self.canvas, self.window)
+            toolbar = NavigationToolbar2GTK4(self.canvas)
         elif mpl.rcParams['toolbar'] == 'toolmanager':
             toolbar = ToolbarGTK4(self.toolmanager)
         else:
@@ -364,8 +364,9 @@ def resize(self, width, height):
 
 
 class NavigationToolbar2GTK4(_NavigationToolbar2GTK, Gtk.Box):
-    def __init__(self, canvas, window):
-        self.win = window
+    @_api.delete_parameter("3.6", "window")
+    def __init__(self, canvas, window=None):
+        self._win = window
         Gtk.Box.__init__(self)
 
         self.add_css_class('toolbar')
@@ -407,6 +408,8 @@ def __init__(self, canvas, window):
 
         _NavigationToolbar2GTK.__init__(self, canvas)
 
+    win = _api.deprecated("3.6")(property(lambda self: self._win))
+
     def save_figure(self, *args):
         dialog = Gtk.FileChooserNative(
             title='Save the figure',

lib/matplotlib/backends/backend_qt.py

@@ -586,9 +586,9 @@ def _get_toolbar(self, canvas, parent):
         # must be inited after the window, drawingArea and figure
         # attrs are set
         if mpl.rcParams['toolbar'] == 'toolbar2':
-            toolbar = NavigationToolbar2QT(canvas, parent, True)
+            toolbar = NavigationToolbar2QT(canvas)
         elif mpl.rcParams['toolbar'] == 'toolmanager':
-            toolbar = ToolbarQt(self.toolmanager, self.window)
+            toolbar = ToolbarQt(self.toolmanager)
         else:
             toolbar = None
         return toolbar
@@ -637,7 +637,7 @@ class NavigationToolbar2QT(NavigationToolbar2, QtWidgets.QToolBar):
         ("Customize", "Edit axis, curve and image parameters",
          "qt4_editor_options", "edit_parameters"))
 
-    def __init__(self, canvas, parent, coordinates=True):
+    def __init__(self, canvas, parent=None, coordinates=True):
         """coordinates: should we show the coordinates on the right?"""
         QtWidgets.QToolBar.__init__(self, parent)
         self.setAllowedAreas(QtCore.Qt.ToolBarArea(
@@ -909,7 +909,7 @@ def _reset(self):
 
 
 class ToolbarQt(ToolContainerBase, QtWidgets.QToolBar):
-    def __init__(self, toolmanager, parent):
+    def __init__(self, toolmanager, parent=None):
         ToolContainerBase.__init__(self, toolmanager)
         QtWidgets.QToolBar.__init__(self, parent)
         self.setAllowedAreas(QtCore.Qt.ToolBarArea(

lib/matplotlib/backends/backend_wx.py

@@ -928,7 +928,7 @@ def _get_toolbar(self):
         if mpl.rcParams['toolbar'] == 'toolbar2':
             toolbar = NavigationToolbar2Wx(self.canvas)
         elif mpl.rcParams['toolbar'] == 'toolmanager':
-            toolbar = ToolbarWx(self.toolmanager, self)
+            toolbar = ToolbarWx(self.toolmanager)
         else:
             toolbar = None
         return toolbar
@@ -1190,7 +1190,9 @@ def set_history_buttons(self):
 # tools for matplotlib.backend_managers.ToolManager:
 
 class ToolbarWx(ToolContainerBase, wx.ToolBar):
-    def __init__(self, toolmanager, parent, style=wx.TB_BOTTOM):
+    def __init__(self, toolmanager, parent=None, style=wx.TB_BOTTOM):
+        if parent is None:
+            parent = toolmanager.canvas.GetParent()
         ToolContainerBase.__init__(self, toolmanager)
         wx.ToolBar.__init__(self, parent, -1, style=style)
         self._space = self.AddStretchableSpace()