In C extensions, use FutureWarning, not DeprecationWarning. #15829
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
DeprecationWarnings are hidden by default (that's why MatplotlibDeprecationWarning inherits from UserWarning, not DeprecationWarning...) and throwing a MatplotlibDeprecationWarning from C code is too much of a pain to be worth it; also, CPython suggests using FutureWarning for this purpose as well. (https://docs.python.org/3/library/warnings.html#warning-categories)
anntzer
referenced
this pull request
Dec 4, 2019
e.g. `plot([1, 2], ls=(None, (4, 4)))` which was previously a synonym for `plot([1, 2], ls=(0, (4, 4)))` which means "dash-pattern of 4pt-long dashes separated by 4pt spaces, with an offset of 0pt at start". Passing None instead of 0 was already not (likely, never) supported for pdf, ps, or svg (an exception is raised at savefig() time for ps/svg, an invalid pdf is generated). There isn't much of a point in supporting None (this also makes e.g. mplcairo more complex because of static typing in C++ extensions), so just deprecate it.
story645
approved these changes
Dec 4, 2019
|
Is there an easy way to check these are thrown in the test suite? |
|
We don't bother doing that for regular deprecations (and the test suite wouldn't have caught this anyways because pytest reenables DeprecationWarnings). |
|
I thought we did keep tests for deprecated stuff in the test suite, and just caught the deprecation warning? Anyway, these seem obscure enough not to insist on tests being added. |
dstansby
approved these changes
Dec 4, 2019
|
We did that if the things were already being tested, but for untested APIs getting deprecated (which occurs quite often because they're typically obscure...), we didn't bother adding tests for them just checking the deprecation. |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Dec 4, 2019
… DeprecationWarning.
tacaswell
added a commit
that referenced
this pull request
Dec 5, 2019
…829-on-v3.2.x Backport PR #15829 on branch v3.2.x (In C extensions, use FutureWarning, not DeprecationWarning.)
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.
DeprecationWarnings are hidden by default (that's why
MatplotlibDeprecationWarning inherits from UserWarning, not
DeprecationWarning...) and throwing a MatplotlibDeprecationWarning from
C code is too much of a pain to be worth it; also, CPython suggests
using FutureWarning for this purpose as well.
(https://docs.python.org/3/library/warnings.html#warning-categories)
Release critical so that the warnings actually show up...
PR Summary
PR Checklist