[core] add serialization and deserialization errors (#24113)

iscai-msft · web-flow · commit 35208401074a · 2022-05-02T14:36:28.000-07:00
diff --git a/sdk/core/azure-core/CHANGELOG.md b/sdk/core/azure-core/CHANGELOG.md
@@ -1,9 +1,11 @@
 # Release History
 
-## 1.23.2 (Unreleased)
+## 1.24.0 (Unreleased)
 
 ### Features Added
 
+- Add `SerializationError` and `DeserializationError` in `azure.core.serialization` for errors raised during serialization / deserialization  #24113
+
 ### Breaking Changes
 
 ### Bugs Fixed
diff --git a/sdk/core/azure-core/azure/core/_version.py b/sdk/core/azure-core/azure/core/_version.py
@@ -9,4 +9,4 @@
 # regenerated.
 # --------------------------------------------------------------------------
 
-VERSION = "1.23.2"
+VERSION = "1.24.0"
diff --git a/sdk/core/azure-core/azure/core/serialization.py b/sdk/core/azure-core/azure/core/serialization.py
@@ -11,7 +11,7 @@
 from .utils._utils import _FixedOffset
 
 
-__all__ = ["NULL", "AzureJSONEncoder"]
+__all__ = ["NULL", "AzureJSONEncoder", "SerializationError", "DeserializationError"]
 
 
 class _Null(object):
@@ -123,3 +123,11 @@ def default(self, o):  # pylint: disable=too-many-return-statements
         except AttributeError:
             pass
         return super(AzureJSONEncoder, self).default(o)
+
+class SerializationError(ValueError):
+    """Raised if an error is encountered during serialization."""
+    ...
+
+class DeserializationError(ValueError):
+    """Raised if an error is encountered during deserialization."""
+    ...
diff --git a/sdk/core/azure-core/tests/test_serialization.py b/sdk/core/azure-core/tests/test_serialization.py
@@ -8,7 +8,7 @@
 import json
 import sys
 
-from azure.core.serialization import AzureJSONEncoder, NULL
+from azure.core.serialization import AzureJSONEncoder, NULL, SerializationError, DeserializationError
 import pytest
 
 
@@ -442,3 +442,25 @@ def __init__(self):
         ]
     }
     assert json.loads(json_dumps_with_encoder(expected.to_dict())) == expected_dict
+
+def test_serialization_error():
+    message = "Oopsy bad input passed for serialization"
+    error = SerializationError(message)
+    with pytest.raises(SerializationError) as ex:
+        raise error
+    assert str(ex.value) == message
+
+    with pytest.raises(ValueError) as ex:
+        raise error
+    assert str(ex.value) == message
+
+def test_deserialization_error():
+    message = "Oopsy bad input passed for serialization"
+    error = DeserializationError(message)
+    with pytest.raises(DeserializationError) as ex:
+        raise error
+    assert str(ex.value) == message
+
+    with pytest.raises(ValueError) as ex:
+        raise error
+    assert str(ex.value) == message
