Add mypy pre-commit#140
Open
MarianaVZorzo wants to merge 3 commits into
Open
Conversation
ocefpaf
reviewed
Jun 14, 2026
| hooks: | ||
| - id: mypy | ||
| additional_dependencies: | ||
| - types-requests |
Member
There was a problem hiding this comment.
Requests are not used directly here, let's remove this line for now.
ocefpaf
reviewed
Jun 14, 2026
| hooks: | ||
| - id: mypy | ||
| additional_dependencies: | ||
| - types-requests |
Member
There was a problem hiding this comment.
Suggested change
| - types-requests |
Member
|
@MarianaVZorzo as expected, when we added type hinting checking, we got tons of "erros" from types that are not defined: We should slowly fix those. I'll send an example ASAP for you to follow on how to add types to the library. Some may be low hanging fruit, others a bit more involved. This is not something we want to do in a single PR. |
Author
|
Thanks, Filipe! I removed types-requests. I see the mypy errors and I'll wait for your example and the next steps :) |
Contributor
|
Question: why a pre-commit hook, rather than a CI job (that's allowed to fail) -- particularly this early in the game, where it's a long way from passing ? |
Member
That is "pre-commit-ci" it has the advantage to save on GitHub API tokens. We can run a CI test on GitHub actions for it, but the author deprecated it in liue for pre-commit CI. With that said, we can run the mypy only check with GitHub Actions CIs. |
Contributor
|
I'm still a bit confused about what "pre-commit-ci" is -- but I did look into a bit, and this does seem to make sense for this -- thanks! |
Member
Sorry I was not clear, but the gist of it is that pre-commit-ci runs the pre-commit hooks for us as part of a PR test matrix. That helps folks who do not have the hooks installed locally. I do prefer to run it in GitHub Actions, but the author deprecated it :-/ With that said, pre-commit-ci is not bad. It is fast, isolated and safe, and save us GH tokens. (We don't get rate limited here, but in big orgs that last one sure comes in handy.) |
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
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.
Adds the mypy pre-commit hook configuration following the setup used in erddapy.