tools: add warning_in arg to @deprecated; deprecate get_input
#1872
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
Passing this optional parameter suppresses the warning output on Sopel versions lower than it, allowing for multi-stage deprecation timelines.
`tools.get_input()` won't be needed any more in Sopel 8 (we'll drop py2 support), so it's now marked as deprecated using the new `warning_in` argument to suppress printed warnings until plugins can safely assume they'll only be run on Python 3.
dgw
force-pushed
the
deprecate-tools.get_input
branch
from
a7d0ff4 to
c9ca1c9
Compare
Exirel
approved these changes
May 25, 2020
4 tasks
4 tasks
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.
Description
warning_inparameter to@deprecateddecorator to allow documenting & decorating a deprecated function all at once even if it shouldn't warn until some future version of Sopeltools.get_inputwill become unnecessary in Sopel 8.0 (it's a py2 compatibility shim), so it's now deprecated—but won't emit warnings until we actually do drop py2 in Sopel 8Checklist
make qa(runsmake qualityandmake test)Notes
Yeah, this is a messy diff. We probably should have just moved
@deprecatedto the top last time there was an issue with using it to decorate something defined earlier in the same file, but didn't. Viewing this one commit-by-commit will help.