Remove Rubberband tool and data kwarg to trigger.

anntzer · Dec 6, 2017 · Dec 6, 2017 · Dec 6, 2017 · Dec 6, 2017 · Dec 6, 2017
commit fc1e1a8683c34b5315a643e89c71226401d1425e
diff --git a/lib/matplotlib/backend_managers.py b/lib/matplotlib/backend_managers.py
@@ -17,17 +17,16 @@
 
 class ToolEvent(object):
     """Event for tool manipulation (add/remove)"""
-    def __init__(self, name, sender, tool, data=None):
+    def __init__(self, name, sender, tool):
         self.name = name
         self.sender = sender
         self.tool = tool
-        self.data = data
 
 
 class ToolTriggerEvent(ToolEvent):
     """Event to inform  that a tool has been triggered"""
-    def __init__(self, name, sender, tool, canvasevent=None, data=None):
-        ToolEvent.__init__(self, name, sender, tool, data)
+    def __init__(self, name, sender, tool, canvasevent=None):
+        ToolEvent.__init__(self, name, sender, tool)
         self.canvasevent = canvasevent
 
 
@@ -234,7 +233,7 @@ def remove_tool(self, name):
 
         del self._tools[name]
 
-    def add_tool(self, tool_name):
+    def add_tool(self, tool_name, *args, **kwargs):
         """
         Add *tool* to `ToolManager`
 
@@ -265,7 +264,7 @@ def add_tool(self, tool_name):
                           'not added')
             return self._tools[tool_name]
 
-        tool_obj = tool_cls(self, tool_name)
+        tool_obj = tool_cls(self, tool_name, *args, **kwargs)
         self._tools[tool_name] = tool_obj
 
         if tool_cls.default_keymap is not None:
@@ -282,7 +281,7 @@ def add_tool(self, tool_name):
 
             # If initially toggled
             if tool_obj.toggled:
-                self._handle_toggle(tool_obj, None, None, None)
+                self._handle_toggle(tool_obj, None, None)
         tool_obj.set_figure(self.figure)
 
         self._tool_added_event(tool_obj)
@@ -293,7 +292,7 @@ def _tool_added_event(self, tool):
         event = ToolEvent(s, self, tool)
         self._callbacks.process(s, event)
 
-    def _handle_toggle(self, tool, sender, canvasevent, data):
+    def _handle_toggle(self, tool, sender, canvasevent):
         """
         Toggle tools, need to untoggle prior to using other Toggle tool
         Called from trigger_tool
@@ -305,8 +304,6 @@ def _handle_toggle(self, tool, sender, canvasevent, data):
             Object that wishes to trigger the tool
         canvasevent : Event
             Original Canvas event or None
-        data : Object
-            Extra data to pass to the tool when triggering
         """
 
         radio_group = tool.radio_group
@@ -329,10 +326,7 @@ def _handle_toggle(self, tool, sender, canvasevent, data):
         # Other tool in the radio_group is toggled
         else:
             # Untoggle previously toggled tool
-            self.trigger_tool(self._toggled[radio_group],
-                              self,
-                              canvasevent,
-                              data)
+            self.trigger_tool(self._toggled[radio_group], self, canvasevent)
             toggled = tool.name
 
         # Keep track of the toggled tool in the radio_group
@@ -355,8 +349,7 @@ def _get_cls_to_instantiate(self, callback_class):
         else:
             return None
 
-    def trigger_tool(self, name, sender=None, canvasevent=None,
-                     data=None):
+    def trigger_tool(self, name, sender=None, canvasevent=None):
         """
         Trigger a tool and emit the tool_trigger_[name] event
 
