Deprecate the 'warn' parameter to matplotlib.use(). #14144
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
|
I will be happy to see the "warn" kwarg go away. What has to be done to get the tests to pass with this? |
|
someone had to remind me that the tests were failing ;) |
Right now, the only case where the 'warn' parameter to use() has an observable effect is if the user calls `use(some_backend, warn=True, force=False)` (the default is `warn=False, force=True`) and `some_backend` cannot be switched to. If they really want a warning in that case and not an exception (why?), they can just do ``` try: use(some_backend) except ImportError: warnings.warn(...) ``` instead. Given the non-obvious interaction between `warn` and `force`, just deprecate `warn`. We could even deprecate `force` and tell user to catch ImportErrors if they know a switch can fail and that they want to silently ignore the switch failure, but I guess someone will complain that `use(some_backend, force=False)` is so much shorter to write than ``` try: use(some_backend) except ImportError: pass ``` ...
efiring
approved these changes
May 22, 2019
timhoffm
approved these changes
May 26, 2019
|
Sorry @tacaswell I didn't see that you were requested for review. Please let me know if merging was premature. |
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.
Right now, the only case where the 'warn' parameter to use() has an
observable effect is if the user calls
use(some_backend, warn=True, force=False)(the default iswarn=False, force=True) andsome_backendcannot be switched to.If they really want a warning in that case and not an exception (why?),
they can just do
instead.
Given the non-obvious interaction between
warnandforce, justdeprecate
warn.We could even deprecate
forceand tell user to catch ImportErrors ifthey know a switch can fail and that they want to silently ignore the
switch failure, but I guess someone will complain that
use(some_backend, force=False)is so much shorter to write than...
PR Summary
PR Checklist