[utils] introduce utility function for annotation cleaning and adjust tests

Author: sprenger

neo/test/utils/test_misc.py

@@ -386,8 +386,8 @@ def test__cut_block_by_epochs(self):
             self.assertEqual(len(block.segments[epoch_idx].irregularlysampledsignals), 1)
 
             annos = block.segments[epoch_idx].annotations
-            self.assertIn('nix_name', annos)
-            self.assertTrue(annos['nix_name'].startswith('neo.segment.'))
+            # new segment objects have different identity
+            self.assertNotIn('nix_name', annos)
 
             if epoch_idx != 0:
                 self.assertEqual(len(block.segments[epoch_idx].epochs), 1)
@@ -442,8 +442,7 @@ def test__cut_block_by_epochs(self):
             self.assertEqual(len(block.segments[epoch_idx].irregularlysampledsignals), 1)
 
             annos = block.segments[epoch_idx].annotations
-            self.assertIn('nix_name', annos)
-            self.assertTrue(annos['nix_name'].startswith('neo.segment.'))
+            self.assertNotIn('nix_name', annos)
 
             if epoch_idx != 0:
                 self.assertEqual(len(block.segments[epoch_idx].epochs), 1)

neo/utils/misc.py

@@ -11,7 +11,7 @@
 
 import neo
 
-ignore_annotations = ['nix_name']
+reserved_annotations = ['nix_name']
 
 def get_events(container, **properties):
     """
@@ -348,12 +348,8 @@ def add_epoch(
 
     ep = neo.Epoch(times=times, durations=durations, **kwargs)
 
-    annos = {k: v for k, v in event1.annotations.items()
-             if k not in ignore_annotations}
-    array_annos = {k: v for k, v in event1.array_annotations.items()
-                   if k not in ignore_annotations}
-    ep.annotate(**copy.copy(annos))
-    ep.array_annotate(**copy.copy(array_annos))
+    ep.annotate(**clean_annotations(event1.annotations))
+    ep.array_annotate(**clean_annotations(event1.array_annotations))
 
     if attach_result:
         segment.epochs.append(ep)
@@ -550,21 +546,34 @@ def cut_segment_by_epoch(seg, epoch, reset_time=False):
                                 epoch.times[ep_id] + epoch.durations[ep_id],
                                 reset_time=reset_time)
 
-        annos = {k: v for k, v in epoch.annotations.items()
-                 if k not in ignore_annotations}
-        subseg.annotate(**copy.copy(annos))
+        subseg.annotations = clean_annotations(subseg.annotations)
+        subseg.annotate(**clean_annotations(epoch.annotations))
 
         # Add array-annotations of Epoch
-        for key, val in epoch.array_annotations.items():
-            if key in ignore_annotations:
-                continue
+        for key, val in clean_annotations(epoch.array_annotations).items():
             if len(val):
                 subseg.annotations[key] = copy.copy(val[ep_id])
 
         segments.append(subseg)
 
     return segments
 
+def clean_annotations(dictionary):
+    """
+    Remove reserved keys from an annotation dictionary.
+
+    Parameters
+    ----------
+    dictionary: dict
+        annotation dictionary to be cleaned
+
+    Returns:
+    --------
+    dict
+        A cleaned version of the annotations
+    """
+    return {k: v for k, v in dictionary.items() if k not in reserved_annotations}
+
 
 def is_block_rawio_compatible(block, return_problems=False):
     """