python/qmp: clear events on get_events() call

All callers in the tree *already* clear the events after a call to
get_events(). Do it automatically instead and update callsites to remove
the manual clear call.

These semantics are quite a bit easier to emulate with async QMP, and
nobody appears to be abusing some emergent properties of what happens if
you decide not to clear them, so let's dial down to the dumber, simpler
thing.

Specifically: callers of clear() right after a call to get_events() are
more likely expressing their desire to not see any events they just
retrieved, whereas callers of clear_events() not in relation to a recent
call to pull_event/get_events are likely expressing their desire to
simply drop *all* pending events straight onto the floor. In the sync
world, this is safe enough; in the async world it's nearly impossible to
promise that nothing happens between getting and clearing the
events.

Making the retrieval also clear the queue is vastly simpler.

Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Hanna Reitz <hreitz@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Message-id: 20210923004938.3999963-9-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
This commit is contained in:
John Snow 2021-09-22 20:49:29 -04:00
parent 3a3d84f5ec
commit d911accf0a
3 changed files with 4 additions and 4 deletions

View File

@ -631,7 +631,6 @@ def get_qmp_events(self, wait: bool = False) -> List[QMPMessage]:
events = self._qmp.get_events(wait=wait) events = self._qmp.get_events(wait=wait)
events.extend(self._events) events.extend(self._events)
del self._events[:] del self._events[:]
self._qmp.clear_events()
return events return events
@staticmethod @staticmethod

View File

@ -361,7 +361,7 @@ def pull_event(self,
def get_events(self, wait: bool = False) -> List[QMPMessage]: def get_events(self, wait: bool = False) -> List[QMPMessage]:
""" """
Get a list of available QMP events. Get a list of available QMP events and clear all pending events.
@param wait (bool): block until an event is available. @param wait (bool): block until an event is available.
@param wait (float): If wait is a float, treat it as a timeout value. @param wait (float): If wait is a float, treat it as a timeout value.
@ -374,7 +374,9 @@ def get_events(self, wait: bool = False) -> List[QMPMessage]:
@return The list of available QMP events. @return The list of available QMP events.
""" """
self.__get_events(wait) self.__get_events(wait)
return self.__events events = self.__events
self.__events = []
return events
def clear_events(self) -> None: def clear_events(self) -> None:
""" """

View File

@ -381,7 +381,6 @@ def read_exec_command(self) -> bool:
if cmdline == '': if cmdline == '':
for event in self.get_events(): for event in self.get_events():
print(event) print(event)
self.clear_events()
return True return True
return self._execute_cmd(cmdline) return self._execute_cmd(cmdline)