Provide overload type hints for search_issues variants #1861
Conversation
This file contains 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
search_issues can return either a dictionary (if json_result) or a list of Issues under default behavior. This change provides separate hints using overload so that type checked code doesn't need to cast unnecessarily when dealing with output.
We now require json_result and use_post are passed as keyword arguments, satisfying type checker requirements and handling the default return value correctly.
As the correct type hint is now provided, this is no longer necessary.
Stealthii
force-pushed
the
feature/overload-typehint
branch
from
5c14980
to
1690630
Compare
Stealthii
changed the title
|
The cloud / py3.8 job seems to be failing for all PRs, unrelated to the changes provided here. |
4 tasks
|
Looks awesome! Would be nice if this was merged, I run into issues having to cast this every time I use it |
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.
search_issues can return either a dictionary (if json_result) or a list of Issues under default behavior.
This change provides separate hints using overload so that type checked code doesn't need to cast unnecessarily when dealing with output.
Tests have been added, and cases where casting was used have been removed.
Fixes #1608.