fix: improve AsyncQuery typing #782
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
b93c581 to
4fa1d9b
Compare
Contributor
|
Thanks for putting this together. I noticed recently that the typechecking test is currently not working properly, so the types declared in this library will have flaws until that is resolved |
| def end_at( | ||
| self, document_fields_or_snapshot: Union[DocumentSnapshot, dict, list, tuple] | ||
| ) -> "BaseQuery": | ||
| self: QueryType, |
Contributor
There was a problem hiding this comment.
nit: it shouldn't be necessary to include type annotations for self (mypy doesn't require it, and we typically don't include them in other GCP libraries).
Is there a reason it's needed here?
Contributor
Author
There was a problem hiding this comment.
Thank you for the feedback! I wanted to make it explicit on the function signature that the return type was of the same type as the object calling it.
daniel-sanche
approved these changes
Oct 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #781 🦕