Remove doctests from pre-commit. Add them to test_pr.yml. Check .pyi …

…files.
acquire-project · Nov 15, 2023 · 565c78e · 565c78e
1 parent b6fbf45
commit 565c78e
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 15 deletions.
diff --git a/.github/workflows/test_pr.yml b/.github/workflows/test_pr.yml
@@ -53,6 +53,7 @@ jobs:
       - name: Test
         run: |
           python -m pytest -k test_basic --color=yes --cov-report=xml --cov=acquire --maxfail=5 --log-cli-level=0
+          python -m pytest -k test_docs --color=yes --cov-report=xml --cov=acquire --maxfail=5 --log-cli-level=0
 
   dcam:
     name: Python ${{ matrix.python }} (DCAM)
@@ -98,7 +99,7 @@ jobs:
 
       - name: Test
         run: |
-          python -m pytest -k test_dcam --color=yes --cov-report=xml --cov=acquire --maxfail=5 --log-cli-level=0
+          python -m pytest -k test_dcam --color=yes --cov-report=xml --cov=acquire --maxfail=5 --log-cli-level=0 --doctest-glob="*.pyi" --doctest-glob="*.md"
 
   egrabber:
     name: Python ${{ matrix.python }} (eGrabber)
@@ -144,8 +145,7 @@ jobs:
 
       - name: Test
         run: |
-          python -m pytest -k test_egrabber --color=yes --cov-report=xml --cov=acquire --maxfail=5 --log-cli-level=0
-
+          python -m pytest -k test_egrabber --color=yes --cov-report=xml --cov=acquire --maxfail=5 --log-cli-level=0 --doctest-glob="*.pyi" --doctest-glob="*.md"
 
   spinnaker:
     name: Python ${{ matrix.python }} (Spinnaker)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -23,12 +23,6 @@ repos:
         stages: [ manual ]
   - repo: local
     hooks:
-      - id: doctest
-        name: Run doctests
-        entry: python tests/test_docs.py
-        language: system
-        types: [ file ]
-        files: \.(md|py|rs)$
       - id: ruff
         name: Lint Python files
         entry: python -m ruff check .

diff --git a/tests/test_docs.py b/tests/test_docs.py
@@ -26,9 +26,6 @@ def test_rust_sources(base_dir):
         assert doctest.testfile(str(f), module_relative=False).failed == 0
 
 
-if __name__ == "__main__":
-    base = Path(__file__).parent.parent
-    test_readme(base)
-    test_modules(base)
-    test_rust_sources(base)
-    print("Done.")
+def test_pyi_files(base_dir):
+    for f in base_dir.glob("python/**/*.pyi"):
+        assert doctest.testfile(str(f), module_relative=False).failed == 0