Merge pull request #16418 from anntzer/timercls

tacaswell · web-flow · commit af2bc5e4eb06 · 2020-02-09T22:43:30.000-05:00
MNT: Backend timer simplifications.
diff --git a/doc/api/next_api_changes/removals.rst b/doc/api/next_api_changes/removals.rst
@@ -122,6 +122,9 @@ Arguments
 - The parameter ``block`` of ``show()`` is now keyword-only.
 - The parameter ``frameon`` of `.Figure.savefig` has been removed.  Use
   ``facecolor="none"`` to get a transparent background.
+- Passing a ``wx.EvtHandler`` as the first argument to ``backend_wx.TimerWx``
+  is not supported anymore; the signature of ``TimerWx`` is now consistent with
+  `.TimerBase`.
 
 rcParams
 ~~~~~~~~
diff --git a/examples/event_handling/pong_sgskip.py b/examples/event_handling/pong_sgskip.py
@@ -44,8 +44,7 @@ def local_draw():
 
 
 start_anim.cid = canvas.mpl_connect('draw_event', start_anim)
-start_anim.timer = animation.canvas.new_timer()
-start_anim.timer.interval = 1
+start_anim.timer = animation.canvas.new_timer(interval=1)
 
 tstart = time.time()
 
diff --git a/examples/user_interfaces/embedding_in_qt_sgskip.py b/examples/user_interfaces/embedding_in_qt_sgskip.py
@@ -45,8 +45,8 @@ def __init__(self):
         self._static_ax.plot(t, np.tan(t), ".")
 
         self._dynamic_ax = dynamic_canvas.figure.subplots()
