Merge pull request #237 from NeurodataWithoutBorders/fix_conda_forge

Make Image checks and tests safe

Author: CodyCBakerPhD

nwbinspector/checks/images.py

@@ -4,21 +4,29 @@
 
 from ..register_checks import register_check, Importance, InspectorMessage
 
+try:
+    from pynwb.base import Images
 
-@register_check(importance=Importance.BEST_PRACTICE_VIOLATION, neurodata_type=Images)
-def check_order_of_images_unique(images: Images):
-    if images.order_of_images is None:
-        return
-    if not len(set(images.order_of_images)) == len(images.order_of_images):
-        return InspectorMessage(message="order_of_images should have unique values.")
-
-
-@register_check(importance=Importance.BEST_PRACTICE_VIOLATION, neurodata_type=Images)
-def check_order_of_images_len(images: Images):
-    if images.order_of_images is None:
-        return
-    if not len(images.order_of_images) == len(images.images):
-        return InspectorMessage(
-            message=f"Length of order_of_images ({len(images.order_of_images)}) does not match the number of images ("
-            f"{len(images.images)})."
-        )
+    HAVE_IMAGES = True
+except ImportError:
+    HAVE_IMAGES = False
+
+
+if HAVE_IMAGES:
+
+    @register_check(importance=Importance.BEST_PRACTICE_VIOLATION, neurodata_type=Images)
+    def check_order_of_images_unique(images: Images):
+        if images.order_of_images is None:
+            return
+        if not len(set(images.order_of_images)) == len(images.order_of_images):
+            return InspectorMessage(message="order_of_images should have unique values.")
+
+    @register_check(importance=Importance.BEST_PRACTICE_VIOLATION, neurodata_type=Images)
+    def check_order_of_images_len(images: Images):
+        if images.order_of_images is None:
+            return
+        if not len(images.order_of_images) == len(images.images):
+            return InspectorMessage(
+                message=f"Length of order_of_images ({len(images.order_of_images)}) does not match the number of images ("
+                f"{len(images.images)})."
+            )

tests/unit_tests/test_images.py

@@ -1,12 +1,21 @@
-import numpy as np
+import pytest
 
-from pynwb.base import Images, ImageReferences
+import numpy as np
 from pynwb.image import GrayscaleImage
 
 from nwbinspector import InspectorMessage, Importance
 from nwbinspector.checks.images import check_order_of_images_unique, check_order_of_images_len
 
+try:
+    from pynwb.base import Images, ImageReferences
+
+    HAVE_IMAGES = True
+except ImportError:
+    HAVE_IMAGES = False
+skip_reason = "You must have PyNWB>=v2.1.0 to run these tests!"
+
 
+@pytest.mark.skipif(not HAVE_IMAGES, reason=skip_reason)
 def test_check_order_of_images_unique():
 
     imgs = [GrayscaleImage(name=f"image{i}", data=np.random.randn(10, 10)) for i in range(5)]
@@ -23,6 +32,7 @@ def test_check_order_of_images_unique():
     )
 
 
+@pytest.mark.skipif(not HAVE_IMAGES, reason=skip_reason)
 def test_pass_check_order_of_images_unique():
 
     imgs = [GrayscaleImage(name=f"image{i}", data=np.random.randn(10, 10)) for i in range(5)]
@@ -32,6 +42,7 @@ def test_pass_check_order_of_images_unique():
     assert check_order_of_images_unique(images) is None
 
 
+@pytest.mark.skipif(not HAVE_IMAGES, reason=skip_reason)
 def test_check_order_of_images_len():
 
     imgs = [GrayscaleImage(name=f"image{i}", data=np.random.randn(10, 10)) for i in range(5)]
@@ -48,6 +59,7 @@ def test_check_order_of_images_len():
     )
 
 
+@pytest.mark.skipif(not HAVE_IMAGES, reason=skip_reason)
 def test_pass_check_order_of_images_len():
 
     imgs = [GrayscaleImage(name=f"image{i}", data=np.random.randn(10, 10)) for i in range(5)]