Merge branch 'matplotlib:main' into logo_guide

Author: jeromefv

doc/_static/switcher.json

@@ -1,7 +1,7 @@
 [
     {
         "name": "3.10 (stable)",
-        "version": "3.10.3",
+        "version": "3.10.5",
         "url": "https://matplotlib.org/stable/",
         "preferred": true
     },

doc/users/next_whats_new/barcontainer_properties.rst

@@ -0,0 +1,7 @@
+``BarContainer`` properties
+---------------------------
+`.BarContainer` gained new properties to easily access coordinates of the bars:
+
+- `~.BarContainer.bottoms`
+- `~.BarContainer.tops`
+- `~.BarContainer.position_centers`

doc/users/next_whats_new/sliders_callable_valfmt.rst

@@ -0,0 +1,6 @@
+Callable *valfmt* for ``Slider`` and ``RangeSlider``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In addition to the existing %-format string, the *valfmt* parameter of
+`~.matplotlib.widgets.Slider` and `~.matplotlib.widgets.RangeSlider` now
+also accepts a callable of the form ``valfmt(val: float) -> str``.

lib/matplotlib/container.py

@@ -73,6 +73,48 @@ def __init__(self, patches, errorbar=None, *, datavalues=None,
         self.orientation = orientation
         super().__init__(patches, **kwargs)
 
+    @property
+    def bottoms(self):
+        """
+        Return the values at the lower end of the bars.
+
+        .. versionadded:: 3.11
+        """
+        if self.orientation == 'vertical':
+            return [p.get_y() for p in self.patches]
+        elif self.orientation == 'horizontal':
+            return [p.get_x() for p in self.patches]
+        else:
+            raise ValueError("orientation must be 'vertical' or 'horizontal'.")
+
+    @property
+    def tops(self):
+        """
+        Return the values at the upper end of the bars.
+
+        .. versionadded:: 3.11
+        """
+        if self.orientation == 'vertical':
+            return [p.get_y() + p.get_height() for p in self.patches]
+        elif self.orientation == 'horizontal':
+            return [p.get_x() + p.get_width() for p in self.patches]
+        else:
+            raise ValueError("orientation must be 'vertical' or 'horizontal'.")
+
+    @property
+    def position_centers(self):
+        """
+        Return the centers of bar positions.
+
+        .. versionadded:: 3.11
+        """
+        if self.orientation == 'vertical':
+            return [p.get_x() + p.get_width() / 2 for p in self.patches]
+        elif self.orientation == 'horizontal':
+            return [p.get_y() + p.get_height() / 2 for p in self.patches]
+        else:
+            raise ValueError("orientation must be 'vertical' or 'horizontal'.")
+
 
 class ErrorbarContainer(Container):
     """

lib/matplotlib/container.pyi

@@ -32,6 +32,12 @@ class BarContainer(Container):
         orientation: Literal["vertical", "horizontal"] | None = ...,
         **kwargs
     ) -> None: ...
+    @property
+    def bottoms(self) -> list[float]: ...
+    @property
+    def tops(self) -> list[float]: ...
+    @property
+    def position_centers(self) -> list[float]: ...
 
 class ErrorbarContainer(Container):
     lines: tuple[Line2D, tuple[Line2D, ...], tuple[LineCollection, ...]]

lib/matplotlib/tests/test_backend_qt.py

@@ -15,6 +15,7 @@
 from matplotlib import _c_internal_utils
 
 try:
+    from matplotlib.backends.qt_compat import QtCore  # type: ignore[attr-defined]
     from matplotlib.backends.qt_compat import QtGui  # type: ignore[attr-defined]  # noqa: E501, F401
     from matplotlib.backends.qt_compat import QtWidgets  # type: ignore[attr-defined]
     from matplotlib.backends.qt_editor import _formlayout
@@ -25,12 +26,6 @@
 _test_timeout = 60  # A reasonably safe value for slower architectures.
 
 
-@pytest.fixture
-def qt_core(request):
-    from matplotlib.backends.qt_compat import QtCore
-    return QtCore
-
-
 @pytest.mark.backend('QtAgg', skip_on_importerror=True)
 def test_fig_close():
 
@@ -101,7 +96,7 @@ def test_fig_close():
         'QtAgg',
         marks=pytest.mark.backend('QtAgg', skip_on_importerror=True)),
 ])
-def test_correct_key(backend, qt_core, qt_key, qt_mods, answer, monkeypatch):
+def test_correct_key(backend, qt_key, qt_mods, answer, monkeypatch):
     """
     Make a figure.
     Send a key_press_event event (using non-public, qtX backend specific api).
@@ -137,7 +132,7 @@ def on_key_press(event):
 
 
 @pytest.mark.backend('QtAgg', skip_on_importerror=True)
-def test_device_pixel_ratio_change(qt_core):
+def test_device_pixel_ratio_change():
     """
     Make sure that if the pixel ratio changes, the figure dpi changes but the
     widget remains the same logical size.
@@ -155,12 +150,11 @@ def set_device_pixel_ratio(ratio):
             p.return_value = ratio
 
             window = qt_canvas.window().windowHandle()
-            current_version = tuple(
-                int(x) for x in qt_core.qVersion().split('.', 2)[:2])
+            current_version = tuple(int(x) for x in QtCore.qVersion().split('.', 2)[:2])
             if current_version >= (6, 6):
-                qt_core.QCoreApplication.sendEvent(
+                QtCore.QCoreApplication.sendEvent(
                     window,
-                    qt_core.QEvent(qt_core.QEvent.Type.DevicePixelRatioChange))
+                    QtCore.QEvent(QtCore.QEvent.Type.DevicePixelRatioChange))
             else:
                 # The value here doesn't matter, as we can't mock the C++ QScreen
                 # object, but can override the functional wrapper around it.
@@ -342,7 +336,7 @@ def _get_testable_qt_backends():
 
 
 @pytest.mark.backend('QtAgg', skip_on_importerror=True)
-def test_fig_sigint_override(qt_core):
+def test_fig_sigint_override():
     from matplotlib.backends.backend_qt5 import _BackendQT5
     # Create a figure
     plt.figure()
@@ -357,10 +351,10 @@ def fire_signal_and_quit():
         event_loop_handler = signal.getsignal(signal.SIGINT)
 
         # Request event loop exit
-        qt_core.QCoreApplication.exit()
+        QtCore.QCoreApplication.exit()
 
     # Timer to exit event loop
-    qt_core.QTimer.singleShot(0, fire_signal_and_quit)
+    QtCore.QTimer.singleShot(0, fire_signal_and_quit)
 
     # Save original SIGINT handler
     original_handler = signal.getsignal(signal.SIGINT)
@@ -385,7 +379,7 @@ def custom_handler(signum, frame):
 
         # Repeat again to test that SIG_DFL and SIG_IGN will not be overridden
         for custom_handler in (signal.SIG_DFL, signal.SIG_IGN):
-            qt_core.QTimer.singleShot(0, fire_signal_and_quit)
+            QtCore.QTimer.singleShot(0, fire_signal_and_quit)
             signal.signal(signal.SIGINT, custom_handler)
 
             _BackendQT5.mainloop()

lib/matplotlib/tests/test_container.py

@@ -1,4 +1,5 @@
 import numpy as np
+from numpy.testing import assert_array_equal
 import matplotlib.pyplot as plt
 
 
@@ -35,3 +36,20 @@ def test_nonstring_label():
     # Test for #26824
     plt.bar(np.arange(10), np.random.rand(10), label=1)
     plt.legend()
+
+
+def test_barcontainer_position_centers__bottoms__tops():
+    fig, ax = plt.subplots()
+    pos = [1, 2, 4]
+    bottoms = np.array([1, 5, 3])
+    heights = np.array([2, 3, 4])
+
+    container = ax.bar(pos, heights, bottom=bottoms)
+    assert_array_equal(container.position_centers, pos)
+    assert_array_equal(container.bottoms, bottoms)
+    assert_array_equal(container.tops, bottoms + heights)
+
+    container = ax.barh(pos, heights, left=bottoms)
+    assert_array_equal(container.position_centers, pos)
+    assert_array_equal(container.bottoms, bottoms)
+    assert_array_equal(container.tops, bottoms + heights)

lib/matplotlib/widgets.py

@@ -370,8 +370,9 @@ def __init__(self, ax, label, valmin, valmax, *, valinit=0.5, valfmt=None,
             The slider initial position.
 
         valfmt : str, default: None
-            %-format string used to format the slider value.  If None, a
-            `.ScalarFormatter` is used instead.
+            The way to format the slider value. If a string, it must be in %-format.
+            If a callable, it must have the signature ``valfmt(val: float) -> str``.
+            If None, a `.ScalarFormatter` is used.
 
         closedmin : bool, default: True
             Whether the slider interval is closed on the bottom.
@@ -553,7 +554,10 @@ def _update(self, event):
     def _format(self, val):
         """Pretty-print *val*."""
         if self.valfmt is not None:
-            return self.valfmt % val
+            if callable(self.valfmt):
+                return self.valfmt(val)
+            else:
+                return self.valfmt % val
         else:
             _, s, _ = self._fmt.format_ticks([self.valmin, val, self.valmax])
             # fmt.get_offset is actually the multiplicative factor, if any.
@@ -650,9 +654,11 @@ def __init__(
             The initial positions of the slider. If None the initial positions
             will be at the 25th and 75th percentiles of the range.
 
-        valfmt : str, default: None
-            %-format string used to format the slider values.  If None, a
-            `.ScalarFormatter` is used instead.
+        valfmt : str or callable, default: None
+            The way to format the range's minimal and maximal values. If a
+            string, it must be in %-format. If a callable, it must have the
+            signature ``valfmt(val: float) -> str``. If None, a
+            `.ScalarFormatter` is used.
 
         closedmin : bool, default: True
             Whether the slider interval is closed on the bottom.
@@ -896,7 +902,10 @@ def _update(self, event):
     def _format(self, val):
         """Pretty-print *val*."""
         if self.valfmt is not None:
-            return f"({self.valfmt % val[0]}, {self.valfmt % val[1]})"
+            if callable(self.valfmt):
+                return f"({self.valfmt(val[0])}, {self.valfmt(val[1])})"
+            else:
+                return f"({self.valfmt % val[0]}, {self.valfmt % val[1]})"
         else:
             _, s1, s2, _ = self._fmt.format_ticks(
                 [self.valmin, *val, self.valmax]

lib/matplotlib/widgets.pyi

@@ -64,7 +64,7 @@ class SliderBase(AxesWidget):
     valmax: float
     valstep: float | ArrayLike | None
     drag_active: bool
-    valfmt: str
+    valfmt: str | Callable[[float], str] | None
     def __init__(
         self,
         ax: Axes,
@@ -73,7 +73,7 @@ class SliderBase(AxesWidget):
         closedmax: bool,
         valmin: float,
         valmax: float,
-        valfmt: str,
+        valfmt: str | Callable[[float], str] | None,
         dragging: Slider | None,
         valstep: float | ArrayLike | None,
     ) -> None: ...
@@ -130,7 +130,7 @@ class RangeSlider(SliderBase):
         valmax: float,
         *,
         valinit: tuple[float, float] | None = ...,
-        valfmt: str | None = ...,
+        valfmt: str | Callable[[float], str] | None = ...,
         closedmin: bool = ...,
         closedmax: bool = ...,
         dragging: bool = ...,