Run doctests in pytest. Add linters to pre-commit. Add a pre-commit workflow.

.github/workflows/pre-commit.yml

@@ -0,0 +1,27 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [ main ]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install
+        run: |
+          pip install --upgrade pip
+          pip install -e '.[testing]'
+
+      - name: Run pre-commit
+        uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -20,4 +20,12 @@ repos:
     rev: v1.2.7
     hooks:
     - id: import-linter
-      stages: [manual]
+      stages: [manual]
+-   repo: local
+    hooks:
+    -   id: doctest
+        name: Document tests
+        entry: python tests/test_docs.py
+        language: system
+        types: [file]
+        files: \.(md|py|rs)$

README.md

@@ -35,31 +35,30 @@ The provided [napari][] plugin is a good example of how to stream for visualizat
 
 ### List devices
 
-```python
-import acquire
-print(acquire.Runtime().device_manager().devices())
+```python-repl
+>>> import acquire
+>>> print(acquire.Runtime().device_manager().devices())  # doctest: +SKIP
 ```
 
 ### Finite triggered acquisition
 
-```python
-import acquire
-runtime = acquire.Runtime()
-dm = runtime.device_manager()
-
-props = runtime.get_configuration()
-# select the first Hamamatsu camera
-props.video[0].camera.identifier = dm.select(DeviceKind.Camera, "hamamatsu.*")
-# stream to zarr
-props.video[0].storage.identifier = dm.select(DeviceKind.Storage, "zarr")
-props.video[0].storage.settings.filename = "out.zarr"
-props.video[0].camera.settings.shape = (2304, 2304)
-props.video[0].camera.settings.pixel_type = SampleType.U16
-props.video[0].max_frame_count = 100
-props = runtime.set_configuration(props)
-
-runtime.start()
-runtime.stop()  # wait for acquisition to complete
+```python-repl
+>>> import acquire
+>>> runtime = acquire.Runtime()
+>>> dm = runtime.device_manager()
+>>> props = runtime.get_configuration()
+>>> # select the first Hamamatsu camera
+>>> props.video[0].camera.identifier = dm.select(acquire.DeviceKind.Camera, "hamamatsu.*")
+>>> # stream to zarr
+>>> props.video[0].storage.identifier = dm.select(acquire.DeviceKind.Storage, "zarr")
+>>> props.video[0].storage.settings.filename = "out.zarr"
+>>> props.video[0].camera.settings.shape = (2304, 2304)
+>>> props.video[0].camera.settings.pixel_type = acquire.SampleType.U16
+>>> props.video[0].max_frame_count = 100
+>>> props = runtime.set_configuration(props)
+>>> runtime.start()  # doctest: +SKIP
+>>> # wait for acquisition to complete
+>>> runtime.stop()  # doctest: +SKIP
 ```
 
 # Development
@@ -122,7 +121,8 @@ In order to configure which release of each driver to use, you can set the value
   "acquire-driver-common": "0.1.0",
   "acquire-driver-hdcam": "0.1.0",
   "acquire-driver-egrabber": "0.1.0",
-  "acquire-driver-zarr": "0.1.0"
+  "acquire-driver-zarr": "0.1.0",
+  "acquire-driver-spinnaker": "0.1.0"
 }
 ```
 

tests/test_docs.py

@@ -0,0 +1,34 @@
+import doctest
+import pytest
+
+from pathlib import Path
+
+
+@pytest.fixture(autouse=True)
+def base_dir():
+    return Path(__file__).parent.parent
+
+
+def test_readme(base_dir):
+    readme_path = base_dir / "README.md"
+    assert (
+        doctest.testfile(str(readme_path), module_relative=False).failed == 0
+    )
+
+
+def test_modules(base_dir):
+    for module in base_dir.glob("python/**/*.py"):
+        assert doctest.testfile(str(module), module_relative=False).failed == 0
+
+
+def test_rust_sources(base_dir):
+    for f in base_dir.glob("src/**/*.rs"):
+        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.")

tests/test_spinnaker.py

@@ -22,4 +22,4 @@ def test_blackfly_camera_is_present(runtime: acquire.Runtime):
 
 def test_oryx_camera_is_present(runtime: acquire.Runtime):
     dm = runtime.device_manager()
-    assert dm.select(DeviceKind.Camera, ".*ORX-10GS-51S5M.*")
+    assert dm.select(DeviceKind.Camera, ".*ORX-10GS-51S5M.*")