Repository navigation
fix(firestore): add generic typing for DocumentSnapshot - #18587
Open
daniel-sanche wants to merge 2 commits into
Open
daniel-sanche wants to merge 2 commits into
daniel-sanche wants to merge 2 commits into
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces generic typing to DocumentSnapshot to specify the associated document reference type (DocumentReference or AsyncDocumentReference) across various Firestore client, query, and transaction modules. Feedback highlights a compatibility issue where using a string literal as a TypeVar bound (bound="BaseDocumentReference") will raise a TypeError at runtime in Python versions prior to 3.12. It is recommended to define DocRefType after BaseDocumentReference is fully defined so the actual class object can be used as the bound.
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
DocumentSnapshotcan be used with sync or async document reference types, which can result in confusing or incorrect type annotations upstreamThis PR makes
DocumentSnapshotinto a Generic, so it can specify what type of reference it holds.Fixes #15367