Add base exception

All exceptions from this library inherit from this exception.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

RELEASE_NOTES.md

@@ -10,7 +10,8 @@
 
 ## New Features
 
-<!-- Here goes the main new features and examples or instructions on how to use them -->
+* A new base exception `frequenz.channels.Error` was added. All exceptions from
+  this library inherit from this exception.
 
 ## Bug Fixes
 

src/frequenz/channels/__init__.py

@@ -38,6 +38,9 @@
 
 Exception classes:
 
+* [Error][frequenz.channels.Error]: Base class for all errors in this
+  library.
+
 * [ChannelError][frequenz.channels.ChannelError]: Base class for all errors
   related to channels.
 
@@ -47,7 +50,14 @@
 
 from . import util
 from ._anycast import Anycast
-from ._base_classes import ChannelClosedError, ChannelError, Peekable, Receiver, Sender
+from ._base_classes import (
+    ChannelClosedError,
+    ChannelError,
+    Error,
+    Peekable,
+    Receiver,
+    Sender,
+)
 from ._bidirectional import Bidirectional
 from ._broadcast import Broadcast
 
@@ -57,6 +67,7 @@
     "Broadcast",
     "ChannelClosedError",
     "ChannelError",
+    "Error",
     "Peekable",
     "Receiver",
     "Sender",

src/frequenz/channels/_base_classes.py

@@ -12,7 +12,22 @@
 U = TypeVar("U")
 
 
-class ChannelError(RuntimeError):
+class Error(RuntimeError):
+    """Base error.
+
+    All exceptions generated by this library inherit from this exception.
+    """
+
+    def __init__(self, message: Any):
+        """Create a ChannelError instance.
+
+        Args:
+            message: An error message.
+        """
+        super().__init__(message)
+
+
+class ChannelError(Error):
     """Base channel error.
 
     All exceptions generated by channels inherit from this exception.