Resolve #18: enforcing all static checks for pytests in tests/**

mahdi · mahdi · commit ea79a8eced14 · 2023-11-27T14:01:41.000-05:00
diff --git a/pyproject.toml b/pyproject.toml
@@ -50,11 +50,11 @@ skip-magic-trailing-comma = false
 line-ending = "auto"
 
 [tool.mypy]
-mypy_path = "pyssp"
+mypy_path = "."
 ignore_missing_imports = true
 disallow_incomplete_defs = true
 disallow_untyped_calls = true
 disallow_untyped_defs = true
 disallow_untyped_decorators = true
 plugins = "numpy.typing.mypy_plugin"
-files = ["pyssp/*.py"]
+files = ["pyssp/**.py", "tests/**.py"]
diff --git a/tests/test_optimal.py b/tests/test_optimal.py
@@ -1,10 +1,12 @@
-""""""
+"""Validation implementation of optimal controllers/estimators."""
 
 import numpy as np
 from pyssp import optimal
 
 
-def test_kalman():
+def test_kalman() -> None:
+    """Validate Kalman filter (estimator) implementation."""
+
     av = 1
     aw = 0.36
     A = 0.8
@@ -13,8 +15,9 @@ def test_kalman():
 
     rng = np.random.default_rng(seed=100)
 
+    # because the assumption is that vn and wn (noise in observations and system) must be draw
+    # independently from two seperate random processes
     rw, rv = rng.spawn(2)
-
     wn = rw.normal(0, aw, N)
     vn = rv.normal(0, av, N)
 
diff --git a/tests/test_state.py b/tests/test_state.py
@@ -6,7 +6,8 @@
 from pyssp import state
 
 
-def test_convm():
+def test_convm() -> None:
+    """Given a known system, generate its convolution matrix and validate."""
     x = np.array([1, 2, 3])
     p = 4
 
@@ -19,7 +20,8 @@ def test_convm():
     assert np.array_equal(expected, state.convm(x, p))
 
 
-def test_covar():
+def test_covar() -> None:
+    """Given a known system, generate its covariance matrix to validate implementation."""
     x = np.array([1, 2, 3])
     p = 4
 
