Merge pull request #73 from mfisher87/add-typechecking

Add typechecking

Author: stefanv

.github/workflows/test.yml

@@ -5,7 +5,7 @@ on:
 
 jobs:
 
-  unit-test-with-pytest:
+  unit-test-and-typecheck:
     runs-on: "ubuntu-latest"
     strategy:
       matrix:
@@ -46,3 +46,9 @@ jobs:
           # In Pythons >= 3.10, tests fail with `RuntimeError: Invalid DISPLAY
           # variable`, unless this variable is set:
           MPLBACKEND: "Agg"
+
+      - name: "Install mypy"
+        run: "pip install mypy>=1.3"
+
+      - name: "Run typechecker"
+        run: "make typecheck"

Makefile

@@ -10,5 +10,11 @@ lint:
 	pre-commit run --all-files --show-diff-on-failure --color always
 
 
+.PHONY: typecheck
+typecheck:
+	mypy --version
+	mypy viscm
+
+
 .PHONY: ci
-ci: lint test
+ci: lint typecheck test

README.rst

@@ -43,4 +43,4 @@ python -m viscm --uniform-space buggy-CAM02-UCS -m Bezier edit /tmp/option_d.py
 
 Note that there was a small bug in the assumed sRGB viewing conditions
 while designing viridis. It does not affect the outcome by much. Also
-see `python -m viscm --help`.
+see `python -m viscm --help`.

doc/contributing.md

@@ -60,3 +60,12 @@ installed, GUI tests will be skipped. Install with:
 ```bash
 sudo apt install xvfb
 ```
+
+
+### Type check
+
+```bash
+make typecheck
+```
+
+Type checking requires `mypy`.

environment.yml

@@ -11,6 +11,7 @@ dependencies:
   - "scipy ~=1.10"
 
   # Development
+  - "mypy ~=1.3.0"
   - "pre-commit"
   - "pytest"
   - "pytest-cov"

pyproject.toml

@@ -45,6 +45,22 @@ packages = {find = {}}
 package-data = {viscm = ["examples/*"]}
 
 
+[tool.mypy]
+python_version = "3.8"
+
+# These libraries don't have type stubs. Mypy will see them as `Any` and not
+# throw an [import] error.
+[[tool.mypy.overrides]]
+module = [
+  "colorspacious",
+  "matplotlib.*",
+  "mpl_toolkits.*",
+  "scipy.*",
+]
+ignore_missing_imports = true
+
+
+
 [tool.black]
 target-version = ["py38", "py39", "py310", "py311"]
 

viscm/cli.py

@@ -123,7 +123,7 @@ def _make_window(
     cmap_uniform_space: str,
     save: Union[Path, None],
     quit_immediately: bool,
-):
+) -> Union[gui.ViewerWindow, gui.EditorWindow]:
     # Hold a reference so it doesn't get GC'ed
     fig = plt.figure()
     figure_canvas = gui.FigureCanvas(fig)
@@ -132,6 +132,7 @@ def _make_window(
     if cmap:
         cm.load(cmap)
 
+    v: Union[gui.viscm, gui.viscm_editor]
     # Easter egg! I keep typing 'show' instead of 'view' so accept both
     if action in ("view", "show"):
         if cm is None: