Dedupe _get_toolmanager and move it to base class init.

anntzer · anntzer · commit a19495c35202 · 2020-04-15T10:37:48.000+02:00
It's mostly simple, except specifically for the wx backend which for
some reason previously attached the toolmanager to the Frame (aka
"Window" in other toolkits parlance) so needs some properties to
redirect things to the right place.
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -46,6 +46,7 @@
     backend_tools as tools, cbook, colors, textpath, tight_bbox, transforms,
     widgets, get_backend, is_interactive, rcParams)
 from matplotlib._pylab_helpers import Gcf
+from matplotlib.backend_managers import ToolManager
 from matplotlib.transforms import Affine2D
 from matplotlib.path import Path
 
@@ -2590,7 +2591,9 @@ def __init__(self, canvas, num):
                 'button_press_event',
                 self.button_press)
 
-        self.toolmanager = None
+        self.toolmanager = (ToolManager(canvas.figure)
+                            if mpl.rcParams['toolbar'] == 'toolmanager'
+                            else None)
         self.toolbar = None
 
         @self.canvas.figure.add_axobserver
diff --git a/lib/matplotlib/backends/_backend_tk.py b/lib/matplotlib/backends/_backend_tk.py
@@ -15,7 +15,6 @@
 from matplotlib.backend_bases import (
     _Backend, FigureCanvasBase, FigureManagerBase, NavigationToolbar2,
     StatusbarBase, TimerBase, ToolContainerBase, cursors)
-from matplotlib.backend_managers import ToolManager
 from matplotlib._pylab_helpers import Gcf
 from matplotlib.figure import Figure
 from matplotlib.widgets import SubplotTool
@@ -412,9 +411,6 @@ def __init__(self, canvas, num, window):
         self.window = window
         self.window.withdraw()
         self.set_window_title("Figure %d" % num)
-        # If using toolmanager it has to be present when initializing the
-        # toolbar
-        self.toolmanager = self._get_toolmanager()
         # packing toolbar first, because if space is getting low, last packed
         # widget is getting shrunk first (-> the canvas)
         self.toolbar = self._get_toolbar()
@@ -439,13 +435,6 @@ def _get_toolbar(self):
             toolbar = None
         return toolbar
 
-    def _get_toolmanager(self):
-        if mpl.rcParams['toolbar'] == 'toolmanager':
-            toolmanager = ToolManager(self.canvas.figure)
-        else:
-            toolmanager = None
-        return toolmanager
-
     def resize(self, width, height):
         self.canvas._tkcanvas.configure(width=width, height=height)
 
diff --git a/lib/matplotlib/backends/backend_gtk3.py b/lib/matplotlib/backends/backend_gtk3.py
@@ -10,7 +10,6 @@
 from matplotlib.backend_bases import (
     _Backend, FigureCanvasBase, FigureManagerBase, NavigationToolbar2,
     StatusbarBase, TimerBase, ToolContainerBase, cursors)
-from matplotlib.backend_managers import ToolManager
 from matplotlib.figure import Figure
 from matplotlib.widgets import SubplotTool
 
@@ -343,7 +342,6 @@ def __init__(self, canvas, num):
         w = int(self.canvas.figure.bbox.width)
         h = int(self.canvas.figure.bbox.height)
 
-        self.toolmanager = self._get_toolmanager()
         self.toolbar = self._get_toolbar()
         self.statusbar = None
 
@@ -420,14 +418,6 @@ def _get_toolbar(self):
             toolbar = None
         return toolbar
 
-    def _get_toolmanager(self):
-        # must be initialised after toolbar has been set
-        if mpl.rcParams['toolbar'] == 'toolmanager':
-            toolmanager = ToolManager(self.canvas.figure)
-        else:
-            toolmanager = None
-        return toolmanager
-
     def get_window_title(self):
         return self.window.get_title()
 
diff --git a/lib/matplotlib/backends/backend_qt5.py b/lib/matplotlib/backends/backend_qt5.py
@@ -15,7 +15,6 @@
     TimerBase, cursors, ToolContainerBase, StatusbarBase, MouseButton)
 import matplotlib.backends.qt_editor.figureoptions as figureoptions
 from matplotlib.backends.qt_editor.formsubplottool import UiSubplotTool
-from matplotlib.backend_managers import ToolManager
 from . import qt_compat
 from .qt_compat import (
     QtCore, QtGui, QtWidgets, _isdeleted, is_pyqt5, __version__, QT_API)
@@ -533,7 +532,6 @@ def __init__(self, canvas, num):
 
         self.window._destroying = False
 
-        self.toolmanager = self._get_toolmanager()
         self.toolbar = self._get_toolbar(self.canvas, self.window)
         self.statusbar = None
 
@@ -598,13 +596,6 @@ def _get_toolbar(self, canvas, parent):
             toolbar = None
         return toolbar
 
-    def _get_toolmanager(self):
-        if matplotlib.rcParams['toolbar'] == 'toolmanager':
-            toolmanager = ToolManager(self.canvas.figure)
-        else:
-            toolmanager = None
-        return toolmanager
-
     def resize(self, width, height):
         # these are Qt methods so they return sizes in 'virtual' pixels
         # so we do not need to worry about dpi scaling here.
diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -935,7 +935,8 @@ def __init__(self, num, fig):
         # By adding toolbar in sizer, we are able to put it at the bottom
         # of the frame - so appearance is closer to GTK version
 
-        self.toolmanager = self._get_toolmanager()
+        self.figmgr = FigureManagerWx(self.canvas, num, self)
+
         statusbar = (StatusbarWx(self, self.toolmanager)
                      if self.toolmanager else StatusBarWx(self))
         self.SetStatusBar(statusbar)
@@ -961,15 +962,17 @@ def __init__(self, num, fig):
 
         self.canvas.SetMinSize((2, 2))
 
-        self.figmgr = FigureManagerWx(self.canvas, num, self)
-
         self.Bind(wx.EVT_CLOSE, self._onClose)
 
     @cbook.deprecated("3.2", alternative="self.GetStatusBar()")
     @property
     def statusbar(self):
         return self.GetStatusBar()
 
+    @property
+    def toolmanager(self):
+        return self.figmgr.toolmanager
+
     def _get_toolbar(self):
         if mpl.rcParams['toolbar'] == 'toolbar2':
             toolbar = NavigationToolbar2Wx(self.canvas)
@@ -979,13 +982,6 @@ def _get_toolbar(self):
             toolbar = None
         return toolbar
 
-    def _get_toolmanager(self):
-        if mpl.rcParams['toolbar'] == 'toolmanager':
-            toolmanager = ToolManager(self.canvas.figure)
-        else:
-            toolmanager = None
-        return toolmanager
-
     def get_canvas(self, fig):
         return FigureCanvasWx(self, -1, fig)
 
@@ -1045,8 +1041,16 @@ def __init__(self, canvas, num, frame):
         self.frame = frame
         self.window = frame
 
-        self.toolmanager = getattr(frame, "toolmanager", None)
-        self.toolbar = frame.GetToolBar()
+    @property
+    def toolbar(self):
+        return self.frame.GetToolBar()
+
+    @toolbar.setter
+    def toolbar(self, value):
+        # Never allow this, except that base class inits this to None before
+        # the frame is set up.
+        if value is not None or hasattr(self, "frame"):
+            raise AttributeError("can't set attribute")
 
     def show(self):
         # docstring inherited
