All of lore.kernel.org
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: Kevin Wolf <kwolf@redhat.com>,
	Peter Maydell <peter.maydell@linaro.org>,
	Eduardo Habkost <ehabkost@redhat.com>,
	qemu-block@nongnu.org, Max Reitz <mreitz@redhat.com>,
	Cleber Rosa <crosa@redhat.com>, John Snow <jsnow@redhat.com>
Subject: [PULL 06/21] python/machine.py: Handle None events in events_wait
Date: Tue, 20 Oct 2020 13:27:27 -0400	[thread overview]
Message-ID: <20201020172742.1483258-7-jsnow@redhat.com> (raw)
In-Reply-To: <20201020172742.1483258-1-jsnow@redhat.com>

If the timeout is 0, we can get None back. Handle this explicitly.

Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Message-id: 20201006235817.3280413-6-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
 python/qemu/machine.py | 27 ++++++++++++++++++++-------
 1 file changed, 20 insertions(+), 7 deletions(-)

diff --git a/python/qemu/machine.py b/python/qemu/machine.py
index 812ca7d349..aebfa09e9d 100644
--- a/python/qemu/machine.py
+++ b/python/qemu/machine.py
@@ -28,7 +28,7 @@
 from typing import List, Optional, Type
 
 from . import console_socket, qmp
-from .qmp import SocketAddrT
+from .qmp import QMPMessage, SocketAddrT
 
 
 LOG = logging.getLogger(__name__)
@@ -604,13 +604,20 @@ def event_wait(self, name, timeout=60.0, match=None):
 
     def events_wait(self, events, timeout=60.0):
         """
-        events_wait waits for and returns a named event
-        from QMP with a timeout.
+        events_wait waits for and returns a single named event from QMP.
+        In the case of multiple qualifying events, this function returns the
+        first one.
 
-        events: a sequence of (name, match_criteria) tuples.
-                The match criteria are optional and may be None.
-                See event_match for details.
-        timeout: QEMUMonitorProtocol.pull_event timeout parameter.
+        :param events: A sequence of (name, match_criteria) tuples.
+                       The match criteria are optional and may be None.
+                       See event_match for details.
+        :param timeout: Optional timeout, in seconds.
+                        See QEMUMonitorProtocol.pull_event.
+
+        :raise QMPTimeoutError: If timeout was non-zero and no matching events
+                                were found.
+        :return: A QMP event matching the filter criteria.
+                 If timeout was 0 and no event matched, None.
         """
         def _match(event):
             for name, match in events:
@@ -618,6 +625,8 @@ def _match(event):
                     return True
             return False
 
+        event: Optional[QMPMessage]
+
         # Search cached events
         for event in self._events:
             if _match(event):
@@ -627,6 +636,10 @@ def _match(event):
         # Poll for new events
         while True:
             event = self._qmp.pull_event(wait=timeout)
+            if event is None:
+                # NB: None is only returned when timeout is false-ish.
+                # Timeouts raise QMPTimeoutError instead!
+                break
             if _match(event):
                 return event
             self._events.append(event)
-- 
2.26.2



  parent reply	other threads:[~2020-10-20 17:48 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-20 17:27 [PULL 00/21] Python patches John Snow
2020-10-20 17:27 ` [PULL 01/21] MAINTAINERS: Add Python library stanza John Snow
2020-10-20 17:27 ` [PULL 02/21] python/qemu: use isort to lay out imports John Snow
2020-10-20 17:27 ` [PULL 03/21] python/machine.py: Fix monitor address typing John Snow
2020-10-20 17:27 ` [PULL 04/21] python/machine.py: reorder __init__ John Snow
2020-10-20 17:27 ` [PULL 05/21] python/machine.py: Don't modify state in _base_args() John Snow
2020-10-20 17:27 ` John Snow [this message]
2020-10-20 17:27 ` [PULL 07/21] python/machine.py: use qmp.command John Snow
2020-10-20 17:27 ` [PULL 08/21] python/machine.py: Add _qmp access shim John Snow
2020-10-20 17:27 ` [PULL 09/21] python/machine.py: fix _popen access John Snow
2020-10-20 17:27 ` [PULL 10/21] python/qemu: make 'args' style arguments immutable John Snow
2020-10-20 17:27 ` [PULL 11/21] iotests.py: Adjust HMP kwargs typing John Snow
2020-10-20 17:27 ` [PULL 12/21] python/qemu: Add mypy type annotations John Snow
2020-10-20 17:27 ` [PULL 13/21] python/qemu/console_socket.py: Correct type of recv() John Snow
2020-10-20 17:27 ` [PULL 14/21] python/qemu/console_socket.py: fix typing of settimeout John Snow
2020-10-20 17:27 ` [PULL 15/21] python/qemu/console_socket.py: Clarify type of drain_thread John Snow
2020-10-20 17:27 ` [PULL 16/21] python/qemu/console_socket.py: Add type hint annotations John Snow
2020-10-20 17:27 ` [PULL 17/21] python/qemu/console_socket.py: avoid encoding to/from string John Snow
2020-10-20 17:27 ` [PULL 18/21] python/qemu/qmp.py: Preserve error context on re-raise John Snow
2020-10-20 17:27 ` [PULL 19/21] python: add mypy config John Snow
2020-10-20 17:27 ` [PULL 20/21] python/qemu/qmp.py: re-raise OSError when encountered John Snow
2020-10-20 18:15   ` Nir Soffer
2020-10-20 19:06     ` John Snow
2020-10-20 17:27 ` [PULL 21/21] python/qemu/qmp.py: Fix settimeout operation 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=20201020172742.1483258-7-jsnow@redhat.com \
    --to=jsnow@redhat.com \
    --cc=crosa@redhat.com \
    --cc=ehabkost@redhat.com \
    --cc=kwolf@redhat.com \
    --cc=mreitz@redhat.com \
    --cc=peter.maydell@linaro.org \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.