Merge pull request #48 from linuxrider/type-checker

Type checker

Author: linuxrider

.github/workflows/doc.yml

@@ -14,8 +14,8 @@ jobs:
       - name: checkout
         uses: actions/checkout@v6
         with: { submodules: recursive }
-      - uses: prefix-dev/setup-pixi@v0.9.4
-        with: { pixi-version: v0.63.2 }
+      - uses: prefix-dev/setup-pixi@v0.9.6
+        with: { pixi-version: v0.70.2 }
       - name: build documentation
         run: |
           pixi run doc

.github/workflows/lint.yml

@@ -14,11 +14,13 @@ jobs:
       - name: checkout
         uses: actions/checkout@v6
         with: { submodules: recursive }
-      - uses: prefix-dev/setup-pixi@v0.9.4
-        with: { pixi-version: v0.63.2 }
+      - uses: prefix-dev/setup-pixi@v0.9.6
+        with: { pixi-version: v0.70.2 }
       - name: pylint
         run: pixi run pylint
       - name: black
         run: pixi run black --diff --check
       - name: isort
-        run: pixi run isort -- --check --diff
+        run: pixi run isort -- --diff
+      - name: ty
+        run: pixi run ty

.github/workflows/test.yml

@@ -17,8 +17,8 @@ jobs:
     steps:
       - uses: actions/checkout@v6
         with: { submodules: recursive }
-      - uses: prefix-dev/setup-pixi@v0.9.4
-        with: { pixi-version: v0.63.2 }
+      - uses: prefix-dev/setup-pixi@v0.9.6
+        with: { pixi-version: v0.70.2 }
       - name: doctest
         shell: pixi run bash -e {0}
         run: pixi run -e ${{ matrix.environment }} doctest

ec_tools/helper.py

@@ -5,7 +5,7 @@
 import numpy as np
 
 
-def find_x0_values(x, y, mode="all"):
+def find_x0_values(x: np.ndarray, y: np.ndarray, mode: str = "all") -> np.ndarray:
     """Takes x and y as numpy arrays and returns the ordered zero points by assuming linear behavior between
     the points.
     The mode determines if all or either positive or negative zero points should be returned.
@@ -55,7 +55,7 @@ def find_x0_values(x, y, mode="all"):
     return np.sort(np.concatenate([x[exact_crossings[1::2]], delta_x + x[non_exact_crossings]]))
 
 
-def determine_scan_rate(t, x):
+def determine_scan_rate(t: np.ndarray, x: np.ndarray) -> np.floating:
     """Return scan rate of given t and x arrays.
 
     TEST:
@@ -69,7 +69,7 @@ def determine_scan_rate(t, x):
     return np.abs(np.diff(x) / np.diff(t)).mean()
 
 
-def detect_step(t, x):
+def detect_step(t: np.ndarray, x: np.ndarray) -> np.intp:
     """Returns the index of the step in given t and x arrays.
     Index is the where the changed value of t located.
     TEST:

ec_tools/py.typed

@@ -154,7 +154,14 @@
 from transonic import jit
 
 
-def semi_integration(y, x, v=-0.5, alg="frlt", transonic_backend="pythran", d_tol=1e-5):
+def semi_integration(
+    y: np.ndarray,
+    x: np.ndarray,
+    v: float = -0.5,
+    alg: str = "frlt",
+    transonic_backend: str = "pythran",
+    d_tol: float = 1e-5,
+) -> np.ndarray:
     r"""
     A generalized call is implemented, in which the user can define with ``v`` the operation i.e. semi integration
     (``v`` :math:`=-0.5`) or semi differentiation (``v`` :math:`=0.5`) for a predefined dataset (``y`` and ``t``).
@@ -271,8 +278,10 @@ def riemann_pythran(y, delta_x, v):
 
             return riemann_pythran(y, delta_x, v)
 
+    raise AssertionError(f"unhandled alg/backend combination: {alg!r}/{transonic_backend!r}")
 
-def gruenwald(y, delta_x, v=-0.5):
+
+def gruenwald(y: np.ndarray, delta_x: float, v: float = -0.5) -> np.ndarray:
     """
     Gruenwald Algorithm
     ^^^^^^^^^^^^^^^^^^^
@@ -331,7 +340,7 @@ def gruenwald(y, delta_x, v=-0.5):
     return g_1
 
 
-def riemann(y, delta_x, v=-0.5):
+def riemann(y: np.ndarray, delta_x: float, v: float = -0.5) -> np.ndarray:
     """
 
     Riemann Algorithm
@@ -399,7 +408,7 @@ def riemann(y, delta_x, v=-0.5):
     return r_1
 
 
-def fast_riemann(y, delta_x=1, q=-0.5, c1=8, c2=2):
+def fast_riemann(y: np.ndarray, delta_x: float = 1, q: float = -0.5, c1: int = 8, c2: int = 2) -> np.ndarray:
     r"""
 
     Fast Riemann Algorithm

ec_tools/semi_integration.py

@@ -19,6 +19,9 @@ pythran = ["pythran"]
 [tool.setuptools]
 packages = ["ec_tools",]
 
+[tool.setuptools.package-data]
+ec_tools = ["py.typed"]
+
 [tool.pixi.workspace]
 channels = ["conda-forge"]
 platforms = ["linux-64", "linux-aarch64", "osx-64", "osx-arm64", "win-64"]
@@ -78,13 +81,15 @@ scipy = "*"
 benchmark = "TODO"
 
 [tool.pixi.feature.lint.dependencies]
-ruff = ">=0.15.0,<0.16"
+ruff = ">=0.15.17,<0.16"
+ty = ">=0.0.49,<0.0.50"
 
 [tool.pixi.feature.lint.tasks]
 pylint = "ruff check ec_tools"
 black = "ruff format ec_tools"
 isort = "ruff check --select I ec_tools"
-lint = { depends-on = ["pylint", "black", "isort"]  }
+ty = "ty check --python $CONDA_PREFIX ec_tools"
+lint = { depends-on = ["pylint", "black", "isort", "ty"]  }
 
 [tool.pixi.feature.doc.dependencies]
 jupytext = "*"
@@ -115,3 +120,7 @@ lint.ignore = [
 ]
 lint.fixable = ["E", "F", "W", "B"]
 line-length = 115
+
+[tool.ty.environment]
+# Check against the oldest supported interpreter (see requires-python).
+python-version = "3.10"