qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: Kevin Wolf <kwolf@redhat.com>,
	Eduardo Habkost <ehabkost@redhat.com>,
	qemu-block@nongnu.org, John Snow <jsnow@redhat.com>,
	Max Reitz <mreitz@redhat.com>, Cleber Rosa <crosa@redhat.com>,
	philmd@redhat.com
Subject: [PATCH v3 05/16] python/qmp.py: add casts to JSON deserialization
Date: Thu,  4 Jun 2020 16:22:25 -0400	[thread overview]
Message-ID: <20200604202236.25039-6-jsnow@redhat.com> (raw)
In-Reply-To: <20200604202236.25039-1-jsnow@redhat.com>

mypy and python type hints are not powerful enough to properly describe
JSON messages in Python 3.6. The best we can do, generally, is describe
them as Dict[str, Any].

Add casts to coerce this type for static analysis; but do NOT enforce
this type at runtime in any way.

Note: Python 3.8 adds a TypedDict construct which allows for the
description of more arbitrary Dictionary shapes. There is a third-party
module, "Pydantic", which is compatible with 3.6 that can be used
instead of the JSON library that parses JSON messages to fully-typed
Python objects, and may be preferable in some cases.

(That is well beyond the scope of this commit or series.)

Signed-off-by: John Snow <jsnow@redhat.com>
---
 python/qemu/qmp.py | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/python/qemu/qmp.py b/python/qemu/qmp.py
index ef3c919b76c..1ae36050a42 100644
--- a/python/qemu/qmp.py
+++ b/python/qemu/qmp.py
@@ -13,6 +13,7 @@
 import logging
 from typing import (
     Any,
+    cast,
     Dict,
     Optional,
     TextIO,
@@ -130,7 +131,10 @@ def __json_read(self, only_event=False):
             data = self.__sockfile.readline()
             if not data:
                 return None
-            resp = json.loads(data)
+            # By definition, any JSON received from QMP is a QMPMessage,
+            # and we are asserting only at static analysis time that it
+            # has a particular shape.
+            resp: QMPMessage = json.loads(data)
             if 'event' in resp:
                 self.logger.debug("<<< %s", resp)
                 self.__events.append(resp)
@@ -262,7 +266,7 @@ def command(self, cmd, **kwds):
         ret = self.cmd(cmd, kwds)
         if 'error' in ret:
             raise QMPResponseError(ret)
-        return ret['return']
+        return cast(QMPReturnValue, ret['return'])
 
     def pull_event(self, wait=False):
         """
-- 
2.21.3



  parent reply	other threads:[~2020-06-04 20:24 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-04 20:22 [PATCH v3 00/16] python: add mypy support to python/qemu John Snow
2020-06-04 20:22 ` [PATCH v3 01/16] python/qmp.py: Define common types John Snow
2020-06-04 20:22 ` [PATCH v3 02/16] iotests.py: use qemu.qmp type aliases John Snow
2020-06-04 20:22 ` [PATCH v3 03/16] python/qmp.py: re-absorb MonitorResponseError John Snow
2020-06-04 20:22 ` [PATCH v3 04/16] python/qmp.py: Do not return None from cmd_obj John Snow
2020-06-04 20:22 ` John Snow [this message]
2020-06-04 20:22 ` [PATCH v3 06/16] python/qmp.py: add QMPProtocolError John Snow
2020-06-04 20:22 ` [PATCH v3 07/16] python/machine.py: Fix monitor address typing John Snow
2020-06-04 20:22 ` [PATCH v3 08/16] python/machine.py: reorder __init__ John Snow
2020-06-04 20:22 ` [PATCH v3 09/16] python/machine.py: Don't modify state in _base_args() John Snow
2020-06-04 20:22 ` [PATCH v3 10/16] python/machine.py: Handle None events in events_wait John Snow
2020-06-04 20:22 ` [PATCH v3 11/16] python/machine.py: use qmp.command John Snow
2020-06-04 20:22 ` [PATCH v3 12/16] python/machine.py: Add _qmp access shim John Snow
2020-06-20  8:14   ` Philippe Mathieu-Daudé
2020-06-20  8:20     ` Philippe Mathieu-Daudé
2020-06-22 10:23       ` Kevin Wolf
2020-06-22 11:32         ` Philippe Mathieu-Daudé
2020-06-26 20:34           ` John Snow
2020-06-22 14:24         ` John Snow
2020-06-04 20:22 ` [PATCH v3 13/16] python/machine.py: fix _popen access John Snow
2020-06-04 20:22 ` [PATCH v3 14/16] python/qemu: make 'args' style arguments immutable John Snow
2020-06-04 20:22 ` [PATCH v3 15/16] iotests.py: Adjust HMP kwargs typing John Snow
2020-06-04 20:22 ` [PATCH v3 16/16] python/qemu: Add mypy type annotations John Snow
2020-06-05  9:26 ` [PATCH v3 00/16] python: add mypy support to python/qemu Kevin Wolf
2020-06-08 15:19   ` John Snow
2020-06-08 15:33     ` Kevin Wolf
2020-06-08 17:41       ` Philippe Mathieu-Daudé
2020-06-09  8:58         ` Markus Armbruster
2020-06-16 17:58           ` applying mailing list review tags (was: Re: [PATCH v3 00/16] python: add mypy support to python/qemu) John Snow
2020-06-17  3:33             ` Philippe Mathieu-Daudé
2020-06-17 15:25               ` [PATCH v3 00/16] python: add mypy support to python/qemu John Snow
2020-06-17 15:04             ` applying mailing list review tags (was: Re: [PATCH v3 00/16] python: add mypy support to python/qemu) Paolo Bonzini
2020-06-17 17:18 ` [PATCH v3 00/16] python: add mypy support to python/qemu Philippe Mathieu-Daudé
2020-06-17 17:18   ` John Snow

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200604202236.25039-6-jsnow@redhat.com \
    --to=jsnow@redhat.com \
    --cc=crosa@redhat.com \
    --cc=ehabkost@redhat.com \
    --cc=kwolf@redhat.com \
    --cc=mreitz@redhat.com \
    --cc=philmd@redhat.com \
    --cc=qemu-block@nongnu.org \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).