Exceptions in separate file

Author: HEnquist

camilladsp/__init__.py

@@ -6,6 +6,8 @@
 from camilladsp.datastructures import (
     ProcessingState,
     StopReason,
+)
+from camilladsp.exceptions import (
     CamillaError,
     InvalidRequestError,
     InvalidValueError,

camilladsp/camillaws.py

@@ -9,9 +9,9 @@
 import json
 from websocket import create_connection, WebSocket  # type: ignore
 
-from .datastructures import (
+from .exceptions import (
     CamillaError,
-    raise_error,
+    _raise_error,
 )
 
 
@@ -69,7 +69,7 @@ def _handle_reply(self, command: str, rawreply: Union[str, bytes]):
                 value = response_data.get("value")
                 if state == "Ok":
                     return value
-                raise_error(state, message, value)
+                _raise_error(state, message, value)
             raise IOError(f"Invalid response received: {rawreply!r}")
         except json.JSONDecodeError as err:
             raise IOError(f"Invalid response received: {rawreply!r}") from err

camilladsp/datastructures.py

@@ -3,7 +3,7 @@
 """
 
 from enum import Enum, auto
-from typing import Any, Optional, TypedDict
+from typing import Optional, TypedDict
 
 _STANDARD_RATES = (
     8000,
@@ -130,90 +130,6 @@ def _reason_from_reply(value):
     return reasonenum
 
 
-class CamillaError(Exception):
-    """
-    Base class for errors returned by CamillaDSP.
-    The 'message' attribute holds an optional message as a string,
-    while the 'value' attribute holds an optional value.
-    """
-
-    def __init__(self, message: Optional[str] = None, value: Any = None):
-        self.message = message
-        self.value = value
-        super().__init__(self.message)
-
-
-class ShutdownInProgressError(CamillaError):
-    """
-    CamillaDSP is shutting down and unable to handle any more commands.
-    """
-
-
-class RateLimitExceededError(CamillaError):
-    """
-    Too many requests were sent.
-    """
-
-
-class InvalidValueError(CamillaError):
-    """
-    An invalid value was supplied with a command.
-    """
-
-
-class InvalidRequestError(CamillaError):
-    """
-    An invalid command was sent.
-    """
-
-
-class InvalidFaderError(CamillaError):
-    """
-    An invalid fader index was supplied with a command.
-    """
-
-
-class ConfigValidationError(CamillaError):
-    """
-    The supplied config is invalid.
-    """
-
-
-class ConfigReadError(CamillaError):
-    """
-    An error occurred while reading the config file.
-    """
-
-
-class UnknownError(CamillaError):
-    """
-    An unknown error occurred.
-    This should only happen if this library is used
-    with a different version of CamillaDSP than it was intended for.
-    """
-
-
-def raise_error(state: str, message: Optional[str], value: Any):
-    """
-    Raise the appropriate exception for the given error state.
-    """
-    if state == "RateLimitExceededError":
-        raise RateLimitExceededError()
-    if state == "ShutdownInProgressError":
-        raise ShutdownInProgressError()
-    if state == "InvalidValueError":
-        raise InvalidValueError(message=message, value=value)
-    if state == "InvalidRequestError":
-        raise InvalidRequestError(message=message, value=value)
-    if state == "InvalidFaderError":
-        raise InvalidFaderError(value=value)
-    if state == "ConfigValidationError":
-        raise ConfigValidationError(message=message, value=value)
-    if state == "ConfigReadError":
-        raise ConfigReadError(message=message, value=value)
-    raise UnknownError(message=message, value=value)
-
-
 class Fader(TypedDict):
     """
     Class for type annotation of fader volume and mute settings.

camilladsp/exceptions.py

@@ -0,0 +1,89 @@
+"""
+Exceptions that may be raised by this library.
+"""
+
+from typing import Any, Optional
+
+
+class CamillaError(Exception):
+    """
+    Base class for errors returned by CamillaDSP.
+    The 'message' attribute holds an optional message as a string,
+    while the 'value' attribute holds an optional value.
+    """
+
+    def __init__(self, message: Optional[str] = None, value: Any = None):
+        self.message = message
+        self.value = value
+        super().__init__(self.message)
+
+
+class ShutdownInProgressError(CamillaError):
+    """
+    CamillaDSP is shutting down and unable to handle any more commands.
+    """
+
+
+class RateLimitExceededError(CamillaError):
+    """
+    Too many requests were sent.
+    """
+
+
+class InvalidValueError(CamillaError):
+    """
+    An invalid value was supplied with a command.
+    """
+
+
+class InvalidRequestError(CamillaError):
+    """
+    An invalid command was sent.
+    """
+
+
+class InvalidFaderError(CamillaError):
+    """
+    An invalid fader index was supplied with a command.
+    """
+
+
+class ConfigValidationError(CamillaError):
+    """
+    The supplied config is invalid.
+    """
+
+
+class ConfigReadError(CamillaError):
+    """
+    An error occurred while reading the config file.
+    """
+
+
+class UnknownError(CamillaError):
+    """
+    An unknown error occurred.
+    This should only happen if this library is used
+    with a different version of CamillaDSP than it was intended for.
+    """
+
+
+def _raise_error(state: str, message: Optional[str], value: Any):
+    """
+    Raise the appropriate exception for the given error state.
+    """
+    if state == "RateLimitExceededError":
+        raise RateLimitExceededError()
+    if state == "ShutdownInProgressError":
+        raise ShutdownInProgressError()
+    if state == "InvalidValueError":
+        raise InvalidValueError(message=message, value=value)
+    if state == "InvalidRequestError":
+        raise InvalidRequestError(message=message, value=value)
+    if state == "InvalidFaderError":
+        raise InvalidFaderError(value=value)
+    if state == "ConfigValidationError":
+        raise ConfigValidationError(message=message, value=value)
+    if state == "ConfigReadError":
+        raise ConfigReadError(message=message, value=value)
+    raise UnknownError(message=message, value=value)

docs/errors.md

@@ -1,7 +1,9 @@
 
 # Errors
 
-The custom exception [CamillaError][camilladsp.datastructures.CamillaError] is raised when CamillaDSP replies to a command with an error message. The error message is given as the message of the exception.
+The exception [CamillaError][camilladsp.exceptions.CamillaError]
+or one of its subclasses is raised when CamillaDSP replies to a command with an error message.
+The error message is given as the message of the exception.
 
 Different exceptions are raised in different situations. Consider the following example:
 ```python
@@ -24,5 +26,6 @@ except IOError as e:
 - `IOError` can mean a few things, but the most likely is that the websocket connection was lost.
   This happens if the CamillaDSP process exits or is restarted.
 
-## CamillaError
-::: camilladsp.datastructures.CamillaError
+## Exceptions
+::: camilladsp.exceptions
+