Blocked set_clim() callbacks to prevent inconsistent state (#29522) (#29590)

prafulgulani · web-flow · commit 07371dbef1a6 · 2025-02-28T16:24:41.000+01:00
* Blocked set_clim() callbacks to prevent inconsistent state (#29522) * added test for set_clim() callback count * Relocated test_set_clim_emits_single_callback to test_colors.py * test case corrections --------- Co-authored-by: prafulgulani555 <59774145+prafulgulani555@users.noreply.github.com>
diff --git a/lib/matplotlib/colorizer.py b/lib/matplotlib/colorizer.py
@@ -261,16 +261,27 @@ def set_clim(self, vmin=None, vmax=None):
              .. ACCEPTS: (vmin: float, vmax: float)
         """
         # If the norm's limits are updated self.changed() will be called
-        # through the callbacks attached to the norm
+        # through the callbacks attached to the norm, this causes an inconsistent
+        # state, to prevent this blocked context manager is used
         if vmax is None:
             try:
                 vmin, vmax = vmin
             except (TypeError, ValueError):
                 pass
-        if vmin is not None:
-            self.norm.vmin = colors._sanitize_extrema(vmin)
-        if vmax is not None:
-            self.norm.vmax = colors._sanitize_extrema(vmax)
+
+        orig_vmin_vmax = self.norm.vmin, self.norm.vmax
+
+        # Blocked context manager prevents callbacks from being triggered
+        # until both vmin and vmax are updated
+        with self.norm.callbacks.blocked(signal='changed'):
+            if vmin is not None:
+                self.norm.vmin = colors._sanitize_extrema(vmin)
+            if vmax is not None:
+                self.norm.vmax = colors._sanitize_extrema(vmax)
+
+        # emit a update signal if the limits are changed
+        if orig_vmin_vmax != (self.norm.vmin, self.norm.vmax):
+            self.norm.callbacks.process('changed')
 
     def get_clim(self):
         """
diff --git a/lib/matplotlib/tests/test_colors.py b/lib/matplotlib/tests/test_colors.py
@@ -1605,6 +1605,23 @@ def test_norm_deepcopy():
     assert norm2.vmin == norm.vmin
 
 
+def test_set_clim_emits_single_callback():
+    data = np.array([[1, 2], [3, 4]])
+    fig, ax = plt.subplots()
+    image = ax.imshow(data, cmap='viridis')
+
+    callback = unittest.mock.Mock()
+    image.norm.callbacks.connect('changed', callback)
+
+    callback.assert_not_called()
+
+    # Call set_clim() to update the limits
+    image.set_clim(1, 5)
+
+    # Assert that only one "changed" callback is sent after calling set_clim()
+    callback.assert_called_once()
+
+
 def test_norm_callback():
     increment = unittest.mock.Mock(return_value=None)
 
