Deprecate toggling axes navigatability using the keyboard.

anntzer · tacaswell · commit 8987d435b133 · 2020-02-18T12:30:55.000-05:00
I made the backend_tools version just point to backend_bases to avoid
repeating the deprecation.
diff --git a/doc/api/next_api_changes/deprecations.rst b/doc/api/next_api_changes/deprecations.rst
@@ -223,3 +223,12 @@ The following validators, defined in `.rcsetup`, are deprecated:
 ``validate_ps_papersize``, ``validate_legend_log``.  To test whether an rcParam
 value would be acceptable, one can test e.g. ``rc = RcParams(); rc[k] = v``
 raises an exception.
+
+Toggling axes navigation from the keyboard using "a" and digit keys
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Axes navigation can still be toggled programmatically using
+`.Axes.set_navigate`.
+
+The following related APIs are also deprecated:
+``backend_tools.ToolEnableAllNavigation``,
+``backend_tools.ToolEnableNavigation``, and ``rcParams["keymap.all_axes"]``.
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -602,6 +602,7 @@ def gen_candidates():
 _deprecated_remain_as_none = {
     'animation.avconv_path': ('3.3',),
     'animation.avconv_args': ('3.3',),
+    'keymap.all_axes': ('3.3',),
 }
 
 
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -2321,7 +2321,7 @@ def key_press_handler(event, canvas, toolbar=None):
     grid_minor_keys = rcParams['keymap.grid_minor']
     toggle_yscale_keys = rcParams['keymap.yscale']
     toggle_xscale_keys = rcParams['keymap.xscale']
-    all_keys = rcParams['keymap.all_axes']
+    all_keys = dict.__getitem__(rcParams, 'keymap.all_axes')
 
     # toggle fullscreen mode ('f', 'ctrl + f')
     if event.key in fullscreen_keys:
@@ -2443,6 +2443,10 @@ def _get_uniform_gridstate(ticks):
         for a in canvas.figure.get_axes():
             if (event.x is not None and event.y is not None
                     and a.in_axes(event)):  # FIXME: Why only these?
+                cbook.warn_deprecated(
+                    "3.3", message="Toggling axes navigation from the "
+                    "keyboard is deprecated since %(since)s and will be "
+                    "removed %(removal)s.")
                 a.set_navigate(True)
     # enable navigation only for axes with this index (if such an axes exist,
     # otherwise do nothing)
@@ -2452,6 +2456,10 @@ def _get_uniform_gridstate(ticks):
             for i, a in enumerate(canvas.figure.get_axes()):
                 if (event.x is not None and event.y is not None
                         and a.in_axes(event)):  # FIXME: Why only these?
+                    cbook.warn_deprecated(
+                        "3.3", message="Toggling axes navigation from the "
+                        "keyboard is deprecated since %(since)s and will be "
+                        "removed %(removal)s.")
                     a.set_navigate(i == n)
 
 
diff --git a/lib/matplotlib/backend_tools.py b/lib/matplotlib/backend_tools.py
@@ -410,38 +410,34 @@ def trigger(self, sender, event, data=None):
         Gcf.destroy_all()
 
 
-class ToolEnableAllNavigation(ToolBase):
+class _ToolEnableAllNavigation(ToolBase):
     """Tool to enable all axes for toolmanager interaction."""
 
     description = 'Enable all axes toolmanager'
     default_keymap = mpl.rcParams['keymap.all_axes']
 
     def trigger(self, sender, event, data=None):
-        if event.inaxes is None:
-            return
+        mpl.backend_bases.key_press_handler(event, self.figure.canvas, None)
 
-        for a in self.figure.get_axes():
-            if (event.x is not None and event.y is not None
-                    and a.in_axes(event)):
-                a.set_navigate(True)
+
+@cbook.deprecated("3.3")
+class ToolEnableAllNavigation(_ToolEnableAllNavigation):
+    pass
 
 
-class ToolEnableNavigation(ToolBase):
+class _ToolEnableNavigation(ToolBase):
     """Tool to enable a specific axes for toolmanager interaction."""
 
     description = 'Enable one axes toolmanager'
     default_keymap = (1, 2, 3, 4, 5, 6, 7, 8, 9)
 
     def trigger(self, sender, event, data=None):
-        if event.inaxes is None:
-            return
+        mpl.backend_bases.key_press_handler(event, self.figure.canvas, None)
+
 
-        n = int(event.key) - 1
-        if n < len(self.figure.get_axes()):
-            for i, a in enumerate(self.figure.get_axes()):
-                if (event.x is not None and event.y is not None
-                        and a.in_axes(event)):
-                    a.set_navigate(i == n)
+@cbook.deprecated("3.3")
+class ToolEnableNavigation(_ToolEnableNavigation):
+    pass
 
 
 class _ToolGridBase(ToolBase):
@@ -1089,8 +1085,8 @@ def trigger(self, *args, **kwargs):
                  'fullscreen': ToolFullScreen,
                  'quit': ToolQuit,
                  'quit_all': ToolQuitAll,
-                 'allnav': ToolEnableAllNavigation,
-                 'nav': ToolEnableNavigation,
+                 'allnav': _ToolEnableAllNavigation,
+                 'nav': _ToolEnableNavigation,
                  'xscale': ToolXScale,
                  'yscale': ToolYScale,
                  'position': ToolCursorPosition,
diff --git a/lib/matplotlib/mpl-data/stylelib/classic.mplstyle b/lib/matplotlib/mpl-data/stylelib/classic.mplstyle
@@ -467,7 +467,6 @@ keymap.quit : ctrl+w, cmd+w         # close the current figure
 keymap.grid : g                     # switching on/off a grid in current axes
 keymap.yscale : l                   # toggle scaling of y-axes ('log'/'linear')
 keymap.xscale : k, L                # toggle scaling of x-axes ('log'/'linear')
-keymap.all_axes : a                 # enable all axes
 
 ###ANIMATION settings
 animation.writer : ffmpeg         # MovieWriter 'backend' to use
diff --git a/matplotlibrc.template b/matplotlibrc.template
@@ -717,7 +717,6 @@
 #keymap.grid_minor: G           # switching on/off minor grids in current axes
 #keymap.yscale: l               # toggle scaling of y-axes ('log'/'linear')
 #keymap.xscale: k, L            # toggle scaling of x-axes ('log'/'linear')
-#keymap.all_axes: a             # enable all axes
 #keymap.copy: ctrl+c, cmd+c     # Copy figure to clipboard
 
 

Original file line number	Diff line number	Diff line change
`@@ -602,6 +602,7 @@ def gen_candidates():`
`602`	`602`	`_deprecated_remain_as_none = {`
`603`	`603`	`'animation.avconv_path': ('3.3',),`
`604`	`604`	`'animation.avconv_args': ('3.3',),`
	`605`	`+ 'keymap.all_axes': ('3.3',),`
`605`	`606`	`}`
`606`	`607`
`607`	`608`