improved consistency of return types for better typing

trygvrad · trygvrad · commit 053e524fc6f0 · 2025-12-01T15:27:53.000+01:00
diff --git a/lib/matplotlib/colorizer.py b/lib/matplotlib/colorizer.py
@@ -278,7 +278,10 @@ def get_clim(self):
         """
         Return the values (min, max) that are mapped to the colormap limits.
         """
-        return self.norm.vmin, self.norm.vmax
+        if self.norm.n_components == 1:
+            return (self.norm.vmin, ), (self.norm.vmax, )
+        else:
+            return self.norm.vmin, self.norm.vmax
 
     def changed(self):
         """
@@ -306,7 +309,10 @@ def vmax(self, vmax):
 
     @property
     def clip(self):
-        return self.norm.clip
+        if self.norm.n_components == 1:
+            return (self.norm.clip, )
+        else:
+            return self.norm.clip
 
     @clip.setter
     def clip(self, clip):
@@ -360,8 +366,14 @@ def to_rgba(self, x, alpha=None, bytes=False, norm=True):
     def get_clim(self):
         """
         Return the values (min, max) that are mapped to the colormap limits.
+
+        This function is not available for multivariate data.
         """
-        return self._colorizer.get_clim()
+        if self._colorizer.norm.n_components > 1:
+            raise AttributeError("`.get_clim()` is unavailable when using a colormap "
+                                 "with multiple components. Use "
+                                 "`.colorizer.get_clim()` instead")
+        return self.colorizer.norm.vmin, self.colorizer.norm.vmax
 
     def set_clim(self, vmin=None, vmax=None):
         """
@@ -376,9 +388,15 @@ def set_clim(self, vmin=None, vmax=None):
              tuple (*vmin*, *vmax*) as a single positional argument.
 
              .. ACCEPTS: (vmin: float, vmax: float)
+
+        This function is not available for multivariate data.
         """
         # If the norm's limits are updated self.changed() will be called
         # through the callbacks attached to the norm
+        if self._colorizer.norm.n_components > 1:
+            raise AttributeError("`.set_clim(vmin, vmax)` is unavailable "
+                                 "when using a colormap with multiple components. Use "
+                                 "`.colorizer.set_clim(vmin, vmax)` instead")
         self._colorizer.set_clim(vmin, vmax)
 
     def get_alpha(self):
diff --git a/lib/matplotlib/colorizer.pyi b/lib/matplotlib/colorizer.pyi
@@ -15,7 +15,7 @@ class Colorizer:
     @property
     def norm(self) -> colors.Norm: ...
     @norm.setter
-    def norm(self, norm: colors.Norm | str | tuple[str] | None) -> None: ...
+    def norm(self, norm: colors.Norm | str | tuple[str, ...] | None) -> None: ...
     def to_rgba(
         self,
         x: np.ndarray,
@@ -29,21 +29,21 @@ class Colorizer:
     def cmap(self) -> colors.Colormap | colors.BivarColormap | colors.MultivarColormap: ...
     @cmap.setter
     def cmap(self, cmap: colors.Colormap | colors.BivarColormap | colors.MultivarColormap | str | None) -> None: ...
-    def get_clim(self) -> tuple[float, float]: ...
-    def set_clim(self, vmin: float | tuple[float, float] | None = ..., vmax: float | None = ...) -> None: ...
+    def get_clim(self) -> tuple[tuple[float | None, ...], tuple[float | None, ...]]: ...
+    def set_clim(self, vmin: float | tuple[float | None, ...] | None = ..., vmax: float | tuple[float | None, ...] | None = ...) -> None: ...
     def changed(self) -> None: ...
     @property
-    def vmin(self) -> float | tuple[float] | None: ...
+    def vmin(self) -> tuple[float | None, ...] | None: ...
     @vmin.setter
-    def vmin(self, value: float | tuple[float] | None) -> None: ...
+    def vmin(self, value: tuple[float | None, ...] | None) -> None: ...
     @property
-    def vmax(self) -> float | tuple[float] | None: ...
+    def vmax(self) -> tuple[float | None, ...] | None: ...
     @vmax.setter
-    def vmax(self, value: float | tuple[float] | None) -> None: ...
+    def vmax(self, value: tuple[float | None, ...] | None) -> None: ...
     @property
-    def clip(self) -> bool | tuple[bool, ...]: ...
+    def clip(self) -> tuple[bool, ...]: ...
     @clip.setter
-    def clip(self, value: ArrayLike | bool) -> None: ...
+    def clip(self, value: ArrayLike | bool | tuple[bool, ...]) -> None: ...
 
 
 class _ColorizerInterface:
@@ -57,8 +57,8 @@ class _ColorizerInterface:
         bytes: bool = ...,
         norm: bool = ...,
     ) -> np.ndarray: ...
-    def get_clim(self) -> tuple[float, float]: ...
-    def set_clim(self, vmin: float | tuple[float, float] | None = ..., vmax: float | None = ...) -> None: ...
+    def get_clim(self) -> tuple[float, float] | tuple[tuple[float, ...], tuple[float, ...]]: ...
+    def set_clim(self, vmin: float | tuple[float, float] | tuple[float | None, ...] | None = ..., vmax: float | tuple[float | None, ...] | None = ...) -> None: ...
     def get_alpha(self) -> float | None: ...
     def get_cmap(self) -> colors.Colormap | colors.BivarColormap | colors.MultivarColormap: ...
     def set_cmap(self, cmap: str | colors.Colormap | colors.BivarColormap | colors.MultivarColormap) -> None: ...
diff --git a/lib/matplotlib/colors.pyi b/lib/matplotlib/colors.pyi
@@ -255,13 +255,13 @@ class Norm(ABC):
     def __init__(self) -> None: ...
     @property
     @abstractmethod
-    def vmin(self) -> float | tuple[float] | None: ...
+    def vmin(self) -> float | tuple[float | None, ...] | None: ...
     @property
     @abstractmethod
-    def vmax(self) -> float | tuple[float] | None: ...
+    def vmax(self) -> float | tuple[float | None, ...] | None: ...
     @property
     @abstractmethod
-    def clip(self) -> bool | tuple[bool]: ...
+    def clip(self) -> bool | tuple[bool, ...]: ...
     @abstractmethod
     def __call__(self, value: np.ndarray, clip: bool | None = ...) -> ArrayLike: ...
     @abstractmethod
diff --git a/lib/matplotlib/tests/test_colors.py b/lib/matplotlib/tests/test_colors.py
@@ -1786,16 +1786,30 @@ def test_is_color_like(input, expected):
     assert is_color_like(input) is expected
 
 
-def test_colorizer_vmin_vmax():
+def test_colorizer_vmin_vmax_clip():
     ca = mcolorizer.Colorizer()
-    assert ca.vmin is None
-    assert ca.vmax is None
+    assert len(ca.vmin) == 1
+    assert len(ca.vmax) == 1
+    assert ca.vmin[0] is None
+    assert ca.vmax[0] is None
     ca.vmin = 1
     ca.vmax = 3
-    assert ca.vmin == 1.0
-    assert ca.vmax == 3.0
+    assert ca.vmin == (1.0, )
+    assert ca.vmax == (3.0, )
     assert ca.norm.vmin == 1.0
     assert ca.norm.vmax == 3.0
+    assert ca.clip == (False, )
+
+    ca = mcolorizer.Colorizer('BiOrangeBlue')
+    assert len(ca.vmin) == 2
+    assert len(ca.vmax) == 2
+    ca.vmin = (1, 2)
+    ca.vmax = (3, 4)
+    assert ca.vmin == (1.0, 2.0)
+    assert ca.vmax == (3.0, 4.0)
+    assert ca.norm.vmin == (1.0, 2.0)
+    assert ca.norm.vmax == (3.0, 4.0)
+    assert ca.clip == (False, False)
 
 
 def test_LinearSegmentedColormap_from_list_color_alpha_tuple():
