Jun 26, 2024 · Jun 6, 2024
diff --git a/lib/matplotlib/cm.py b/lib/matplotlib/cm.py
 globals().update(_colormaps)


 # This is an exact copy of pyplot.get_cmap(). It was removed in 3.9, but apparently
 # caused more user trouble than expected. Re-added for 3.9.1 and extended the
 # deprecation period for two additional minor releases.
 @_api.deprecated(
    '3.7',
    removal='3.11',
    alternative="``matplotlib.colormaps[name]`` or ``matplotlib.colormaps.get_cmap()``"
                " or ``pyplot.get_cmap()``"
    )
 def get_cmap(name=None, lut=None):
    """
    Get a colormap instance, defaulting to rc values if *name* is None.

    Parameters
    ----------
    name : `~matplotlib.colors.Colormap` or str or None, default: None
        If a `.Colormap` instance, it will be returned. Otherwise, the name of
        a colormap known to Matplotlib, which will be resampled by *lut*. The
        default, None, means :rc:`image.cmap`.
    lut : int or None, default: None
        If *name* is not already a Colormap instance and *lut* is not None, the
        colormap will be resampled to have *lut* entries in the lookup table.

    Returns
    -------
    Colormap
    """
    if name is None:
        name = mpl.rcParams['image.cmap']
    if isinstance(name, colors.Colormap):
        return name
    _api.check_in_list(sorted(_colormaps), name=name)
    if lut is None:
        return _colormaps[name]
    else:
        return _colormaps[name].resampled(lut)


 def _auto_norm_from_scale(scale_cls):
    """
    Automatically generate a norm class from *scale_cls*.
diff --git a/lib/matplotlib/cm.pyi b/lib/matplotlib/cm.pyi

 _colormaps: ColormapRegistry = ...

 def get_cmap(name: str | colors.Colormap | None = ..., lut: int | None = ...) -> colors.Colormap: ...

 class ScalarMappable:
    cmap: colors.Colormap | None
    colorbar: Colorbar | None
Original file line number	Diff line number	Diff line change
Expand Up		@@ -239,6 +239,44 @@
		globals().update(_colormaps)


		# This is an exact copy of pyplot.get_cmap(). It was removed in 3.9, but apparently
		# caused more user trouble than expected. Re-added for 3.9.1 and extended the
		# deprecation period for two additional minor releases.
		@_api.deprecated(
		'3.7',
		removal='3.11',
		alternative="``matplotlib.colormaps[name]`` or ``matplotlib.colormaps.get_cmap()``"
		" or ``pyplot.get_cmap()``"
		)
		def get_cmap(name=None, lut=None):
		"""
		Get a colormap instance, defaulting to rc values if name is None.

		Parameters
		----------
		name : `~matplotlib.colors.Colormap` or str or None, default: None
		If a `.Colormap` instance, it will be returned. Otherwise, the name of
		a colormap known to Matplotlib, which will be resampled by lut. The
		default, None, means :rc:`image.cmap`.
		lut : int or None, default: None
		If name is not already a Colormap instance and lut is not None, the
		colormap will be resampled to have lut entries in the lookup table.

		Returns
		-------
		Colormap
		"""
		if name is None:
		name = mpl.rcParams['image.cmap']
Check warning on line 270 in lib/matplotlib/cm.py View check run for this annotation Codecov/ codecov/patch lib/matplotlib/cm.py#L270 `Added line #L270 was not covered by tests`
		if isinstance(name, colors.Colormap):
		return name
		_api.check_in_list(sorted(_colormaps), name=name)
Check warning on line 273 in lib/matplotlib/cm.py View check run for this annotation Codecov/ codecov/patch lib/matplotlib/cm.py#L272-L273 `Added lines #L272 - L273 were not covered by tests`
		if lut is None:
		return _colormaps[name]
Check warning on line 275 in lib/matplotlib/cm.py View check run for this annotation Codecov/ codecov/patch lib/matplotlib/cm.py#L275 `Added line #L275 was not covered by tests`
		else:
		return _colormaps[name].resampled(lut)
Check warning on line 277 in lib/matplotlib/cm.py View check run for this annotation Codecov/ codecov/patch lib/matplotlib/cm.py#L277 `Added line #L277 was not covered by tests`


		def _auto_norm_from_scale(scale_cls):
		"""
		Automatically generate a norm class from scale_cls.
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,6 +19,8 @@ class ColormapRegistry(Mapping[str, colors.Colormap]):

		_colormaps: ColormapRegistry = ...

		def get_cmap(name: str \| colors.Colormap \| None = ..., lut: int \| None = ...) -> colors.Colormap: ...

		class ScalarMappable:
		cmap: colors.Colormap \| None
		colorbar: Colorbar \| None
Expand Down