fix tests

Author: CodyCBakerPhD

nwbinspector/__init__.py

@@ -8,3 +8,4 @@
 from .checks.ecephys import *
 from .checks.ogen import *
 from .checks.image_series import *
+from .checks.behavior import *

nwbinspector/checks/behavior.py

@@ -1,9 +1,13 @@
+"""Checks for types belonging to the pynwb.behavior module."""
 from pynwb.behavior import SpatialSeries
 
 from ..register_checks import register_check, Importance, InspectorMessage
 
 
 @register_check(importance=Importance.CRITICAL, neurodata_type=SpatialSeries)
 def check_spatial_series_dims(spatial_series: SpatialSeries):
+    """Check if a SpatialSeries has the correct dimensions."""
     if len(spatial_series.data.shape) > 1 and spatial_series.data.shape[1] > 3:
-        return InspectorMessage("SpatialSeries should have 1 column (x, ), 2 columns (x, y), or 3 columns (x, y, z).")
+        return InspectorMessage(
+            message="SpatialSeries should have 1 column (x), 2 columns (x, y), or 3 columns (x, y, z)."
+        )

tests/unit_tests/test_behavior.py

@@ -1,7 +1,7 @@
 from pynwb.behavior import SpatialSeries
 import numpy as np
 
-from nwbinspector.checks.behavior import check_spatial_series_dims
+from nwbinspector import InspectorMessage, Importance, check_spatial_series_dims
 
 
 def test_check_spatial_series_dims():
@@ -13,10 +13,13 @@ def test_check_spatial_series_dims():
         rate=3.0,
         reference_frame="reference_frame",
     )
-
-    assert (
-        check_spatial_series_dims(spatial_series).message == "SpatialSeries should have either 2 columns (x,"
-        "y) or 3 columns (x,y,z)."
+    assert check_spatial_series_dims(spatial_series) == InspectorMessage(
+        message="SpatialSeries should have 1 column (x), 2 columns (x, y), or 3 columns (x, y, z).",
+        importance=Importance.CRITICAL,
+        check_function_name="check_spatial_series_dims",
+        object_type="SpatialSeries",
+        object_name="SpatialSeries",
+        location="/",
     )