chore: make pyright run in strict mode and add mypy
#78
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
This commit introduces mypy to our pre-commit hooks and CI. This should increase the amount of typing bugs we catch.
serramatutu
force-pushed
the
serramatutu/mypy
branch
from
32f324a to
92b346b
Compare
courtneyholcomb
approved these changes
Apr 3, 2025
serramatutu
force-pushed
the
serramatutu/mypy
branch
2 times, most recently
from
38c4901 to
e716d78
Compare
This commit makes both pyright and mypy operate on the strictest setting. I had to change some code around or add type ignores in cases where it's being too strict or when the stubs for dependencies are not precise enough. I only did this for the `dbtsl` package in this commit. I'll refactor the tests in the next commit.
This commit changes some of our tests to work with stricter pyright settings. I made the checks for tests a little less strict than the real `dbtsl` tests since our tests sometimes inject wrong types into the API to purposefully induce errors, or mocks stuff that's really hard to type.
serramatutu
force-pushed
the
serramatutu/mypy
branch
from
e716d78 to
ad95f69
Compare
courtneyholcomb
approved these changes
Apr 3, 2025
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.
Summary
This PR upgrade pyright
typeCheckingModefromstandardtostrict, and it also addsmypytypechecking to the pre-commit hooks and to CI.This is an attempt to make sure our type definitions are very sound, and will hopefully catch some bugs in the future.
There were some exceptions where I had to resort to
# type: ignore.Most of them are due to incomplete type annotations on third party libraries, which triggers the
reportUnknownArgumentTypeorreportUnknownVariablechecks from pyright (cough coughpyarrow).Some other exceptions are due to there being to way to type things like
Unpack[T]whereTis not a concreteTypedDictand is instead aTypeVarthat is bound to aTypedDict. In such cases, I added comments explaining why the ignore is necessary. Yes, I could rewrite the whole API to make it fully type-able, but that would also make the code a lot more verbose probably.You can review commit by commit.