diff mbox series

[08/15] python/aqmp: Create MessageModel and StandaloneModel classes

Message ID 20210917054047.2042843-9-jsnow@redhat.com (mailing list archive)
State New, archived
Headers show
Series Switch iotests to using Async QMP | expand

Commit Message

John Snow Sept. 17, 2021, 5:40 a.m. UTC
This allows 'Greeting' to be subclass of 'Message'. We need the adapter
classes to avoid some typing problems that occur if we try to put too
much into the 'Model' class itself; the exact details of why are left as
an exercise to the reader.

Why bother? This makes 'Greeting' ⊆ 'Message', which is taxonomically
true; but the real motivation is to be able to inherit and abuse all of
the Mapping dunders so that we can call dict(greeting) or
bytes(greeting), for example.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 python/qemu/aqmp/models.py | 67 ++++++++++++++++++++++++++++----------
 1 file changed, 50 insertions(+), 17 deletions(-)

Comments

Hanna Reitz Sept. 17, 2021, 1:39 p.m. UTC | #1
On 17.09.21 07:40, John Snow wrote:
> This allows 'Greeting' to be subclass of 'Message'. We need the adapter
> classes to avoid some typing problems that occur if we try to put too
> much into the 'Model' class itself; the exact details of why are left as
> an exercise to the reader.
>
> Why bother? This makes 'Greeting' ⊆ 'Message', which is taxonomically
> true; but the real motivation is to be able to inherit and abuse all of
> the Mapping dunders so that we can call dict(greeting) or
> bytes(greeting), for example.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>   python/qemu/aqmp/models.py | 67 ++++++++++++++++++++++++++++----------
>   1 file changed, 50 insertions(+), 17 deletions(-)

(I feel like this is a bit much outside of my scope, so this’ll have to 
do without my R-b.)
John Snow Sept. 17, 2021, 7:21 p.m. UTC | #2
On Fri, Sep 17, 2021, 9:39 AM Hanna Reitz <hreitz@redhat.com> wrote:

> On 17.09.21 07:40, John Snow wrote:
> > This allows 'Greeting' to be subclass of 'Message'. We need the adapter
> > classes to avoid some typing problems that occur if we try to put too
> > much into the 'Model' class itself; the exact details of why are left as
> > an exercise to the reader.
> >
> > Why bother? This makes 'Greeting' ⊆ 'Message', which is taxonomically
> > true; but the real motivation is to be able to inherit and abuse all of
> > the Mapping dunders so that we can call dict(greeting) or
> > bytes(greeting), for example.
> >
> > Signed-off-by: John Snow <jsnow@redhat.com>
> > ---
> >   python/qemu/aqmp/models.py | 67 ++++++++++++++++++++++++++++----------
> >   1 file changed, 50 insertions(+), 17 deletions(-)
>
> (I feel like this is a bit much outside of my scope, so this’ll have to
> do without my R-b.)
>

It's a patch I like the least, too. I shouldn't have included it here in
this series. It needs more time in the oven and it should be included ...
somewhere else.

Sorry about this one.

>
diff mbox series

Patch

diff --git a/python/qemu/aqmp/models.py b/python/qemu/aqmp/models.py
index 24c94123ac..eaeeebc25c 100644
--- a/python/qemu/aqmp/models.py
+++ b/python/qemu/aqmp/models.py
@@ -15,23 +15,22 @@ 
     Sequence,
 )
 
+from .message import Message
+
 
 class Model:
     """
-    Abstract data model, representing some QMP object of some kind.
-
-    :param raw: The raw object to be validated.
-    :raise KeyError: If any required fields are absent.
-    :raise TypeError: If any required fields have the wrong type.
+    Abstract data model, representing a QMP object of some kind.
     """
-    def __init__(self, raw: Mapping[str, Any]):
-        self._raw = raw
+    @property
+    def _raw(self) -> Mapping[str, Any]:
+        raise NotImplementedError
 
     def _check_key(self, key: str) -> None:
         if key not in self._raw:
             raise KeyError(f"'{self._name}' object requires '{key}' member")
 
