From af767078bfe1921887d2e80b9b2ba7262c045016 Mon Sep 17 00:00:00 2001 From: Felix Weiler-Detjen Date: Wed, 11 Dec 2024 12:15:16 +0100 Subject: [PATCH] Rename UnpackError to UnpackerError --- docs/reference.md | 2 +- src/heisskleber/core/__init__.py | 4 ++-- src/heisskleber/core/unpacker.py | 8 ++++---- src/heisskleber/mqtt/receiver.py | 2 +- src/heisskleber/serial/receiver.py | 2 +- src/heisskleber/tcp/receiver.py | 2 +- src/heisskleber/udp/receiver.py | 2 +- src/heisskleber/zmq/receiver.py | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/reference.md b/docs/reference.md index 9dfbe00..4f7945b 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -27,7 +27,7 @@ See for a tutorial on how to implement custom packer ### Errors ```{eval-rst} -.. autoclass:: heisskleber.core::UnpackError +.. autoclass:: heisskleber.core::UnpackerError .. autoclass:: heisskleber.core::PackerError ``` diff --git a/src/heisskleber/core/__init__.py b/src/heisskleber/core/__init__.py index 95ae358..0828a0b 100644 --- a/src/heisskleber/core/__init__.py +++ b/src/heisskleber/core/__init__.py @@ -4,7 +4,7 @@ from .config import BaseConf, ConfigType from .packer import JSONPacker, Packer, PackerError from .receiver import Receiver from .sender import Sender -from .unpacker import JSONUnpacker, Unpacker, UnpackError +from .unpacker import JSONUnpacker, Unpacker, UnpackerError json_packer = JSONPacker() json_unpacker = JSONUnpacker() @@ -19,5 +19,5 @@ __all__ = [ "BaseConf", "ConfigType", "PackerError", - "UnpackError", + "UnpackerError", ] diff --git a/src/heisskleber/core/unpacker.py b/src/heisskleber/core/unpacker.py index 198a68d..5fd305a 100644 --- a/src/heisskleber/core/unpacker.py +++ b/src/heisskleber/core/unpacker.py @@ -7,7 +7,7 @@ from typing import Any, Protocol, TypeVar T_co = TypeVar("T_co", covariant=True) -class UnpackError(Exception): +class UnpackerError(Exception): """Raised when unpacking operations fail. This exception wraps underlying errors that may occur during unpacking, @@ -49,7 +49,7 @@ class Unpacker(Protocol[T_co]): - dict[str, Any]: The meta data associated with the unpack operation, such as topic, timestamp or errors Raises: - UnpackError: The payload could not be unpacked. + UnpackerError: The payload could not be unpacked. """ @@ -66,7 +66,7 @@ class JSONUnpacker(Unpacker[dict[str, Any]]): - An empty dictionary for metadata (not used in JSON unpacking) Raises: - UnpackError: If the payload cannot be decoded as valid JSON. + UnpackerError: If the payload cannot be decoded as valid JSON. Example: >>> unpacker = JSONUnpacker() @@ -81,4 +81,4 @@ class JSONUnpacker(Unpacker[dict[str, Any]]): try: return json.loads(payload), {} except json.JSONDecodeError as e: - raise UnpackError(payload) from e + raise UnpackerError(payload) from e diff --git a/src/heisskleber/mqtt/receiver.py b/src/heisskleber/mqtt/receiver.py index 1e0b890..c929f15 100644 --- a/src/heisskleber/mqtt/receiver.py +++ b/src/heisskleber/mqtt/receiver.py @@ -62,7 +62,7 @@ class MqttReceiver(Receiver[T]): Raises: TypeError: If the message payload is not of type bytes. - UnpackError: If the message could not be unpacked with the unpacker protocol. + UnpackerError: If the message could not be unpacked with the unpacker protocol. """ if not self._listener_task: diff --git a/src/heisskleber/serial/receiver.py b/src/heisskleber/serial/receiver.py index a4332a9..4e08662 100644 --- a/src/heisskleber/serial/receiver.py +++ b/src/heisskleber/serial/receiver.py @@ -44,7 +44,7 @@ class SerialReceiver(Receiver[T]): tuple[T, dict[str, Any]]: A tuple containing the unpacked data and any extra information. Raises: - UnpackError: If the data could not be unpacked with the provided unpacker. + UnpackerError: If the data could not be unpacked with the provided unpacker. """ if not self._is_connected: diff --git a/src/heisskleber/tcp/receiver.py b/src/heisskleber/tcp/receiver.py index 07dae80..31a913c 100644 --- a/src/heisskleber/tcp/receiver.py +++ b/src/heisskleber/tcp/receiver.py @@ -36,7 +36,7 @@ class TcpReceiver(Receiver[T]): Raises: TypeError: If the message payload is not of type bytes. - UnpackError: If the message could not be unpacked with the unpacker protocol. + UnpackerError: If the message could not be unpacked with the unpacker protocol. """ data = b"" diff --git a/src/heisskleber/udp/receiver.py b/src/heisskleber/udp/receiver.py index 0c61b8c..f668bba 100644 --- a/src/heisskleber/udp/receiver.py +++ b/src/heisskleber/udp/receiver.py @@ -69,7 +69,7 @@ class UdpReceiver(Receiver[T]): - A dictionary containing extra information. Raises: - UnpackError: If the received message could not be unpacked. + UnpackerError: If the received message could not be unpacked. """ if not self._is_connected: diff --git a/src/heisskleber/zmq/receiver.py b/src/heisskleber/zmq/receiver.py index 9db4ab1..4a80dfd 100644 --- a/src/heisskleber/zmq/receiver.py +++ b/src/heisskleber/zmq/receiver.py @@ -38,7 +38,7 @@ class ZmqReceiver(Receiver[T]): tuple(topic: str, message: dict): the message received Raises: - UnpackError: If payload could not be unpacked with provided unpacker. + UnpackerError: If payload could not be unpacked with provided unpacker. """ if not self.is_connected: