feat: add an initial mypy test to tox.ini

JohnVillalovos · JohnVillalovos · commit fdec03976a17 · 2021-02-22T16:33:33.000-08:00
Add an initial mypy test to test gitlab/base.py and gitlab/__init__.py
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -27,3 +27,11 @@ jobs:
         with:
           fetch-depth: 0
       - uses: wagoid/commitlint-github-action@v2
+
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - run: pip install --upgrade tox
+      - run: tox -e mypy
diff --git a/.mypy.ini b/.mypy.ini
@@ -0,0 +1,2 @@
+[mypy]
+files = gitlab/*.py
diff --git a/gitlab/cli.py b/gitlab/cli.py
@@ -193,7 +193,7 @@ def main():
     # Now we build the entire set of subcommands and do the complete parsing
     parser = _get_parser(gitlab.v4.cli)
     try:
-        import argcomplete
+        import argcomplete  # type: ignore
 
         argcomplete.autocomplete(parser)
     except Exception:
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -25,7 +25,7 @@
 import gitlab.const
 import gitlab.exceptions
 from gitlab import utils
-from requests_toolbelt.multipart.encoder import MultipartEncoder
+from requests_toolbelt.multipart.encoder import MultipartEncoder  # type: ignore
 
 
 REDIRECT_MSG = (
diff --git a/test-requirements.txt b/test-requirements.txt
@@ -1,6 +1,7 @@
 coverage
 httmock
 mock
+mypy
 pytest
 pytest-cov
 responses
diff --git a/tox.ini b/tox.ini
@@ -1,7 +1,7 @@
 [tox]
 minversion = 1.6
 skipsdist = True
-envlist = py39,py38,py37,py36,pep8,black,twine-check
+envlist = py39,py38,py37,py36,pep8,black,twine-check,mypy
 
 [testenv]
 passenv = GITLAB_IMAGE GITLAB_TAG
@@ -35,6 +35,13 @@ deps = -r{toxinidir}/requirements.txt
 commands =
   twine check dist/*
 
+[testenv:mypy]
+basepython = python3
+deps = -r{toxinidir}/requirements.txt
+       -r{toxinidir}/test-requirements.txt
+commands =
+  mypy {posargs}
+
 [testenv:venv]
 commands = {posargs}
 
