馃彿 Add type overloads for get_execution_result
#287
Merged
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
Methods like `execute` were previously annotated with a `Union` type, indicating all of the types of return values that the function could be returned. However, a more specific return type can often be inferred statically based on whether or not the `get_execution_result` keyword argument is passed to the method. These changes add function type overloads to methods accepting the `get_execution_result` keyword, which allows Mypy to infer a more specific return type based on the passed value of `get_execution_result`, if any.
Codecov Report
@@ Coverage Diff @@
## master #287 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 26 26
Lines 2045 2060 +15
=========================================
+ Hits 2045 2060 +15
Continue to review full report at Codecov.
|
connorbrinton
commented
Jan 4, 2022
|
Thanks for your PR! Note: tests are flaky on windows for unrelated reasons. I'll verify this and probably disable this test for windows. |
leszekhanusz
approved these changes
Jan 5, 2022
|
@leszekhanusz You bet, thanks for tidying it up and maintaining gql! 馃槃 |
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.
Methods like
executewere previously annotated with aUniontype, indicating all of the types of return values that the function could be returned. However, a more specific return type can often be inferred statically based on whether or not theget_execution_resultkeyword argument is passed to the method.These changes add function type overloads to methods accepting the
get_execution_resultkeyword, which allows Mypy to infer a more specific return type based on the passed value ofget_execution_result, if any.