Deprecate Artist.aname and Axes.aname #11942
Merged
Conversation
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
anntzer
reviewed
Aug 26, 2018
| @@ -5,3 +5,6 @@ Support for custom backends that do not provide a ``set_hatch_color`` method is | |||
| deprecated. We suggest that custom backends let their ``GraphicsContext`` | |||
| class inherit from `GraphicsContextBase`, to at least provide stubs for all | |||
| required methods. | |||
|
|
|||
| The fields ``Artist.aname`` and ``Axes.aname`` are deprecated. Please use | |||
| ``isinstance()`` or ``__class__.__name__`` checks instead. | |||
There was a problem hiding this comment.
Well technically that's not the same (all subclasses of Axes, e.g. AxesSubplot, have "Axes" as aname, and similarly for Artist), but I agree that's not even close to being a reason not to deprecate it...
anntzer
reviewed
Aug 26, 2018
lib/matplotlib/artist.py
Outdated
| @@ -71,8 +71,10 @@ class Artist(object): | |||
| Abstract base class for someone who renders into a | |||
| :class:`FigureCanvas`. | |||
| """ | |||
| @cbook.deprecated("3.1") | |||
| def aname(self): | |||
There was a problem hiding this comment.
missing @property, below too
06be041 to
2a97c41
Compare
2a97c41 to
864fb33
Compare
NelleV
approved these changes
Aug 26, 2018
dstansby
approved these changes
Aug 27, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
The field
anameseems completely unused. It's information can also determined from the class viaisinstance()checks or__class__.__name__.The field should finally be removed. This PR deprecates the field, just in case any user is relying on it.
The field is turned into a property so that a deprecation warning is issued on access. I've refrained from creating a property setter, because I cannot imagine any real-world usecase that would want to set this to another value.