Don't pretend @deprecated applies to classmethods. #12151
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
timhoffm
approved these changes
Sep 18, 2018
lib/matplotlib/cbook/deprecation.py
Outdated
| new_doc = (('\n.. deprecated:: %(since)s' | ||
| '\n %(message)s\n\n' % | ||
| {'since': since, 'message': message}) + old_doc) | ||
| new_doc = ('.. deprecated:: {}\n' |
There was a problem hiding this comment.
I'd rather keep named placeholders, i.e. {since}.
When do we require Python 3.6 so that we can use f-strings? 😏 So long, I'd take the .format(since=since, ...) workaround.
The `@deprecated` decorator has a branch for handling deprecation of classmethods, but that won't ever work because we start by getting the `__name__` attribute on the object, which raises an AttributeError on classmethods. This could be fixed by fetching `obj.__func__.__name__` instead, but given that one can as well put the `@deprecated` decorator *under* the `@classmethod` decorator (so that it sees the underlying function), we can just remove that non-functioning code. Also switch some docstring formatting to str.format.
8abe9f6 to
167ede8
Compare
QuLogic
reviewed
Sep 18, 2018
| new_doc = (('\n.. deprecated:: %(since)s' | ||
| '\n %(message)s\n\n' % | ||
| {'since': since, 'message': message}) + old_doc) | ||
| new_doc = ('.. deprecated:: {since}\n' |
There was a problem hiding this comment.
What happened to the leading newline?
There was a problem hiding this comment.
It's at the beginning of the docstring so it doesn't matter.
OTOH I realized that we should dedent old_doc with inspect.cleandoc instead of textwrap.dedent, as the first line may not be indented... e.g. right now (before this PR) the docstring of backend_cairo.ArrayWrapper.__init__ is
.. deprecated:: 3.0
The ArrayWrapper class was deprecated in Matplotlib 3.0 and will be removed in 3.2.
Thin wrapper around numpy ndarray to expose the interface
expected by cairocffi. Basically replicates the
array.array interface.
The latter would fail if the first line is not indented, which occurs.
eric-wieser
approved these changes
Sep 21, 2018
|
Thanks @anntzer ! |
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.
The
@deprecateddecorator has a branch for handling deprecation ofclassmethods, but that won't ever work because we start by getting
the
__name__attribute on the object, which raises an AttributeErroron classmethods.
This could be fixed by fetching
obj.__func__.__name__instead, butgiven that one can as well put the
@deprecateddecorator under the@classmethoddecorator (so that it sees the underlying function), wecan just remove that non-functioning code.
Also switch some docstring formatting to str.format.
PR Summary
PR Checklist