Merge pull request #4 from michealroberts/feature/errors/SerialWriteError

feat: add SerialWriteError to errors in samps module

Author: michealroberts

src/samps/__init__.py

@@ -5,7 +5,7 @@
 
 # **************************************************************************************
 
-from .errors import SerialReadError
+from .errors import SerialReadError, SerialWriteError
 
 # **************************************************************************************
 
@@ -19,6 +19,7 @@
 
 __all__: list[str] = [
     "SerialReadError",
+    "SerialWriteError",
 ]
 
 # **************************************************************************************

src/samps/errors.py

@@ -16,3 +16,15 @@ def __init__(self, message: str) -> None:
 
 
 # **************************************************************************************
+
+
+class SerialWriteError(Exception):
+    """
+    Exception class for serial write errors.
+    """
+
+    def __init__(self, message: str) -> None:
+        super().__init__(message)
+
+
+# **************************************************************************************

test/test_errors.py

@@ -7,7 +7,7 @@
 
 import unittest
 
-from samps import SerialReadError
+from samps import SerialReadError, SerialWriteError
 
 # **************************************************************************************
 
@@ -35,3 +35,28 @@ def test_raising_error(self):
 
 
 # **************************************************************************************
+
+
+class TestSerialWriteError(unittest.TestCase):
+    def test_inheritance(self):
+        """Test that SerialWriteError inherits from the built-in Exception class."""
+        self.assertTrue(issubclass(SerialWriteError, Exception))
+
+    def test_error_message(self):
+        """Test that the error message is correctly set and retrieved."""
+        test_message = "This is a test error message."
+        error = SerialWriteError(test_message)
+        self.assertEqual(str(error), test_message)
+
+    def test_raising_error(self):
+        """
+        Test that raising SerialWriteError with a specific message
+        results in that message being available on the exception.
+        """
+        test_message = "An error occurred."
+        with self.assertRaises(SerialWriteError) as context:
+            raise SerialWriteError(test_message)
+        self.assertEqual(str(context.exception), test_message)
+
+
+# **************************************************************************************