Refactored making FigureManager a *figure* manager, plus added missing methods.

OceanWolf · tacaswell · commit 39ff708c8c25 · 2017-06-19T00:33:01.000-04:00
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -46,6 +46,7 @@
 import sys
 import time
 import warnings
+import weakref
 
 import numpy as np
 import matplotlib.cbook as cbook
@@ -1745,7 +1746,7 @@ class FigureCanvasBase(object):
         register_backend('tiff', 'matplotlib.backends.backend_agg',
                          'Tagged Image File Format')
 
-    def __init__(self, figure):
+    def __init__(self, figure, manager=None):
         self._is_idle_drawing = True
         self._is_saving = False
         figure.set_canvas(self)
@@ -1760,6 +1761,7 @@ def __init__(self, figure):
         self.scroll_pick_id = self.mpl_connect('scroll_event', self.pick)
         self.mouse_grabber = None  # the axes currently grabbing mouse
         self.toolbar = None  # NavigationToolbar2 will set me
+        self.manager = manager
         self._is_idle_drawing = False
 
     @contextmanager
@@ -2464,6 +2466,19 @@ def stop_event_loop_default(self):
         """
         self._looping = False
 
+    def destroy(self):
+        pass
+
+    @property
+    def manager(self):
+        if self._manager is not None:
+            return self._manager()
+
+    @manager.setter
+    def manager(self, manager):
+        if manager is not None:
+            self._manager = weakref.ref(manager)
+
 
 def key_press_handler(event, canvas, toolbar=None):
     """
@@ -2665,6 +2680,9 @@ def destroy(self):
     def set_fullscreen(self, fullscreen):
         pass
 
+    def set_default_size(self, w, h):
+        self.resize(w, h)
+
     def resize(self, w, h):
         """"For gui backends, resize the window (in pixels)."""
         pass
diff --git a/lib/matplotlib/backend_managers.py b/lib/matplotlib/backend_managers.py
@@ -30,25 +30,25 @@ def __init__(self, s, fm):
 
 
 class FigureManager(cbook.EventEmitter):
-    def __init__(self, canvas, num):
+    def __init__(self, figure, num):
         cbook.EventEmitter.__init__(self)
-        self.canvas = canvas
-        canvas.manager = self
         self.num = num
 
-        self.key_press_handler_id = self.canvas.mpl_connect('key_press_event',
-                                                            self.key_press)
-
         self.mainloop = MainLoop()
         self.window = Window('Figure %d' % num)
         self.window.mpl_connect('window_destroy_event', self._destroy)
 
+        self.canvas = FigureCanvas(figure, self)
+
+        self.key_press_handler_id = self.canvas.mpl_connect('key_press_event',
+                                                            self.key_press)
+
         w = int(self.canvas.figure.bbox.width)
         h = int(self.canvas.figure.bbox.height)
 
         self.window.add_element_to_window(self.canvas, True, True, 0, True)
 
-        self.toolbar = self._get_toolbar(canvas)
+        self.toolbar = self._get_toolbar()
         if self.toolbar is not None:
             h += self.window.add_element_to_window(self.toolbar,
                                                    False, False, 0)
@@ -64,8 +64,6 @@ def notify_axes_change(fig):
                 self.toolbar.update()
         self.canvas.figure.add_axobserver(notify_axes_change)
 
-        self.canvas.grab_focus()
-
     def key_press(self, event):
         """
         Implement the default mpl key bindings defined at
@@ -111,21 +109,21 @@ def set_window_title(self, title):
         """
         self.window.set_window_title(title)
 
-    def show_popup(self, msg):
-        """
-        Display message in a popup -- GUI only
-        """
-        pass
-
-    def _get_toolbar(self, canvas):
+    def _get_toolbar(self):
         # must be inited after the window, drawingArea and figure
         # attrs are set
         if rcParams['toolbar'] == 'toolbar2':
-            toolbar = Toolbar2(canvas, self.window)
+            toolbar = Toolbar2(self.canvas, self.window)
         else:
             toolbar = None
         return toolbar
 
