Deprecate FigureCanvasQT.keyAutoRepeat.

anntzer · anntzer · commit e57b2353ce81 · 2018-04-04T11:18:30.000-07:00
No other backend allows ignoring autorepeated keypresses.  Moreover,
such keypresses can easily be ignored in the key press handler by
directly checking on `event.isAutoRepeat()`.
diff --git a/doc/api/next_api_changes/2018-02-16-AL-deprecations.rst b/doc/api/next_api_changes/2018-02-16-AL-deprecations.rst
@@ -0,0 +1,5 @@
+Deprecations
+````````````
+The `~.FigureCanvasQT.keyAutoRepeat` property is deprecated.  Directly check
+``event.guiEvent.isAutoRepeat()`` in the event handler to decide whether to
+handle autorepeated key presses.
diff --git a/lib/matplotlib/backends/backend_qt5.py b/lib/matplotlib/backends/backend_qt5.py
@@ -1,5 +1,3 @@
-from __future__ import (absolute_import, division, print_function,
-                        unicode_literals)
 import six
 
 import functools
@@ -378,13 +376,17 @@ def keyReleaseEvent(self, event):
             FigureCanvasBase.key_release_event(self, key, guiEvent=event)
 
     @property
+    @cbook.deprecated("3.0", "Manually check `event.guiEvent.isAutoRepeat()` "
+                      "in the event handler.")
     def keyAutoRepeat(self):
         """
         If True, enable auto-repeat for key events.
         """
         return self._keyautorepeat
 
     @keyAutoRepeat.setter
+    @cbook.deprecated("3.0", "Manually check `event.guiEvent.isAutoRepeat()` "
+                      "in the event handler.")
     def keyAutoRepeat(self, val):
         self._keyautorepeat = bool(val)
 
