tacaswell comments aprl 1

Author: fariza

examples/user_interfaces/navigation.py

@@ -18,7 +18,7 @@ class allows to:
 class ListTools(ToolBase):
     '''List all the tools controlled by `Navigation`'''
     # keyboard shortcut
-    keymap = 'm'
+    default_keymap = 'm'
     description = 'List Tools'
 
     def trigger(self, *args, **kwargs):
@@ -46,7 +46,7 @@ def trigger(self, *args, **kwargs):
 # ref: at https://github.com/matplotlib/matplotlib/issues/1987
 class CopyToolGTK3(ToolBase):
     '''Copy canvas to clipboard'''
-    keymap = 'ctrl+c'
+    default_keymap = 'ctrl+c'
     description = 'Copy canvas'
 
     def trigger(self, *args, **kwargs):

lib/matplotlib/backend_bases.py

@@ -2586,6 +2586,8 @@ def __init__(self, canvas, num):
             self.key_press_handler_id = self.canvas.mpl_connect(
                                                 'key_press_event',
                                                 self.key_press)
+        else:
+            self.key_press_handler_id = None
         """
         The returned id from connecting the default key handler via
         :meth:`FigureCanvasBase.mpl_connnect`.
@@ -3331,11 +3333,7 @@ def message_event(self, message, sender=None):
 
     @property
     def active_toggle(self):
-        """
-        Toggled Tool
-
-        **dict** :  Currently toggled tools
-        """
+        """Currently toggled tools"""
 
         return self._toggled
 
@@ -3360,7 +3358,7 @@ def _remove_keys(self, name):
         for k in self.get_tool_keymap(name):
             del self._keys[k]
 
-    def set_tool_keymap(self, name, *keys):
+    def update_keymap(self, name, *keys):
         """
         Set the keymap to associate with the specified tool
 
@@ -3449,30 +3447,31 @@ def add_tool(self, name, tool, *args, **kwargs):
         """
 
         tool_cls = self._get_cls_to_instantiate(tool)
-        if tool_cls is False:
+        if not tool_cls:
             raise ValueError('Impossible to find class for %s' % str(tool))
 
         if name in self._tools:
             warnings.warn('A "Tool class" with the same name already exists, '
                           'not added')
             return self._tools[name]
 
-        self._tools[name] = tool_cls(self, name, *args, **kwargs)
+        tool_obj = tool_cls(self, name, *args, **kwargs)
+        self._tools[name] = tool_obj
 
-        if tool_cls.keymap is not None:
-            self.set_tool_keymap(name, tool_cls.keymap)
+        if tool_cls.default_keymap is not None:
+            self.update_keymap(name, tool_cls.default_keymap)
 
         # For toggle tools init the radio_group in self._toggled
-        if isinstance(self._tools[name], tools.ToolToggleBase):
+        if isinstance(tool_obj, tools.ToolToggleBase):
             # None group is not mutually exclusive, a set is used to keep track
             # of all toggled tools in this group
-            if tool_cls.radio_group is None:
+            if tool_obj.radio_group is None:
                 self._toggled.setdefault(None, set())
             else:
-                self._toggled.setdefault(tool_cls.radio_group, None)
+                self._toggled.setdefault(tool_obj.radio_group, None)
 
-        self._tool_added_event(self._tools[name])
-        return self._tools[name]
+        self._tool_added_event(tool_obj)
+        return tool_obj
 
     def _tool_added_event(self, tool):
         s = 'tool_added_event'
@@ -3483,6 +3482,16 @@ def _handle_toggle(self, tool, sender, canvasevent, data):
         """
         Toggle tools, need to untoggle prior to using other Toggle tool
         Called from tool_trigger_event
+
+        Parameters
+        ----------
+        tool: Tool object
+        sender: object
+            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
@@ -3500,7 +3509,7 @@ def _handle_toggle(self, tool, sender, canvasevent, data):
             toggled = None
         # If no tool was toggled in the radio_group
         # toggle it
-        elif self._toggled.get(radio_group, None) is None:
+        elif self._toggled[radio_group] is None:
             toggled = tool.name
         # Other tool in the radio_group is toggled
         else:
@@ -3521,15 +3530,18 @@ def _get_cls_to_instantiate(self, callback_class):
         if isinstance(callback_class, six.string_types):
             # FIXME: make more complete searching structure
             if callback_class in globals():
-                return globals()[callback_class]
-
-            mod = self.__class__.__module__
-            current_module = __import__(mod,
-                                        globals(), locals(), [mod], 0)
+                callback_class = globals()[callback_class]
+            else:
+                mod = self.__class__.__module__
+                current_module = __import__(mod,
+                                            globals(), locals(), [mod], 0)
 
-            return getattr(current_module, callback_class, False)
+                callback_class = getattr(current_module, callback_class, False)
 
-        return callback_class
+        if callable(callback_class):
+            return callback_class
+        else:
+            return None
 
     def tool_trigger_event(self, name, sender=None, canvasevent=None,
                            data=None):
@@ -3598,7 +3610,7 @@ def get_tool(self, name, warn=True):
         -----------
         name : str, ToolBase
             Name of the tool, or the tool itself