@@ -368,8 +361,6 @@ def trigger_tool(self, name, sender=None, canvasevent=None,
             Object that wishes to trigger the tool
         canvasevent : Event
             Original Canvas event or None
-        data : Object
-            Extra data to pass to the tool when triggering
         """
         tool = self.get_tool(name)
         if tool is None:
@@ -378,13 +369,13 @@ def trigger_tool(self, name, sender=None, canvasevent=None,
         if sender is None:
             sender = self
 
-        self._trigger_tool(name, sender, canvasevent, data)
+        self._trigger_tool(name, sender, canvasevent)
 
         s = 'tool_trigger_%s' % name
-        event = ToolTriggerEvent(s, sender, tool, canvasevent, data)
+        event = ToolTriggerEvent(s, sender, tool, canvasevent)
         self._callbacks.process(s, event)
 
-    def _trigger_tool(self, name, sender=None, canvasevent=None, data=None):
+    def _trigger_tool(self, name, sender=None, canvasevent=None):
         """
         Trigger on a tool
 
@@ -393,11 +384,11 @@ def _trigger_tool(self, name, sender=None, canvasevent=None, data=None):
         tool = self.get_tool(name)
 
         if isinstance(tool, tools.ToolToggleBase):
-            self._handle_toggle(tool, sender, canvasevent, data)
+            self._handle_toggle(tool, sender, canvasevent)
 
         # Important!!!
         # This is where the Tool object gets triggered
-        tool.trigger(sender, canvasevent, data)
+        tool.trigger(sender, canvasevent)
 
     def _key_press(self, event):
         if event.key is None or self.keypresslock.locked():

diff --git a/lib/matplotlib/backend_tools.py b/lib/matplotlib/backend_tools.py
@@ -145,7 +145,7 @@ def set_figure(self, figure):
         """
         self._figure = figure
 
-    def trigger(self, sender, event, data=None):
+    def trigger(self, sender, event):
         """
         Called when this tool gets used
 
@@ -158,8 +158,6 @@ def trigger(self, sender, event, data=None):
             The Canvas event that caused this tool to be called
         sender: object
             Object that requested the tool to be triggered
-        data: object
-            Extra data
         """
 
         pass
@@ -211,7 +209,7 @@ def __init__(self, *args, **kwargs):
         self._toggled = kwargs.pop('toggled', self.default_toggled)
         ToolBase.__init__(self, *args, **kwargs)
 
-    def trigger(self, sender, event, data=None):
+    def trigger(self, sender, event):
         """Calls `enable` or `disable` based on `toggled` value"""
         if self._toggled:
             self.disable(event)
@@ -387,42 +385,14 @@ def send_message(self, event):
         self.toolmanager.message_event(message, self)
 
 
-class RubberbandBase(ToolBase):
-    """Draw and remove rubberband"""
-    def trigger(self, sender, event, data):
-        """Call `draw_rubberband` or `remove_rubberband` based on data"""
-        if not self.figure.canvas.widgetlock.available(sender):
-            return
-        if data is not None:
-            self.draw_rubberband(*data)
-        else:
-            self.remove_rubberband()
-
-    def draw_rubberband(self, *data):
-        """
-        Draw rubberband
-
-        This method must get implemented per backend
-        """
-        raise NotImplementedError
-
-    def remove_rubberband(self):
-        """
-        Remove rubberband
-
-        This method should get implemented per backend
-        """
-        pass
-
-
 @register_tool("quit")
 class ToolQuit(ToolBase):
     """Tool to call the figure manager destroy method"""
 
     description = 'Quit the figure'
     default_keymap = rcParams['keymap.quit']
 
-    def trigger(self, sender, event, data=None):
+    def trigger(self, sender, event):
         Gcf.destroy_fig(self.figure)
 
 
@@ -433,7 +403,7 @@ class ToolQuitAll(ToolBase):
     description = 'Quit all figures'
     default_keymap = rcParams['keymap.quit_all']
 
-    def trigger(self, sender, event, data=None):
+    def trigger(self, sender, event):
         Gcf.destroy_all()
 
 
@@ -444,7 +414,7 @@ class ToolEnableAllNavigation(ToolBase):
     description = 'Enables all axes toolmanager'
     default_keymap = rcParams['keymap.all_axes']
 
-    def trigger(self, sender, event, data=None):
+    def trigger(self, sender, event):
         if event.inaxes is None:
             return
 
@@ -461,7 +431,7 @@ class ToolEnableNavigation(ToolBase):
     description = 'Enables one axes toolmanager'
     default_keymap = (1, 2, 3, 4, 5, 6, 7, 8, 9)
 
-    def trigger(self, sender, event, data=None):
+    def trigger(self, sender, event):
         if event.inaxes is None:
             return
 
@@ -477,7 +447,7 @@ class _ToolGridBase(ToolBase):
 
     _cycle = [(False, False), (True, False), (True, True), (False, True)]
 
-    def trigger(self, sender, event, data=None):
+    def trigger(self, sender, event):
         ax = event.inaxes
         if ax is None:
             return
@@ -566,10 +536,10 @@ def disable(self, event):
 class AxisScaleBase(ToolToggleBase):
     """Base Tool to toggle between linear and logarithmic"""
 
-    def trigger(self, sender, event, data=None):
+    def trigger(self, sender, event):
         if event.inaxes is None:
             return
-        ToolToggleBase.trigger(self, sender, event, data)
+        ToolToggleBase.trigger(self, event)
 
     def enable(self, event):
         self.set_scale(event.inaxes, 'log')
@@ -760,7 +730,7 @@ class ViewsPositionsBase(ToolBase):
 
     _on_trigger = None
 
-    def trigger(self, sender, event, data=None):
+    def trigger(self, sender, event):
         self.toolmanager.get_tool("viewpos").add_figure(self.figure)
         getattr(self.toolmanager.get_tool("viewpos"),
                 self._on_trigger)()
@@ -845,9 +815,9 @@ def disable(self, event):
         self.figure.canvas.mpl_disconnect(self._idRelease)
         self.figure.canvas.mpl_disconnect(self._idScroll)
 
-    def trigger(self, sender, event, data=None):
+    def trigger(self, sender, event):
         self.toolmanager.get_tool("viewpos").add_figure(self.figure)
-        ToolToggleBase.trigger(self, sender, event, data)
+        ToolToggleBase.trigger(self, event)
 
     def scroll_zoom(self, event):
         # https://gist.github.com/tacaswell/3144287
@@ -881,6 +851,8 @@ def scroll_zoom(self, event):
 @register_tool("zoom")
 class ToolZoom(ZoomPanBase):
     """Zoom to rectangle"""
+    # Subclasses should overrider _draw_rubberband and possibly
+    # _remove_rubberband.
 
     description = 'Zoom to rectangle'
     image = 'zoom_to_rect'
@@ -892,10 +864,16 @@ def __init__(self, *args):
         ZoomPanBase.__init__(self, *args)
         self._ids_zoom = []
 
+    def _draw_rubberband(self, x1, y1, x2, y2):
+        raise NotImplementedError
+
+    def _remove_rubberband(self):
+        pass
+
     def _cancel_action(self):
         for zoom_id in self._ids_zoom:
             self.figure.canvas.mpl_disconnect(zoom_id)
-        self.toolmanager.trigger_tool('rubberband', self)
+        self._remove_rubberband()
         self.toolmanager.get_tool("viewpos").refresh_locators()
         self._xypress = None
         self._button_pressed = None
@@ -956,8 +934,7 @@ def _mouse_move(self, event):
                 y1, y2 = a.bbox.intervaly
             elif self._zoom_mode == "y":
                 x1, x2 = a.bbox.intervalx
-            self.toolmanager.trigger_tool(
-                'rubberband', self, data=(x1, y1, x2, y2))
+            self._draw_rubberband(x1, y1, x2, y2)
 
     def _release(self, event):
         """the release mouse button callback in zoom to rect mode"""
@@ -1075,7 +1052,7 @@ def _mouse_move(self, event):
 default_tools = [
     'home', 'back', 'forward', 'zoom', 'pan', 'subplots', 'save',
     'grid', 'grid_minor', 'fullscreen', 'quit', 'quit_all', 'allnav', 'nav',
-    'xscale', 'yscale', 'position', 'viewpos', 'cursor', 'rubberband',
+    'xscale', 'yscale', 'position', 'viewpos', 'cursor',
 ]
 """Default tools"""
 

diff --git a/lib/matplotlib/backends/backend_gtk3.py b/lib/matplotlib/backends/backend_gtk3.py
@@ -665,13 +665,9 @@ def get_filename_from_user (self):
         return filename, self.ext
 
 
-@backend_tools.register_tool("rubberband")
-class RubberbandGTK3(backend_tools.RubberbandBase):
-    def __init__(self, *args, **kwargs):
-        backend_tools.RubberbandBase.__init__(self, *args, **kwargs)
-        self.ctx = None
-
-    def draw_rubberband(self, x0, y0, x1, y1):
+@backend_tools.register_tool("zoom", __name__)
+class ToolZoom(backend_tools.ToolZoom):
+    def _draw_rubberband(self, x0, y0, x1, y1):
         # 'adapted from http://aspn.activestate.com/ASPN/Cookbook/Python/
         # Recipe/189744'
         self.ctx = self.figure.canvas.get_property("window").cairo_create()
@@ -869,7 +865,7 @@ def destroy(self, *args):
     def _get_canvas(self, fig):
         return self.canvas.__class__(fig)
 
-    def trigger(self, sender, event, data=None):
+    def trigger(self, sender, event):
         self.init_window()
         self.window.present()
 

diff --git a/lib/matplotlib/backends/backend_tkagg.py b/lib/matplotlib/backends/backend_tkagg.py
@@ -838,12 +838,9 @@ def hidetip(self):
             tw.destroy()
 
 
-@backend_tools.register_tool("rubberband", __name__)
-class RubberbandTk(backend_tools.RubberbandBase):
-    def __init__(self, *args, **kwargs):
-        backend_tools.RubberbandBase.__init__(self, *args, **kwargs)
-
-    def draw_rubberband(self, x0, y0, x1, y1):
+@backend_tools.register_tool("zoom", __name__)
+class ZoomTk(backend_tools.ToolZoom):
+    def _draw_rubberband(self, x0, y0, x1, y1):
         height = self.figure.canvas.figure.bbox.height
         y0 = height - y0
         y1 = height - y1
@@ -852,7 +849,7 @@ def draw_rubberband(self, x0, y0, x1, y1):
         self.lastrect = self.figure.canvas._tkcanvas.create_rectangle(
             x0, y0, x1, y1)
 
-    def remove_rubberband(self):
+    def _remove_rubberband(self):
         if hasattr(self, "lastrect"):
             self.figure.canvas._tkcanvas.delete(self.lastrect)
             del self.lastrect