Pre-commit test for removing hardcoded "BAD_blink" in interpolate_blink

Related to #13531

Author: v01dxyz

mne/preprocessing/eyetracking/tests/test_pupillometry.py

@@ -19,15 +19,19 @@
 @pytest.mark.parametrize(
     "buffer, match, cause_error, interpolate_gaze, crop",
     [
-        (0.025, "BAD_blink", False, False, False),
-        (0.025, "BAD_blink", False, True, True),
+        (0.025, "WRONG_blink", False, False, False),
+        (0.025, "WRONG_blink", False, True, True),
+        (0.025, "WRONG_blink", False, True, True),
         ((0.025, 0.025), ["random_annot"], False, False, False),
-        (0.025, "BAD_blink", True, False, False),
+        (0.025, "WRONG_blink", True, False, False),
     ],
 )
 def test_interpolate_blinks(buffer, match, cause_error, interpolate_gaze, crop):
     """Test interpolating pupil data during blinks."""
     raw = read_raw_eyelink(fname, create_annotations=["blinks"], find_overlaps=True)
+    # we rename BAD_blink in order to test if it works with another description.
+    raw.annotations.rename({"BAD_blink": "WRONG_blink"})
+
     if crop:
         raw.crop(tmin=2)
         assert raw.first_time == 2.0
@@ -38,8 +42,9 @@ def test_interpolate_blinks(buffer, match, cause_error, interpolate_gaze, crop):
     stim_raw = RawArray(stim_data, info)
     raw.add_channels([stim_raw], force_update_info=True)
 
+    description = "WRONG_blink"
     # Get the indices of the first blink
-    blink_starts, blink_ends = _annotations_starts_stops(raw, "BAD_blink")
+    blink_starts, blink_ends = _annotations_starts_stops(raw, description)
     blink_starts = np.divide(blink_starts, raw.info["sfreq"])
     blink_ends = np.divide(blink_ends, raw.info["sfreq"])
     first_blink_start = blink_starts[0]
@@ -52,7 +57,7 @@ def test_interpolate_blinks(buffer, match, cause_error, interpolate_gaze, crop):
 
     if cause_error:
         # Make an annotation without ch_names info
-        raw.annotations.append(onset=1, duration=1, description="BAD_blink")
+        raw.annotations.append(onset=1, duration=1, description=description)
         with pytest.raises(ValueError):
             interpolate_blinks(raw, buffer=buffer, match=match)
         return