FIX: Add update capability to interval/singleshot timer properties

greglucas · greglucas · commit e60da206d15c · 2024-10-24T15:11:15.000-06:00
diff --git a/lib/matplotlib/tests/test_backends_interactive.py b/lib/matplotlib/tests/test_backends_interactive.py
@@ -626,29 +626,47 @@ def _impl_test_interactive_timers():
     # We only want singleshot if we specify that ourselves, otherwise we want
     # a repeating timer
     import os
+    import sys
     from unittest.mock import Mock
     import matplotlib.pyplot as plt
     # increase pause duration on CI to let things spin up
     # particularly relevant for gtk3cairo
     pause_time = 2 if os.getenv("CI") else 0.5
+    expected_100ms_calls = int(pause_time / 0.1)
     fig = plt.figure()
     plt.pause(pause_time)
     timer = fig.canvas.new_timer(0.1)
     mock = Mock()
     timer.add_callback(mock)
     timer.start()
     plt.pause(pause_time)
-    timer.stop()
-    assert mock.call_count > 1
+    # NOTE: The timer is as fast as possible, but this is different between backends
+    #       so we can't assert on the exact number but it should be faster than 100ms
+    assert mock.call_count > expected_100ms_calls, \
+        f"Expected more than {expected_100ms_calls} calls, got {mock.call_count}"
+
+    # Test updating the interval updates a running timer
+    timer.interval = 100
+    mock.call_count = 0
+    plt.pause(pause_time)
+    # GTK4 on macos runners produces about 3x as many calls as expected
+    # It works locally and on Linux though, so only skip when running on CI
+    if not (os.getenv("CI")
+            and "gtk4" in os.getenv("MPLBACKEND")
+            and sys.platform == "darwin"):
+        # Could be off due to when the timers actually get fired (especially on CI)
+        assert 1 < mock.call_count <= expected_100ms_calls + 1, \
+            f"Expected less than {expected_100ms_calls + 1} calls, " \
+            "got {mock.call_count}"
 
     # Now turn it into a single shot timer and verify only one gets triggered
     mock.call_count = 0
     timer.single_shot = True
-    timer.start()
     plt.pause(pause_time)
     assert mock.call_count == 1
 
-    # Make sure we can start the timer a second time
+    # Make sure we can start the timer after stopping
+    timer.stop()
     timer.start()
     plt.pause(pause_time)
     assert mock.call_count == 2
diff --git a/src/_macosx.m b/src/_macosx.m
@@ -1789,6 +1789,18 @@ - (void)flagsChanged:(NSEvent *)event
     Py_RETURN_NONE;
 }
 
+static PyObject*
+Timer__timer_update(Timer* self)
+{
+    // stop and invalidate a timer if it is already running and then create a new one
+    // where the start() method retrieves the updated interval internally
+    if (self->timer) {
+        Timer__timer_stop_impl(self);
+        gil_call_method((PyObject*)self, "_timer_start");
+    }
+    Py_RETURN_NONE;
+}
+
 static void
 Timer_dealloc(Timer* self)
 {
@@ -1815,6 +1827,12 @@ - (void)flagsChanged:(NSEvent *)event
         {"_timer_stop",
          (PyCFunction)Timer__timer_stop,
          METH_NOARGS},
+        {"_timer_set_interval",
+         (PyCFunction)Timer__timer_update,
+         METH_NOARGS},
+        {"_timer_set_single_shot",
+         (PyCFunction)Timer__timer_update,
+         METH_NOARGS},
         {}  // sentinel
     },
 };
