Skip to content

Commit

Permalink
python/qmp: Correct type of QMPReturnValue
Browse files Browse the repository at this point in the history
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>
Message-id: 20210604155532.1499282-8-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
  • Loading branch information
jnsnow committed Jun 18, 2021
1 parent f85d325 commit 1f63993
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions python/qemu/qmp/__init__.py
Expand Up @@ -35,14 +35,19 @@
)


# QMPMessage is a QMP Message of any kind.
# e.g. {'yee': 'haw'}
#: QMPMessage is an entire QMP message of any kind.
QMPMessage = 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.
#
# QMPReturnValue is the inner value of return values only.
# {'return': {}} is the QMPMessage,
# {'return': {}} is a QMPMessage,
# {} is the QMPReturnValue.
QMPMessage = Dict[str, Any]
QMPReturnValue = Dict[str, Any]


InternetAddrT = Tuple[str, int]
UnixAddrT = str
Expand Down Expand Up @@ -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.
Expand All @@ -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
"""
Expand Down

0 comments on commit 1f63993

Please sign in to comment.