Merge pull request #344 from robbievanleeuwen/mypy

Implement `mypy`

Author: robbievanleeuwen

.github/workflows/tests.yml

@@ -17,6 +17,9 @@ jobs:
       matrix:
         include:
           - { python: "3.11", os: "ubuntu-latest", session: "pre-commit" }
+          - { python: "3.11", os: "ubuntu-latest", session: "mypy" }
+          - { python: "3.10", os: "ubuntu-latest", session: "mypy" }
+          - { python: "3.9", os: "ubuntu-latest", session: "mypy" }
           - { python: "3.11", os: "ubuntu-latest", session: "tests" }
           - { python: "3.10", os: "ubuntu-latest", session: "tests" }
           - { python: "3.9", os: "ubuntu-latest", session: "tests" }

.gitignore

@@ -44,3 +44,6 @@ __pycache__/
 
 # benchmark results
 .benchmarks/
+
+# mypy cache
+.mypy_cache/

noxfile.py

@@ -26,6 +26,7 @@
 nox.needs_version = ">= 2021.6.6"
 nox.options.sessions = (
     "pre-commit",
+    "mypy",
     "tests",
     "docs-build",
 )
@@ -137,6 +138,21 @@ def precommit(session: Session) -> None:
         activate_virtualenv_in_precommit_hooks(session)
 
 
+@session(python=python_versions)
+def mypy(session: Session) -> None:
+    """Type-check using mypy.
+
+    Args:
+        session: Nox session
+    """
+    args = session.posargs or ["src", "docs/conf.py"]
+    session.install(".")
+    session.install("mypy", "pytest")
+    session.run("mypy", *args)
+    if not session.posargs:
+        session.run("mypy", f"--python-executable={sys.executable}", "noxfile.py")
+
+
 @session(python=python_versions)
 def tests(session: Session) -> None:
     """Run the test suite.

poetry.lock

@@ -76,6 +76,7 @@ ipykernel = "^6.25.2"
 ipython = "^8.16.1"
 ipywidgets = "^8.1.1"
 isort = "^5.12.0"
+mypy ="^1.6.0"
 nbconvert = "^7.9.2"
 nbsphinx = "^0.9.3"
 notebook = "^7.0.4"
@@ -117,6 +118,26 @@ show_missing = true
 profile = "black"
 lines_after_imports = 2
 
+[tool.mypy]
+strict = true
+# output formatting
+pretty = true
+show_column_numbers = true
+show_error_context = true
+
+[[tool.mypy.overrides]]
+module = [
+    "cad_to_shapely.*",
+    "mpl_toolkits.*",
+    "numba.*",
+    "pypardiso.*",
+    "rhino_shapely_interop.*",
+    "scipy.*",
+    "shapely.*",
+    "triangle.*",
+]
+ignore_missing_imports = true
+
 [tool.pytest.ini_options]
 markers = [
     "benchmark_suite: entire benchmark test suite (select with '-m benchmark_suite')",