create annotations class for handling annotations

Author: SBlokhuizen

waveform_editor/annotations.py

@@ -0,0 +1,56 @@
+import difflib
+
+
+class Annotations:
+    def __init__(self):
+        self.annotations = []
+
+    def get(self):
+        return self.annotations
+
+    def add_annotations(self, annotations):
+        return self.annotations.extend(annotations.get())
+
+    def add(self, line_number, error_msg, is_warning=False):
+        """Adds the error message to the list of annotations.
+
+        Args:
+            annotations: The list of annotations the error message is added to.
+            line_number: The line number at which the error occurs.
+            error_msg: The error message the annotation should display.
+            error_type: Whether the annotation is a warning. If set to False, it is
+                treated as an error.
+        """
+        error_type = "warning" if is_warning else "error"
+        self.annotations.extend(
+            [
+                {
+                    "row": line_number,
+                    "column": 0,
+                    "text": error_msg,
+                    "type": error_type,
+                }
+            ]
+        )
+
+    def add_yaml_error(self, error):
+        if hasattr(error, "problem_mark"):
+            line = error.problem_mark.line
+            # TODO: Is there a way to visualize the column into the annotation?
+            # column = error.problem_mark.column
+            message = error.problem
+
+            self.add(line, message)
+        else:
+            self.add(0, f"Unknown YAML error: {error}")
+
+    def create_suggestion(self, match, list):
+        suggestion = ""
+        close_matches = difflib.get_close_matches(match, list, n=1)
+        if close_matches:
+            suggestion = f"Did you mean {close_matches[0]!r}?"
+
+        return suggestion
+
+    def clear(self):
+        self.annotations.clear()

waveform_editor/tendencies/base.py

@@ -5,9 +5,9 @@
 import param
 from param import depends
 
+from waveform_editor.annotations import Annotations
 from waveform_editor.tendencies.util import (
     InconsistentInputsError,
-    add_annotation,
     solve_with_constraints,
 )
 
@@ -81,7 +81,7 @@ class BaseTendency(param.Parameterized):
     )
 
     def __init__(self, **kwargs):
-        self.annotations = []
+        self.annotations = Annotations()
         self._check_for_unknown_kwargs(kwargs)
         super().__init__(**kwargs)
 
@@ -222,4 +222,4 @@ def _check_for_unknown_kwargs(self, kwargs):
                     " they will be ignored.",
                 )
 
-            add_annotation(self.annotations, line_number, error_msg, is_warning=True)
+            self.annotations.add(line_number, error_msg, is_warning=True)

waveform_editor/tendencies/util.py

@@ -33,26 +33,3 @@ def solve_with_constraints(inputs, constraint_matrix):
         raise InconsistentInputsError()
 
     return tuple(inputs)
-
-
-def add_annotation(annotations, line_number, error_msg, is_warning=False):
-    """Adds the error message to the list of annotations.
-
-    Args:
-        annotations: The list of annotations the error message is added to.
-        line_number: The line number at which the error occurs.
-        error_msg: The error message the annotation should display.
-        error_type: Whether the annotation is a warning. If set to False, it is treated
-            as an error.
-    """
-    error_type = "warning" if is_warning else "error"
-    annotations.extend(
-        [
-            {
-                "row": line_number,
-                "column": 0,
-                "text": error_msg,
-                "type": error_type,
-            }
-        ]
-    )

waveform_editor/waveform.py

@@ -3,6 +3,7 @@
 
 import numpy as np
 
+from waveform_editor.annotations import Annotations
 from waveform_editor.tendencies.constant import ConstantTendency
 from waveform_editor.tendencies.linear import LinearTendency
 from waveform_editor.tendencies.periodic.sawtooth_wave import SawtoothWaveTendency
@@ -12,7 +13,6 @@
 from waveform_editor.tendencies.piecewise import PiecewiseLinearTendency
 from waveform_editor.tendencies.repeat import RepeatTendency
 from waveform_editor.tendencies.smooth import SmoothTendency
-from waveform_editor.tendencies.util import add_annotation
 
 tendency_map = {
     "linear": LinearTendency,
@@ -34,7 +34,7 @@
 class Waveform:
     def __init__(self, waveform):
         self.tendencies = []
-        self.annotations = []
+        self.annotations = Annotations()
         self._process_waveform(waveform)
 
     def get_value(
@@ -114,8 +114,8 @@ def _process_waveform(self, waveform):
             self.tendencies[i].set_previous_tendency(self.tendencies[i - 1])
 
         for tendency in self.tendencies:
-            if tendency.annotations != []:
-                self.annotations.extend(tendency.annotations)
+            if tendency.annotations.get() != []:
+                self.annotations.add_annotations(tendency.annotations)
 
     def _handle_tendency(self, entry):
         """Creates a tendency instance based on the entry in the YAML file.
@@ -137,9 +137,17 @@ def _handle_tendency(self, entry):
             return tendency
         else:
             line_number = entry.pop("line_number")
+
+            suggestions = ""
+            close_matches = difflib.get_close_matches(
+                tendency_type, tendency_map.keys(), n=1
+            )
+            if close_matches:
+                suggestions = f"Did you mean {close_matches[0]!r}?"
+
             error_msg = (
-                f"Unsupported tendency type: {tendency_type}. "
+                f"Unsupported tendency type: {tendency_type}, {suggestions} \n"
                 "This tendency will be ignored.",
             )
-            add_annotation(self.annotations, line_number, error_msg, is_warning=True)
+            self.annotations.add(line_number, error_msg, is_warning=True)
             return None

waveform_editor/waveform_editor_gui.py

@@ -27,7 +27,7 @@
 yaml_parser = YamlParser()
 
 alert_pane = pn.pane.Alert(
-    "### The YAML did not parse correctly (see editor)!",
+    "### The YAML did not parse correctly! (see editor)",
     alert_type="danger",
     visible=False,
 )
@@ -36,7 +36,7 @@
 def update_plot(value):
     yaml_parser.parse_waveforms_from_string(value)
 
-    code_editor.annotations = yaml_parser.annotations
+    code_editor.annotations = yaml_parser.annotations.get()
     code_editor.param.trigger("annotations")
 
     if yaml_parser.waveform is None:

waveform_editor/yaml_parser.py

@@ -2,7 +2,7 @@
 import param
 import yaml
 
-from waveform_editor.tendencies.util import add_annotation
+from waveform_editor.annotations import Annotations
 from waveform_editor.waveform import Waveform
 
 
@@ -15,12 +15,9 @@ def construct_mapping(self, node, deep=False):
 
 
 class YamlParser(param.Parameterized):
-    waveform = param.ClassSelector(
-        class_=Waveform,
-        default=None,
-        doc="Waveform that contains the tendencies.",
-    )
-    annotations = param.List(doc="List of error messages")
+    def __init__(self):
+        # self.waveform = None
+        self.annotations = Annotations()
 
     def parse_waveforms_from_file(self, file_path):
         """Loads a YAML file from a file path and stores its tendencies into a list.
@@ -46,24 +43,9 @@ def parse_waveforms_from_string(self, yaml_str):
             self.waveform = Waveform(waveform)
             self.annotations = self.waveform.annotations
         except yaml.YAMLError as e:
-            self.annotations = self.yaml_error_to_annotation(e)
+            self.annotations.add_yaml_error(e)
             self.waveform = None
 
-    def yaml_error_to_annotation(self, error):
-        annotations = []
-
-        if hasattr(error, "problem_mark"):
-            line = error.problem_mark.line
-            # TODO: Is there a way to visualize the column into the annotation?
-            # column = error.problem_mark.column
-            message = error.problem
-
-            add_annotation(annotations, line, message)
-        else:
-            add_annotation(0, 0, f"Unknown YAML error: {error}")
-
-        return annotations
-
     def plot_empty(self):
         overlay = hv.Overlay()