From 0486e32c94e81652635cfbaa1513cd247235e8bf Mon Sep 17 00:00:00 2001
From: Neil Shephard <n.shephard@sheffield.ac.uk>
Date: Wed, 20 Nov 2024 14:23:37 +0000
Subject: [PATCH] style: Adds mypy configuration and pre-commit repo

Closes #49
Closes #52

- [MY100: Uses MyPy (pyproject config)](https://learn.scientific-python.org/development/guides/style#MY100)
- [PC140: Uses a type checker](https://learn.scientific-python.org/development/guides/style#PC140)

Adds configuration of [mypy](https://mypy.readthedocs.io/) to
[`pyproject.toml`](https://mypy.readthedocs.io/en/stable/config_file.html#using-a-pyproject-toml-file) and the related
`pre-commit` hook.

May need tweaking.
---
 .pre-commit-config.yaml |  8 ++++++++
 pyproject.toml          | 15 +++++++++++++++
 2 files changed, 23 insertions(+)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index d46826a..6cd86f2 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -83,6 +83,14 @@ repos:
       - id: python-check-blanket-noqa
       - id: python-check-blanket-type-ignore
       - id: python-check-mock-methods
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.13.0
+    hooks:
+      - id: mypy
+        files: isoslam
+        args: ["--ignore-without-code", "--redundant-expr", "--truthy-bool"]
+
   - repo: local
     hooks:
       - id: pylint
diff --git a/pyproject.toml b/pyproject.toml
index 47f12ee..6627e81 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -73,6 +73,7 @@ docs = [
 dev = [
   "black",
   "ipython",
+  "mypy",
   "pre-commit",
   "pylint",
   "pyupgrade",
@@ -255,3 +256,17 @@ override_SS05 = [  # override SS05 to allow docstrings starting with these words
     "^Assess ",
     "^Access ",
 ]
+
+[tool.mypy]
+files = [
+  "isoslam",
+  "tests"
+]
+python_version = "3.9"
+strict = true
+enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
+warn_unreachable = true
+
+[[tool.mypy.overrides]]
+module = [ "numpy.*", ]
+ignore_missing_imports = true
\ No newline at end of file