chore: fix mypy check #984
Merged
+436
−338
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
product-auto-label
bot
added
the
api: firestore
cindy-peng
approved these changes
Nov 26, 2024
This was referenced Nov 26, 2024
Closed
daniel-sanche
force-pushed
the
fix_types
branch
from
cf2e4aa to
205576d
Compare
daniel-sanche
added
the
owlbot:run
gcf-owl-bot
bot
removed
the
owlbot:run
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.
The
nox -s mypycheck is currently targeting an empty folder, so it is giving a false positive. Because of this, the type annotations forpython-firestorehave been broken, which has been at the root of a large number of open issues (see #773 and associated issues)This PR fixes the problem by fixing the mypy check, and making enough changes so that the test passes again
Since this fix requires many changes throughout the codebase, I tried to make the changes as minimal as possible. None of the actual logic should be changed here, just the types. When I couldn't completely resolve typing issues without refactoring code, I used targeted
type: ignoreanntotations instead (seebulk_writer.py). The rest of the logic can be cleaned up over time, now that we have working type checks in place