Commit38d7e06

committed

Deprecate implicit creation of colormaps in register_cmap()

1 parentaa18f5a commit38d7e06Copy full SHA for 38d7e06

File tree

+18

-2

lines changed

+18

-2

lines changed

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -47,3 +47,10 @@ PDF and PS character tracking internals`
`47`	`47`	The ``used_characters`` attribute and ``track_characters`` and
`48`	`48`	``merge_used_characters`` methods of `.RendererPdf`, `.PdfFile`, and
`49`	`49`	`.RendererPS` are deprecated.
	`50`	`+`
	`51`	+Passing raw data to ``register_cmap()``
	`52`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
	`53`	+Passing raw data via parameters data and lut to `.register_cmap()` is
	`54`	+deprecated. Instead, explicitly create a `.LinearSegmentedColormap` and pass
	`55`	`+it via the cmap parameter:`
	`56`	+``register_cmap(cmap=LinearSegmentedColormap(name, data, lut))``.

Lines changed: 11 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -90,9 +90,11 @@ def register_cmap(name=None, cmap=None, data=None, lut=None):`
`90`	`90`	`instance. The name is optional; if absent, the name will`
`91`	`91`	be the :attr:`~matplotlib.colors.Colormap.name` attribute of the cmap.
`92`	`92`
`93`		`-In thesecond case, the three arguments are passed to`
	`93`	`+Thesecond case is deprecated. Here, the three arguments are passed to`
`94`	`94`	the :class:`~matplotlib.colors.LinearSegmentedColormap` initializer,
`95`		`- and the resulting colormap is registered.`
	`95`	`+ and the resulting colormap is registered. Instead of this implicit`
	`96`	+ colormap creation, create a `.LinearSegmentedColormap` and use the first
	`97`	+ case: ``register_cmap(cmap=LinearSegmentedColormap(name, data, lut))``.
`96`	`98`	`"""`
`97`	`99`	`cbook._check_isinstance((str,None),name=name)`
`98`	`100`	`ifnameisNone:`
`@@ -103,6 +105,13 @@ def register_cmap(name=None, cmap=None, data=None, lut=None):`
`103`	`105`	`ifisinstance(cmap,colors.Colormap):`
`104`	`106`	`cmap_d[name]=cmap`
`105`	`107`	`return`
	`108`	`+iflutisnotNoneordataisnotNone:`
	`109`	`+cbook.warn_deprecated(`
	`110`	`+"3.3",`
	`111`	`+message="Passing raw data via parameters data and lut to "`
	`112`	`+"register_cmap() is deprecated. Instead use: "`
	`113`	`+"register_cmap("`
	`114`	`+"cmap=LinearSegmentedColormap(name, data, lut))")`
`106`	`115`	`# For the remainder, let exceptions propagate.`
`107`	`116`	`iflutisNone:`
`108`	`117`	`lut=mpl.rcParams['image.lut']`

Comments

(0)