-    def _check_value(self, key: str, type_: type, typestr: str) -> None:
+    def _check_type(self, key: str, type_: type, typestr: str) -> None:
         assert key in self._raw
         if not isinstance(self._raw[key], type_):
             raise TypeError(
@@ -40,7 +39,7 @@  def _check_value(self, key: str, type_: type, typestr: str) -> None:
 
     def _check_member(self, key: str, type_: type, typestr: str) -> None:
         self._check_key(key)
-        self._check_value(key, type_, typestr)
+        self._check_type(key, type_, typestr)
 
     @property
     def _name(self) -> str:
@@ -50,7 +49,37 @@  def __repr__(self) -> str:
         return f"{self._name}({self._raw!r})"
 
 
-class Greeting(Model):
+class MessageModel(Message, Model):
+    """
+    Abstract data model, representing a QMP Message of some sort.
+
+    Adapter class that glues together `Model` and `Message`.
+    """
+    def __init__(self, raw: Mapping[str, object]):
+        super().__init__(raw)
+
+    @property
+    def _raw(self) -> Mapping[str, Any]:
+        return self._object
+
+    def __setitem__(self, key: str, value: object) -> None:
+        # This is not good OO, but this turns off mutability here.
+        raise RuntimeError("Cannot mutate MessageModel")
+
+
+class StandaloneModel(Model):
+    """
+    Abstract data model, representing a (non-Message) QMP object of some sort.
+    """
+    def __init__(self, raw: Mapping[str, object]):
+        self._raw_mapping = raw
+
+    @property
+    def _raw(self) -> Mapping[str, Any]:
+        return self._raw_mapping
+
+
+class Greeting(MessageModel):
     """
     Defined in qmp-spec.txt, section 2.2, "Server Greeting".
 
@@ -58,8 +87,9 @@  class Greeting(Model):
     :raise KeyError: If any required fields are absent.
     :raise TypeError: If any required fields have the wrong type.
     """
-    def __init__(self, raw: Mapping[str, Any]):
+    def __init__(self, raw: Mapping[str, object]):
         super().__init__(raw)
+
         #: 'QMP' member
         self.QMP: QMPGreeting  # pylint: disable=invalid-name
 
@@ -67,7 +97,7 @@  def __init__(self, raw: Mapping[str, Any]):
         self.QMP = QMPGreeting(self._raw['QMP'])
 
 
-class QMPGreeting(Model):
+class QMPGreeting(StandaloneModel):
     """
     Defined in qmp-spec.txt, section 2.2, "Server Greeting".
 
@@ -75,8 +105,9 @@  class QMPGreeting(Model):
     :raise KeyError: If any required fields are absent.
     :raise TypeError: If any required fields have the wrong type.
     """
-    def __init__(self, raw: Mapping[str, Any]):
+    def __init__(self, raw: Mapping[str, object]):
         super().__init__(raw)
+
         #: 'version' member
         self.version: Mapping[str, object]
         #: 'capabilities' member
@@ -89,7 +120,7 @@  def __init__(self, raw: Mapping[str, Any]):
         self.capabilities = self._raw['capabilities']
 
 
-class ErrorResponse(Model):
+class ErrorResponse(MessageModel):
     """
     Defined in qmp-spec.txt, section 2.4.2, "error".
 
@@ -97,8 +128,9 @@  class ErrorResponse(Model):
     :raise KeyError: If any required fields are absent.
     :raise TypeError: If any required fields have the wrong type.
     """
-    def __init__(self, raw: Mapping[str, Any]):
+    def __init__(self, raw: Mapping[str, object]):
         super().__init__(raw)
+
         #: 'error' member
         self.error: ErrorInfo
         #: 'id' member
@@ -111,7 +143,7 @@  def __init__(self, raw: Mapping[str, Any]):
             self.id = raw['id']
 
 
-class ErrorInfo(Model):
+class ErrorInfo(StandaloneModel):
     """
     Defined in qmp-spec.txt, section 2.4.2, "error".
 
@@ -119,8 +151,9 @@  class ErrorInfo(Model):
     :raise KeyError: If any required fields are absent.
     :raise TypeError: If any required fields have the wrong type.
     """
-    def __init__(self, raw: Mapping[str, Any]):
+    def __init__(self, raw: Mapping[str, object]):
         super().__init__(raw)
+
         #: 'class' member, with an underscore to avoid conflicts in Python.
         self.class_: str
         #: 'desc' member