+    def show_popup(self, msg):
+        """
+        Display message in a popup -- GUI only
+        """
+        pass
+
 
 class ToolEvent(object):
     """Event for tool manipulation (add/remove)"""
@@ -553,17 +551,16 @@ def new_figure_manager(num, *args, **kwargs):
     Create a new figure manager instance
     """
     show = kwargs.pop('show', None)
-    if old_new_figure_manager is None:
+    if old_new_figure_manager is None:  # Test if we can use the new code
         FigureClass = kwargs.pop('FigureClass', Figure)
         thisFig = FigureClass(*args, **kwargs)
         manager = new_figure_manager_given_figure(num, thisFig)
-    else:  # TODO remove once Gcf removed from backends.
+    else:  # TODO remove once Gcf removed from backends.  Default to old code.
         manager = old_new_figure_manager(num, *args, **kwargs)
         manager.mainloop = MainLoop
     return manager
 
 
 def new_figure_manager_given_figure(num, figure):
-    canvas = FigureCanvas(figure)
-    manager = FigureManager(canvas, num)
+    manager = FigureManager(figure, num)
     return manager
diff --git a/lib/matplotlib/backends/backend_gtk3.py b/lib/matplotlib/backends/backend_gtk3.py
@@ -192,8 +192,8 @@ class FigureCanvasGTK3(Gtk.DrawingArea, FigureCanvasBase):
                   Gdk.EventMask.POINTER_MOTION_HINT_MASK|
                   Gdk.EventMask.SCROLL_MASK)
 
-    def __init__(self, figure):
-        FigureCanvasBase.__init__(self, figure)
+    def __init__(self, figure, manager=None):
+        FigureCanvasBase.__init__(self, figure, manager)
         GObject.GObject.__init__(self)
 
         self._idle_draw_id  = 0
diff --git a/lib/matplotlib/backends/backend_gtk3agg.py b/lib/matplotlib/backends/backend_gtk3agg.py
@@ -21,8 +21,8 @@
 
 class FigureCanvasGTK3Agg(backend_gtk3.FigureCanvasGTK3,
                           backend_agg.FigureCanvasAgg):
-    def __init__(self, figure):
-        backend_gtk3.FigureCanvasGTK3.__init__(self, figure)
+    def __init__(self, figure, manager=None):
+        backend_gtk3.FigureCanvasGTK3.__init__(self, figure, manager)
         self._bbox_queue = []
 
     def _renderer_init(self):
diff --git a/lib/matplotlib/backends/backend_gtk3cairo.py b/lib/matplotlib/backends/backend_gtk3cairo.py
@@ -22,8 +22,8 @@ def set_context(self, ctx):
 
 class FigureCanvasGTK3Cairo(backend_gtk3.FigureCanvasGTK3,
                             backend_cairo.FigureCanvasCairo):
-    def __init__(self, figure):
-        backend_gtk3.FigureCanvasGTK3.__init__(self, figure)
+    def __init__(self, figure, manager=None):
+        backend_gtk3.FigureCanvasGTK3.__init__(self, figure, manager)
 
     def _renderer_init(self):
         """use cairo renderer"""
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1643,7 +1643,7 @@ def __setstate__(self, state):
 
         if restore_to_pylab:
             # lazy import to avoid circularity
-            # XXX clean on removal of Gcf from backends
+            # TODO clean on removal of Gcf from backends
             import matplotlib.pyplot as plt
             import matplotlib._pylab_helpers as pylab_helpers
             import matplotlib.backend_managers as managers
@@ -1654,7 +1654,7 @@ def __setstate__(self, state):
                                                                        self)
                 mgr.mainloop = plt._show
             else:
-                mgr = managers.new_figure_manager_given_figure(num, self)
+                mgr = managers.FigureManager(self, num)
 
             # XXX The following is a copy and paste from pyplot. Consider
             # factoring to pylab_helpers
