Combine common GTK timer code.

Author: QuLogic

lib/matplotlib/backends/_backend_gtk.py

@@ -7,12 +7,12 @@
 import matplotlib as mpl
 from matplotlib import cbook
 from matplotlib.backend_bases import (
-    _Backend,
+    _Backend, TimerBase,
 )
 
 # The GTK3/GTK4 backends will have already called `gi.require_version` to set
 # the desired GTK.
-from gi.repository import Gio, Gtk
+from gi.repository import Gio, GLib, Gtk
 
 
 _log = logging.getLogger(__name__)
@@ -62,6 +62,42 @@ def _create_application():
     return _application
 
 
+class TimerGTK(TimerBase):
+    """Subclass of `.TimerBase` using GTK timer events."""
+
+    def __init__(self, *args, **kwargs):
+        self._timer = None
+        super().__init__(*args, **kwargs)
+
+    def _timer_start(self):
+        # Need to stop it, otherwise we potentially leak a timer id that will
+        # never be stopped.
+        self._timer_stop()
+        self._timer = GLib.timeout_add(self._interval, self._on_timer)
+
+    def _timer_stop(self):
+        if self._timer is not None:
+            GLib.source_remove(self._timer)
+            self._timer = None
+
+    def _timer_set_interval(self):
+        # Only stop and restart it if the timer has already been started.
+        if self._timer is not None:
+            self._timer_stop()
+            self._timer_start()
+
+    def _on_timer(self):
+        super()._on_timer()
+
+        # Gtk timeout_add() requires that the callback returns True if it
+        # is to be called again.
+        if self.callbacks and not self._single:
+            return True
+        else:
+            self._timer = None
+            return False
+
+
 class _BackendGTK(_Backend):
     @staticmethod
     def mainloop():

lib/matplotlib/backends/backend_gtk3.py

@@ -31,7 +31,9 @@
 from gi.repository import Gio, GLib, GObject, Gtk, Gdk
 from ._backend_gtk import (
     _create_application, _shutdown_application,
-    backend_version, _BackendGTK)
+    backend_version, _BackendGTK,
+    TimerGTK as TimerGTK3,
+)
 
 
 _log = logging.getLogger(__name__)
@@ -70,42 +72,6 @@ def _mpl_to_gtk_cursor(mpl_cursor):
     return Gdk.Cursor.new_from_name(Gdk.Display.get_default(), name)
 
 
-class TimerGTK3(TimerBase):
-    """Subclass of `.TimerBase` using GTK3 timer events."""
-
-    def __init__(self, *args, **kwargs):
-        self._timer = None
-        super().__init__(*args, **kwargs)
-
-    def _timer_start(self):
-        # Need to stop it, otherwise we potentially leak a timer id that will
-        # never be stopped.
-        self._timer_stop()
-        self._timer = GLib.timeout_add(self._interval, self._on_timer)
-
-    def _timer_stop(self):
-        if self._timer is not None:
-            GLib.source_remove(self._timer)
-            self._timer = None
-
-    def _timer_set_interval(self):
-        # Only stop and restart it if the timer has already been started
-        if self._timer is not None:
-            self._timer_stop()
-            self._timer_start()
-
-    def _on_timer(self):
-        super()._on_timer()
-
-        # Gtk timeout_add() requires that the callback returns True if it
-        # is to be called again.
-        if self.callbacks and not self._single:
-            return True
-        else:
-            self._timer = None
-            return False
-
-
 class FigureCanvasGTK3(Gtk.DrawingArea, FigureCanvasBase):
     required_interactive_framework = "gtk3"
     _timer_cls = TimerGTK3

lib/matplotlib/backends/backend_gtk4.py

@@ -32,7 +32,9 @@
 from gi.repository import Gio, GLib, GObject, Gtk, Gdk, GdkPixbuf
 from ._backend_gtk import (
     _create_application, _shutdown_application,
-    backend_version, _BackendGTK)
+    backend_version, _BackendGTK,
+    TimerGTK as TimerGTK4,
+)
 
 
 _log = logging.getLogger(__name__)
@@ -50,42 +52,6 @@ def _mpl_to_gtk_cursor(mpl_cursor):
     }, cursor=mpl_cursor)
 
 
-class TimerGTK4(TimerBase):
-    """Subclass of `.TimerBase` using GTK4 timer events."""
-
-    def __init__(self, *args, **kwargs):
-        self._timer = None
-        super().__init__(*args, **kwargs)
-
-    def _timer_start(self):
-        # Need to stop it, otherwise we potentially leak a timer id that will
-        # never be stopped.
-        self._timer_stop()
-        self._timer = GLib.timeout_add(self._interval, self._on_timer)
-
-    def _timer_stop(self):
-        if self._timer is not None:
-            GLib.source_remove(self._timer)
-            self._timer = None
-
-    def _timer_set_interval(self):
-        # Only stop and restart it if the timer has already been started
-        if self._timer is not None:
-            self._timer_stop()
-            self._timer_start()
-
-    def _on_timer(self):
-        super()._on_timer()
-
-        # Gtk timeout_add() requires that the callback returns True if it
-        # is to be called again.
-        if self.callbacks and not self._single:
-            return True
-        else:
-            self._timer = None
-            return False
-
-
 class FigureCanvasGTK4(Gtk.DrawingArea, FigureCanvasBase):
     required_interactive_framework = "gtk4"
     _timer_cls = TimerGTK4