[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 07/11] python/qmp: Correct type of QMPReturnValue
From: |
John Snow |
Subject: |
[PATCH 07/11] python/qmp: Correct type of QMPReturnValue |
Date: |
Fri, 4 Jun 2021 11:55:28 -0400 |
It's only a Dict[str, Any] most of the time. It's not actually
guaranteed to be anything in particular. Fix this type to be
more accurate to the reality we live in.
Signed-off-by: John Snow <jsnow@redhat.com>
---
A note for Vladimir: I'm not using 'object' here yet because it causes a
few regressions in iotests.py type checking that I'm not ready to fix
just yet, but it will eventually happen.
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/qmp/__init__.py | 25 +++++++++++++++----------
1 file changed, 15 insertions(+), 10 deletions(-)
diff --git a/python/qemu/qmp/__init__.py b/python/qemu/qmp/__init__.py
index 822c793c32..a6e1a7b857 100644
--- a/python/qemu/qmp/__init__.py
+++ b/python/qemu/qmp/__init__.py
@@ -35,14 +35,19 @@
)
-# QMPMessage is a QMP Message of any kind.
-# e.g. {'yee': 'haw'}
-#
-# QMPReturnValue is the inner value of return values only.
-# {'return': {}} is the QMPMessage,
-# {} is the QMPReturnValue.
+#: QMPMessage is an entire QMP message of any kind.
QMPMessage = Dict[str, Any]
-QMPReturnValue = Dict[str, Any]
+
+#: QMPReturnValue is the 'return' value of a command.
+QMPReturnValue = object
+
+# QMPMessage can be outgoing commands or incoming events/returns.
+# QMPReturnValue is usually a dict/json object, but due to QAPI's
+# 'returns-whitelist', it can actually be anything.
+#
+# {'return': {}} is a QMPMessage,
+# {} is the QMPReturnValue.
+
InternetAddrT = Tuple[str, int]
UnixAddrT = str
@@ -297,8 +302,8 @@ def cmd_obj(self, qmp_cmd: QMPMessage) -> QMPMessage:
return resp
def cmd(self, name: str,
- args: Optional[Dict[str, Any]] = None,
- cmd_id: Optional[Any] = None) -> QMPMessage:
+ args: Optional[Dict[str, object]] = None,
+ cmd_id: Optional[object] = None) -> QMPMessage:
"""
Build a QMP command and send it to the QMP Monitor.
@@ -313,7 +318,7 @@ def cmd(self, name: str,
qmp_cmd['id'] = cmd_id
return self.cmd_obj(qmp_cmd)
- def command(self, cmd: str, **kwds: Any) -> QMPReturnValue:
+ def command(self, cmd: str, **kwds: object) -> QMPReturnValue:
"""
Build and send a QMP command to the monitor, report errors if any
"""
--
2.31.1
- [PATCH 00/11] python: move /scripts/qmp/gemu-ga-client.py to qemu.qmp package, John Snow, 2021/06/04
- [PATCH 03/11] scripts/qemu-ga-client: Fix exception handling, John Snow, 2021/06/04
- [PATCH 01/11] scripts/qemu-ga-client: apply isort rules, John Snow, 2021/06/04
- [PATCH 05/11] scripts/qemu-ga-client: add module docstring, John Snow, 2021/06/04
- [PATCH 07/11] python/qmp: Correct type of QMPReturnValue,
John Snow <=
- [PATCH 06/11] scripts/qemu-ga-client: apply (most) pylint rules, John Snow, 2021/06/04
- [PATCH 11/11] scripts/qemu-ga-client: Add forwarder shim, John Snow, 2021/06/04
- [PATCH 02/11] scripts/qemu-ga-client: apply (most) flake8 rules, John Snow, 2021/06/04
- [PATCH 08/11] scripts/qemu-ga-client: add mypy type hints, John Snow, 2021/06/04
- [PATCH 04/11] scripts/qemu-ga-client: replace deprecated optparse with argparse, John Snow, 2021/06/04
- [PATCH 09/11] scripts/qemu-ga-client: move to python/qemu/qmp/qemu_ga_client.py, John Snow, 2021/06/04
- [PATCH 10/11] python/qemu-ga-client: add entry point, John Snow, 2021/06/04
- Re: [PATCH 00/11] python: move /scripts/qmp/gemu-ga-client.py to qemu.qmp package, John Snow, 2021/06/11