[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v4 02/27] python/aqmp: add error classes
From: |
John Snow |
Subject: |
[PATCH v4 02/27] python/aqmp: add error classes |
Date: |
Wed, 15 Sep 2021 12:29:30 -0400 |
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
---
python/qemu/aqmp/__init__.py | 4 +++
python/qemu/aqmp/error.py | 50 ++++++++++++++++++++++++++++++++++++
2 files changed, 54 insertions(+)
create mode 100644 python/qemu/aqmp/error.py
diff --git a/python/qemu/aqmp/__init__.py b/python/qemu/aqmp/__init__.py
index 391141c948..c97be950bf 100644
--- a/python/qemu/aqmp/__init__.py
+++ b/python/qemu/aqmp/__init__.py
@@ -21,7 +21,11 @@
# This work is licensed under the terms of the GNU GPL, version 2. See
# the COPYING file in the top-level directory.
+from .error import AQMPError
+
# The order of these fields impact the Sphinx documentation order.
__all__ = (
+ # Exceptions
+ 'AQMPError',
)
diff --git a/python/qemu/aqmp/error.py b/python/qemu/aqmp/error.py
new file mode 100644
index 0000000000..781f49b008
--- /dev/null
+++ b/python/qemu/aqmp/error.py
@@ -0,0 +1,50 @@
+"""
+AQMP Error Classes
+
+This package seeks to provide semantic error classes that are intended
+to be used directly by clients when they would like to handle particular
+semantic failures (e.g. "failed to connect") without needing to know the
+enumeration of possible reasons for that failure.
+
+AQMPError serves as the ancestor for all exceptions raised by this
+package, and is suitable for use in handling semantic errors from this
+library. In most cases, individual public methods will attempt to catch
+and re-encapsulate various exceptions to provide a semantic
+error-handling interface.
+
+.. admonition:: AQMP Exception Hierarchy Reference
+
+ | `Exception`
+ | +-- `AQMPError`
+ | +-- `ConnectError`
+ | +-- `StateError`
+ | +-- `ExecInterruptedError`
+ | +-- `ExecuteError`
+ | +-- `ListenerError`
+ | +-- `ProtocolError`
+ | +-- `DeserializationError`
+ | +-- `UnexpectedTypeError`
+ | +-- `ServerParseError`
+ | +-- `BadReplyError`
+ | +-- `GreetingError`
+ | +-- `NegotiationError`
+"""
+
+
+class AQMPError(Exception):
+ """Abstract error class for all errors originating from this package."""
+
+
+class ProtocolError(AQMPError):
+ """
+ Abstract error class for protocol failures.
+
+ Semantically, these errors are generally the fault of either the
+ protocol server or as a result of a bug in this library.
+
+ :param error_message: Human-readable string describing the error.
+ """
+ def __init__(self, error_message: str):
+ super().__init__(error_message)
+ #: Human-readable error message, without any prefix.
+ self.error_message: str = error_message
--
2.31.1
- [PATCH v4 00/27] python: introduce Asynchronous QMP package, John Snow, 2021/09/15
- [PATCH v4 01/27] python/aqmp: add asynchronous QMP (AQMP) subpackage, John Snow, 2021/09/15
- [PATCH v4 02/27] python/aqmp: add error classes,
John Snow <=
- [PATCH v4 03/27] python/pylint: Add exception for TypeVar names ('T'), John Snow, 2021/09/15
- [PATCH v4 04/27] python/aqmp: add asyncio compatibility wrappers, John Snow, 2021/09/15
- [PATCH v4 06/27] python/aqmp: add runstate state machine to AsyncProtocol, John Snow, 2021/09/15
- [PATCH v4 05/27] python/aqmp: add generic async message-based protocol support, John Snow, 2021/09/15
- [PATCH v4 07/27] python/aqmp: Add logging utility helpers, John Snow, 2021/09/15
- [PATCH v4 08/27] python/aqmp: add logging to AsyncProtocol, John Snow, 2021/09/15
- [PATCH v4 09/27] python/aqmp: add AsyncProtocol.accept() method, John Snow, 2021/09/15
- [PATCH v4 10/27] python/aqmp: add configurable read buffer limit, John Snow, 2021/09/15
- [PATCH v4 11/27] python/aqmp: add _cb_inbound and _cb_outbound logging hooks, John Snow, 2021/09/15
- [PATCH v4 12/27] python/aqmp: add AsyncProtocol._readline() method, John Snow, 2021/09/15