Add mypy as pre-commit hook #26
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
|
|
update cibuild script ignore errors for now until they can be addressed in code/config options Add note about pre-commit hooks in readme remove python3.8 language_version
underchemist
force-pushed
the
16_mypy
branch
from
f076020 to
3462d45
Compare
|
mypy output |
JBurkinshaw
reviewed
Sep 22, 2021
Comment on lines
+15
to
+19
| rev: v0.910 | ||
| hooks: | ||
| - id: mypy | ||
| language_version: python |
There was a problem hiding this comment.
Can you explain why you decided to move away from the custom hook?
If we keep this approach, ./mypy.sh will not be required and should be deleted.
There was a problem hiding this comment.
I've bumped mypy==v0.910 since it supports configuration in pyproject.toml which I think removes the need for a custom hook
README.md
Outdated
| @@ -114,6 +114,9 @@ The following provides information for developers looking to maintain or extend | |||
|
|
|||
| ## Architecture | |||
|
|
|||
| ## Pre-commit hooks | |||
| Git hooks are used to run formatting (isort, black), linting (flake8), and type-checking (mypy). You can install the pre-commit scripts with `pre-commit install`. Thereafter, the scripts defined in `.pre-commit-config.yaml` will be run on the files included in a commit. Specific tool configurations are included in `pyproject.toml`. | |||
There was a problem hiding this comment.
This is useful. Worth mentioning that pre-commit install is run by scripts/setup too
| @@ -7,15 +7,13 @@ repos: | |||
| rev: 21.5b1 | |||
| hooks: | |||
| - id: black | |||
| language_version: python3.8 | |||
| language_version: python | |||
There was a problem hiding this comment.
Can you explain this and the related change in pyproject.toml a bit more?
Would there be a way to specify a minimum version? i.e. 3.8+
There was a problem hiding this comment.
specifying python 3.8 here excludes python 3.9 (resulting in error if that is the runtime python version), I'm not sure that we need to enforce a python version here, leaving it to setup.py or README
Closed
|
thanks @JBurkinshaw! |
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.
Description
Please include a summary of the change. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes #5
scripts/cibuildpy38options from [tool.black] to support pre-commit in py39 venvignore_errorsconfig until they can be addressedType of change
Please delete options that are not relevant.
Instructions
Explain what someone needs to do in order to test the functionality of the changes.
Run
pre-commit run --all-filesormypy -p oaffHow Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Checklist: