run mypy in proper environment (#5279)

* enable strict mypy checking * update contribution guide * remove mypy precommit hook
python-poetry · May 7, 2022 · f645ab9 · f645ab9
1 parent 9331741
commit f645ab9
Show file tree

Hide file tree

Showing 6 changed files with 149 additions and 9 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -85,6 +85,9 @@ jobs:
  - name: Run pytest
  run: poetry run python -m pytest -p no:sugar -q tests/
 
+ - name: Run mypy
+ run: poetry run mypy
+
  - name: Run pytest (integration suite)
  run: poetry run python -m pytest -p no:sugar -q --integration tests/integration
 

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -81,14 +81,6 @@ repos:
  - id: flake8
  additional_dependencies: *flake8_deps
 
- - repo: https://github.com/pre-commit/mirrors-mypy
- rev: v0.950
- hooks:
- - id: mypy
- pass_filenames: false
- additional_dependencies:
- - types-requests
-
  - repo: https://github.com/pre-commit/pre-commit
  rev: v2.18.1
  hooks:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -122,6 +122,13 @@ $ poetry install
 $ poetry run pytest tests/
 ```
 
+Poetry uses [mypy](https://github.com/python/mypy) for typechecking, and the CI
+will fail if it finds any errors. To run mypy locally:
+
+```bash
+$ poetry run mypy
+```
+
 Poetry uses the [black](https://github.com/psf/black) coding style and you must ensure that your
 code follows it. If not, the CI will fail and your Pull Request will not be merged.
 

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -139,6 +139,13 @@ $ poetry install
 $ poetry run pytest tests/
 ```
 
+Poetry uses [mypy](https://github.com/python/mypy) for typechecking, and the CI
+will fail if it finds any errors. To run mypy locally:
+
+```bash
+$ poetry run mypy
+```
+
 Poetry uses the [black](https://github.com/psf/black) coding style and you must ensure that your
 code follows it. If not, the CI will fail and your Pull Request will not be merged.
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -71,6 +71,8 @@ httpretty = "^1.0"
 typing-extensions = { version = "^4.0.0", python = "<3.8" }
 zipp = { version = "^3.4", python = "<3.8" }
 flatdict = "^4.0.1"
+mypy = ">=0.950"
+types-requests = ">=2.27.11"
 
 [tool.poetry.scripts]
 poetry = "poetry.console.application:main"