restored from old pydanitc_v2_migration branch

Author: sanderegg

packages/common-library/src/common_library/error_codes.py

@@ -0,0 +1,31 @@
+""" osparc ERROR CODES (OEC)
+  Unique identifier of an exception instance
+  Intended to report a user about unexpected errors.
+    Unexpected exceptions can be traced by matching the
+    logged error code with that appeneded to the user-friendly message
+
+SEE test_error_codes for some use cases
+"""
+
+import re
+from typing import TYPE_CHECKING, Annotated
+
+from pydantic import StringConstraints, TypeAdapter
+
+_LABEL = "OEC:{}"
+_PATTERN = r"OEC:\d+"
+
+if TYPE_CHECKING:
+    ErrorCodeStr = str
+else:
+    ErrorCodeStr = Annotated[
+        str, StringConstraints(strip_whitespace=True, pattern=_PATTERN)
+    ]
+
+
+def create_error_code(exception: BaseException) -> ErrorCodeStr:
+    return TypeAdapter(ErrorCodeStr).validate_python(_LABEL.format(id(exception)))
+
+
+def parse_error_code(obj) -> set[ErrorCodeStr]:
+    return set(re.findall(_PATTERN, f"{obj}"))

packages/common-library/tests/test_errors_classes.py

@@ -136,24 +136,28 @@ class MyError(OsparcErrorMixin, ValueError):
 
 
 def test_missing_keys_in_msg_template_does_not_raise():
-    class MyErrorBefore(OsparcErrorMixin, ValueError):
-        msg_template = "{value} and {missing}"
-
-    with pytest.raises(KeyError, match="missing"):
-        str(MyErrorBefore(value=42))
-
-    class MyErrorAfter(OsparcErrorMixin, ValueError):
+    class MyError(OsparcErrorMixin, ValueError):
         msg_template = "{value} and {missing}"
 
-    assert str(MyErrorAfter(value=42)) == "42 and 'missing=?'"
+    assert str(MyError(value=42)) == "42 and 'missing=?'"
 
 
 def test_exception_context():
     class MyError(OsparcErrorMixin, ValueError):
         msg_template = "{value} and {missing}"
 
     exc = MyError(value=42, missing="foo", extra="bar")
-    assert exc.error_context() == {"value": 42, "missing": "foo", "extra": "bar"}
+    assert exc.error_context() == {
+        "code": "ValueError.MyError",
+        "message": "42 and foo",
+        "value": 42,
+        "missing": "foo",
+        "extra": "bar",
+    }
 
     exc = MyError(value=42)
-    assert exc.error_context() == {"value": 42}
+    assert exc.error_context() == {
+        "code": "ValueError.MyError",
+        "message": "42 and 'missing=?'",
+        "value": 42,
+    }