Deprecate implicit creation of colormaps in register_cmap()#15875
Merged
Conversation
timhoffm
added
the
API: changes
dstansby
reviewed
Dec 8, 2019
timhoffm
force-pushed
the
deprecate-register_cmap-data
branch
from
7524ced to
38d7e06
Compare
tacaswell
approved these changes
Dec 8, 2019
tacaswell
left a comment
tacaswell
left a comment
Member
There was a problem hiding this comment.
Needs a re-base to resolve conflict in deprecation docs.
timhoffm
force-pushed
the
deprecate-register_cmap-data
branch
from
38d7e06 to
eb61e47
Compare
Member
Author
|
Rebase done. Taking the liberty to self-merge based on the two positive reviews. |
tacaswell
added a commit
to tacaswell/matplotlib
that referenced
this pull request
Sep 24, 2020
This was deprecated in 3.3 via matplotlib#15875
tacaswell
added a commit
to tacaswell/matplotlib
that referenced
this pull request
Sep 25, 2020
This was deprecated in 3.3 via matplotlib#15875 Enforce type of cmap as Colormap because we may not know that the object registered is of the wrong type until well after it was registered, defensively check here. We could do a duck-type check, but this is much simpler and we can cross the bridge of writing a duck-type checking function when someone has a use case for registering compatible-but-not-derived-from-Colormap instances.
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
register_cmap() could be used either with a Colormap, or by passing data to implicitly create a colormap from.
This PR deprecates the second way in favor of explicitly creating colormaps via
register_cmap(cmap=LinearSementedColormap(name, data lut)).Having both ways is redundant, makes the function more complicated, and unnecessarily pulls colormap implementation details (like the lut) into the API of
register_cmap(). Given that colormap registration is only done very rarely, the benefit of a sligtly shorter callregister_cmap(name, data=data, lut=lut)is negligable. It's even error prone because data has to be passed as kwarg since the second arg is the for this case unused cmap parameter.PR Checklist