make annotations a subclass of UserList

Author: SBlokhuizen

tests/tendencies/periodic/test_periodic_base.py

@@ -64,7 +64,7 @@ def test_bounds(
         user_max=max,
     )
     if has_error:
-        assert tendency.annotations.get()
+        assert tendency.annotations
     else:
         assert tendency.base == approx(expected_base)
         assert tendency.amplitude == approx(expected_amplitude)
@@ -111,7 +111,7 @@ def test_bounds_prev(
         user_max=max,
     )
     if has_error:
-        assert tendency.annotations.get()
+        assert tendency.annotations
     else:
         tendency.set_previous_tendency(prev_tendency)
         assert tendency.base == approx(expected_base)
@@ -176,13 +176,13 @@ def test_frequency_and_period():
     assert tendency.frequency == 0.5
 
     tendency = PeriodicBaseTendency(user_duration=1, user_period=2, user_frequency=2)
-    assert tendency.annotations.get()
+    assert tendency.annotations
 
     tendency = PeriodicBaseTendency(user_duration=1, user_period=0)
-    assert tendency.annotations.get()
+    assert tendency.annotations
 
     tendency = PeriodicBaseTendency(user_duration=1, user_frequency=0)
-    assert tendency.annotations.get()
+    assert tendency.annotations
 
 
 def test_phase():

tests/tendencies/test_base.py

@@ -33,7 +33,7 @@ def test_first_base_tendency(
     base_tendency = BaseTendency(**kwargs)
 
     if has_error:
-        assert base_tendency.annotations.get()
+        assert base_tendency.annotations
     else:
         assert base_tendency.start == approx(expected_start)
         assert base_tendency.duration == approx(expected_duration)
@@ -70,7 +70,7 @@ def test_second_base_tendency(
     base_tendency = BaseTendency(**kwargs)
 
     if has_error:
-        assert base_tendency.annotations.get()
+        assert base_tendency.annotations
     else:
         base_tendency.set_previous_tendency(prev_tendency)
         assert base_tendency.start == approx(expected_start)

tests/tendencies/test_linear.py

@@ -44,7 +44,7 @@ def test_linear_tendency(
         user_duration=duration, user_from=from_, user_to=to, user_rate=rate
     )
     if has_error:
-        assert tendency.annotations.get()
+        assert tendency.annotations
     else:
         assert tendency.duration == duration
         assert tendency.from_ == approx(expected_from)
@@ -80,7 +80,7 @@ def test_linear_tendency_with_prev(
         user_duration=duration, user_from=from_, user_to=to, user_rate=rate
     )
     if has_error:
-        assert tendency.annotations.get()
+        assert tendency.annotations
     else:
         tendency.set_previous_tendency(prev_tendency)
         assert tendency.duration == duration
@@ -119,7 +119,7 @@ def test_linear_tendency_with_next(
         user_duration=duration, user_from=from_, user_to=to, user_rate=rate
     )
     if has_error:
-        assert tendency.annotations.get()
+        assert tendency.annotations
     else:
         tendency.set_next_tendency(next_tendency)
         assert tendency.duration == duration

tests/tendencies/test_repeat.py

@@ -91,23 +91,23 @@ def test_zero_start(repeat_waveform):
     """Test if zero start does not raise an error."""
     repeat_waveform["user_waveform"][0]["start"] = 0
     repeat_tendency = RepeatTendency(**repeat_waveform)
-    assert not repeat_tendency.annotations.get()
+    assert not repeat_tendency.annotations
 
 
 def test_one_start(repeat_waveform):
     """Test if non-zero start raises an error."""
     repeat_waveform["user_waveform"][0]["start"] = 1
     repeat_tendency = RepeatTendency(**repeat_waveform)
-    assert repeat_tendency.annotations.get()
+    assert repeat_tendency.annotations
 
 
 def test_empty():
     """Test if ill-defined tendency raises an error."""
     repeat_tendency = RepeatTendency()
-    assert repeat_tendency.annotations.get()
+    assert repeat_tendency.annotations
 
     repeat_tendency = RepeatTendency(user_duration=8)
-    assert repeat_tendency.annotations.get()
+    assert repeat_tendency.annotations
 
 
 def check_values_at_times(target_times, times, values, expected_value):
@@ -136,7 +136,7 @@ def test_filled(repeat_waveform):
     """Test if tendencies in repeated waveform are filled correctly."""
 
     repeat_tendency = RepeatTendency(**repeat_waveform)
-    assert not repeat_tendency.annotations.get()
+    assert not repeat_tendency.annotations
     tendencies = repeat_tendency.waveform.tendencies
     assert isinstance(tendencies[0], LinearTendency)
     assert tendencies[0].start == 0

waveform_editor/annotations.py

@@ -1,27 +1,16 @@
 import difflib
+from collections import UserList
 
 
-class Annotations:
-    def __init__(self):
-        self.annotations = []
-
-    def get(self):
-        """
-        Retrieve the list of annotations stored in this instance.
-
-        Returns:
-            list: A list containing all annotations.
-        """
-        return self.annotations
-
+class Annotations(UserList):
     def add_annotations(self, annotations):
         """Merge another Annotations instance into this instance by appending its
         annotations.
 
         Args:
             annotations: The Annotations object to append.
         """
-        return self.annotations.extend(annotations.get())
+        return self.extend(annotations)
 
     def add(self, line_number, error_msg, is_warning=False):
         """Adds the error message to the list of annotations.
@@ -34,7 +23,7 @@ def add(self, line_number, error_msg, is_warning=False):
                 treated as an error.
         """
         error_type = "warning" if is_warning else "error"
-        self.annotations.append(
+        self.append(
             {
                 "row": line_number,
                 "column": 0,
@@ -73,7 +62,3 @@ def suggest(self, word_to_match, possible_matches):
             suggestion = f"Did you mean {close_matches[0]!r}?\n"
 
         return suggestion
-
-    def clear(self):
-        """Clear all stored annotations."""
-        self.annotations.clear()

waveform_editor/waveform.py

@@ -124,7 +124,7 @@ def _process_waveform(self, waveform):
             self.tendencies[i].set_previous_tendency(self.tendencies[i - 1])
 
         for tendency in self.tendencies:
-            if tendency.annotations.get():
+            if tendency.annotations:
                 self.annotations.add_annotations(tendency.annotations)
 
     def _handle_tendency(self, entry):

waveform_editor/waveform_editor_gui.py

@@ -42,7 +42,7 @@ def update_plot(value):
     yaml_alert.visible = error_alert.visible = False
     yaml_parser.parse_waveforms_from_string(value)
 
-    code_editor.annotations = yaml_parser.waveform.annotations.get()
+    code_editor.annotations = list(yaml_parser.waveform.annotations)
     code_editor.param.trigger("annotations")
 
     # Show alert when there is a yaml parsing error