-        warn : bool
+        warn : bool, optional
             If this method should give warnings.
         """
         if isinstance(name, tools.ToolBase) and name.name in self._tools:

lib/matplotlib/backend_tools.py

@@ -45,7 +45,7 @@ class ToolBase(object):
         Navigation
     """
 
-    keymap = None
+    default_keymap = None
     """
     Keymap to associate with this tool
 
@@ -311,7 +311,7 @@ class ToolQuit(ToolBase):
     """Tool to call the figure manager destroy method"""
 
     description = 'Quit the figure'
-    keymap = rcParams['keymap.quit']
+    default_keymap = rcParams['keymap.quit']
 
     def trigger(self, sender, event, data=None):
         Gcf.destroy_fig(self.figure)
@@ -321,7 +321,7 @@ class ToolEnableAllNavigation(ToolBase):
     """Tool to enable all axes for navigation interaction"""
 
     description = 'Enables all axes navigation'
-    keymap = rcParams['keymap.all_axes']
+    default_keymap = rcParams['keymap.all_axes']
 
     def trigger(self, sender, event, data=None):
         if event.inaxes is None:
@@ -337,7 +337,7 @@ class ToolEnableNavigation(ToolBase):
     """Tool to enable a specific axes for navigation interaction"""
 
     description = 'Enables one axes navigation'
-    keymap = (1, 2, 3, 4, 5, 6, 7, 8, 9)
+    default_keymap = (1, 2, 3, 4, 5, 6, 7, 8, 9)
 
     def trigger(self, sender, event, data=None):
         if event.inaxes is None:
@@ -354,7 +354,7 @@ class ToolGrid(ToolToggleBase):
     """Tool to toggle the grid of the figure"""
 
     description = 'Toogle Grid'
-    keymap = rcParams['keymap.grid']
+    default_keymap = rcParams['keymap.grid']
 
     def trigger(self, sender, event, data=None):
         if event.inaxes is None:
@@ -374,7 +374,7 @@ class ToolFullScreen(ToolToggleBase):
     """Tool to toggle full screen"""
 
     description = 'Toogle Fullscreen mode'
-    keymap = rcParams['keymap.fullscreen']
+    default_keymap = rcParams['keymap.fullscreen']
 
     def enable(self, event):
         self.figure.canvas.manager.full_screen_toggle()
@@ -404,7 +404,7 @@ class ToolYScale(AxisScaleBase):
     """Tool to toggle between linear and logarithmic scales on the Y axis"""
 
     description = 'Toogle Scale Y axis'
-    keymap = rcParams['keymap.yscale']
+    default_keymap = rcParams['keymap.yscale']
 
     def set_scale(self, ax, scale):
         ax.set_yscale(scale)
@@ -414,7 +414,7 @@ class ToolXScale(AxisScaleBase):
     """Tool to toggle between linear and logarithmic scales on the X axis"""
 
     description = 'Toogle Scale X axis'
-    keymap = rcParams['keymap.xscale']
+    default_keymap = rcParams['keymap.xscale']
 
     def set_scale(self, ax, scale):
         ax.set_xscale(scale)
@@ -547,7 +547,7 @@ class ToolHome(ViewsPositionsBase):
 
     description = 'Reset original view'
     image = 'home.png'
-    keymap = rcParams['keymap.home']
+    default_keymap = rcParams['keymap.home']
     _on_trigger = 'home'
 
 
@@ -556,7 +556,7 @@ class ToolBack(ViewsPositionsBase):
 
     description = 'Back to  previous view'
     image = 'back.png'
-    keymap = rcParams['keymap.back']
+    default_keymap = rcParams['keymap.back']
     _on_trigger = 'back'
 
 
@@ -565,7 +565,7 @@ class ToolForward(ViewsPositionsBase):
 
     description = 'Forward to next view'
     image = 'forward.png'
-    keymap = rcParams['keymap.forward']
+    default_keymap = rcParams['keymap.forward']
     _on_trigger = 'forward'
 
 
@@ -581,7 +581,7 @@ class SaveFigureBase(ToolBase):
 
     description = 'Save the figure'
     image = 'filesave.png'
-    keymap = rcParams['keymap.save']
+    default_keymap = rcParams['keymap.save']
 
 
 class ZoomPanBase(ToolToggleBase):
@@ -651,7 +651,7 @@ class ToolZoom(ZoomPanBase):
 
     description = 'Zoom to rectangle'
     image = 'zoom_to_rect.png'
-    keymap = rcParams['keymap.zoom']
+    default_keymap = rcParams['keymap.zoom']
     cursor = cursors.SELECT_REGION
     radio_group = 'default'
 
@@ -861,7 +861,7 @@ def _release(self, event):
 class ToolPan(ZoomPanBase):
     """Pan axes with left mouse, zoom with right"""
 
-    keymap = rcParams['keymap.pan']
+    default_keymap = rcParams['keymap.pan']
     description = 'Pan axes with left mouse, zoom with right'
     image = 'move.png'
     cursor = cursors.MOVE