test: Check python notebooks with pytest

Author: aborgna-q

.github/change-filters.yml

@@ -19,3 +19,5 @@ python: &python
   - "impl/py/**"
   - "pyproject.toml"
   - "uv.lock"
+  - "examples/**.py"
+  - "examples/**.ipynb"

impl/py/tests/test_examples.py

@@ -0,0 +1,19 @@
+"""Tests validating the files in the repo's `examples` directory."""
+
+import pytest
+from pathlib import Path
+
+REPO_ROOT = Path(__file__).parent.parent.parent.parent
+notebook_files = list((REPO_ROOT / "examples").glob("**/*.ipynb"))
+
+print(notebook_files)
+
+
+@pytest.mark.parametrize("notebook", notebook_files)
+def test_example_notebooks(nb_regression, notebook: Path):
+    print("Notebook:", notebook)
+    nb_regression.diff_ignore += (
+        "/metadata/language_info/version",
+        "/cells/*/outputs/*/data/image/png",
+    )
+    nb_regression.check(notebook)

pyproject.toml

@@ -4,7 +4,13 @@ members = ["impl/py"]
 [dependency-groups]
 dev = [{ include-group = "lint" }, { include-group = "test" }]
 lint = ["pre-commit ~=4.3", "ruff ~=0.12.10", "mypy ~=1.17"]
-test = ["pytest ~=8.4", "pytest-cov ~=6.2", "mypy ~=1.17"]
+test = [
+    "ipykernel ~=6.29",
+    "pytest ~=8.4",
+    "pytest-cov ~=6.2",
+    "pytest-notebook ~=0.10.0",
+    "mypy ~=1.17",
+]
 
 [tool.mypy]
 strict = true