-        self._timer = dynamic_canvas.new_timer(
-            50, [(self._update_canvas, (), {})])
+        self._timer = dynamic_canvas.new_timer(50)
+        self._timer.add_callback(self._update_canvas)
         self._timer.start()
 
     def _update_canvas(self):
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -1401,8 +1401,7 @@ def __init__(self, fig, interval=200, repeat_delay=0, repeat=True,
         # If we're not given an event source, create a new timer. This permits
         # sharing timers between animation objects for syncing animations.
         if event_source is None:
-            event_source = fig.canvas.new_timer()
-            event_source.interval = self._interval
+            event_source = fig.canvas.new_timer(interval=self._interval)
         Animation.__init__(self, fig, event_source=event_source,
                            *args, **kwargs)
 
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -1057,6 +1057,7 @@ class itself will store the flag and the ``_on_timer`` method should be
         timer events. This list can be manipulated directly, or the
         functions `add_callback` and `remove_callback` can be used.
     """
+
     def __init__(self, interval=None, callbacks=None):
         #Initialize empty callbacks list and setup default settings if necssary
         if callbacks is None:
@@ -2222,15 +2223,19 @@ def mpl_disconnect(self, cid):
         """
         return self.callbacks.disconnect(cid)
 
-    def new_timer(self, *args, **kwargs):
+    # Internal subclasses can override _timer_cls instead of new_timer, though
+    # this is not a public API for third-party subclasses.
+    _timer_cls = TimerBase
+
+    def new_timer(self, interval=None, callbacks=None):
         """
         Create a new backend-specific subclass of `.Timer`.
 
         This is useful for getting periodic events through the backend's native
         event loop.  Implemented only for backends with GUIs.
 
-        Other Parameters
-        ----------------
+        Parameters
+        ----------
         interval : int
             Timer interval in milliseconds.
 
@@ -2243,9 +2248,9 @@ def new_timer(self, *args, **kwargs):
 
         Examples
         --------
-        >>> timer = fig.canvas.new_timer(callbacks=[(f1, (1, ), {'a': 3}),])
+        >>> timer = fig.canvas.new_timer(callbacks=[(f1, (1,), {'a': 3})])
         """
-        return TimerBase(*args, **kwargs)
+        return self._timer_cls(interval=interval, callbacks=callbacks)
 
     def flush_events(self):
         """
diff --git a/lib/matplotlib/backends/backend_gtk3.py b/lib/matplotlib/backends/backend_gtk3.py
@@ -98,6 +98,7 @@ def _on_timer(self):
 
 class FigureCanvasGTK3(Gtk.DrawingArea, FigureCanvasBase):
     required_interactive_framework = "gtk3"
+    _timer_cls = TimerGTK3
 
     keyvald = {65507: 'control',
                65505: 'shift',
@@ -305,10 +306,6 @@ def idle_draw(*args):
             return False
         self._idle_draw_id = GLib.idle_add(idle_draw)
 
-    def new_timer(self, *args, **kwargs):
-        # docstring inherited
-        return TimerGTK3(*args, **kwargs)
-
     def flush_events(self):
         # docstring inherited
         Gdk.threads_enter()
diff --git a/lib/matplotlib/backends/backend_macosx.py b/lib/matplotlib/backends/backend_macosx.py
@@ -55,6 +55,7 @@ class FigureCanvasMac(_macosx.FigureCanvas, FigureCanvasAgg):
     """
 
     required_interactive_framework = "macosx"
+    _timer_cls = TimerMac
 
     def __init__(self, figure):
         FigureCanvasBase.__init__(self, figure)
@@ -99,10 +100,6 @@ def resize(self, width, height):
         FigureCanvasBase.resize_event(self)
         self.draw_idle()
 
-    def new_timer(self, *args, **kwargs):
-        # docstring inherited
-        return TimerMac(*args, **kwargs)
-
 
 class FigureManagerMac(_macosx.FigureManager, FigureManagerBase):
     """
diff --git a/lib/matplotlib/backends/backend_nbagg.py b/lib/matplotlib/backends/backend_nbagg.py
@@ -142,9 +142,7 @@ def remove_comm(self, comm_id):
 
 
 class FigureCanvasNbAgg(FigureCanvasWebAggCore):
-    def new_timer(self, *args, **kwargs):
-        # docstring inherited
-        return TimerTornado(*args, **kwargs)
+    _timer_cls = TimerTornado
 
 
 class CommSocket:
diff --git a/lib/matplotlib/backends/backend_qt5.py b/lib/matplotlib/backends/backend_qt5.py
@@ -215,6 +215,7 @@ def _timer_stop(self):
 
 class FigureCanvasQT(QtWidgets.QWidget, FigureCanvasBase):
     required_interactive_framework = "qt5"
+    _timer_cls = TimerQT
 
     # map Qt button codes to MouseEvent's ones:
     buttond = {QtCore.Qt.LeftButton: MouseButton.LEFT,
@@ -434,10 +435,6 @@ def _get_key(self, event):
         mods.reverse()
         return '+'.join(mods + [key])
 
-    def new_timer(self, *args, **kwargs):
-        # docstring inherited
-        return TimerQT(*args, **kwargs)
-
     def flush_events(self):
         # docstring inherited
         qApp.processEvents()
diff --git a/lib/matplotlib/backends/backend_webagg.py b/lib/matplotlib/backends/backend_webagg.py
@@ -48,15 +48,13 @@ def run(self):
 
 
 class FigureCanvasWebAgg(core.FigureCanvasWebAggCore):
+    _timer_cls = TimerTornado
+
     def show(self):
         # show the figure window
         global show  # placates pyflakes: created by @_Backend.export below
         show()
 
-    def new_timer(self, *args, **kwargs):
-        # docstring inherited
-        return TimerTornado(*args, **kwargs)
-
 
 class WebAggApplication(tornado.web.Application):
     initialized = False
diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -86,11 +86,6 @@ class TimerWx(TimerBase):
     """
 
     def __init__(self, *args, **kwargs):
-        if args and isinstance(args[0], wx.EvtHandler):
-            cbook.warn_deprecated(
-                "3.0", message="Passing a wx.EvtHandler as first argument to "
-                "the TimerWx constructor is deprecated since %(since)s.")
-            args = args[1:]
         TimerBase.__init__(self, *args, **kwargs)
         self._timer = wx.Timer()
         self._timer.Notify = self._on_timer
@@ -468,6 +463,7 @@ class _FigureCanvasWxBase(FigureCanvasBase, wx.Panel):
     """
 
     required_interactive_framework = "wx"
+    _timer_cls = TimerWx
 
     keyvald = {
         wx.WXK_CONTROL: 'control',
@@ -598,10 +594,6 @@ def draw_idle(self):
         # a good time (usually as soon as there are no other events pending).
         self.Refresh(eraseBackground=False)
 
-    def new_timer(self, *args, **kwargs):
-        # docstring inherited
-        return TimerWx(*args, **kwargs)
-
     def flush_events(self):
         # docstring inherited
         wx.Yield()
