[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 01/23] python/aqmp: add __del__ method to legacy interface
From: |
John Snow |
Subject: |
[PATCH 01/23] python/aqmp: add __del__ method to legacy interface |
Date: |
Wed, 24 Nov 2021 14:25:55 -0500 |
asyncio can complain *very* loudly if you forget to back out of things
gracefully before the garbage collector starts destroying objects that
contain live references to asyncio Tasks.
The usual fix is just to remember to call aqmp.disconnect(), but for the
sake of the legacy wrapper and quick, one-off scripts where a graceful
shutdown is not necessarily of paramount imporance, add a courtesy
cleanup that will trigger prior to seeing screenfuls of confusing
asyncio tracebacks.
Note that we can't *always* save you from yourself; depending on when
the GC runs, you might just seriously be out of luck. The best we can do
in this case is to gently remind you to clean up after yourself.
(Still much better than multiple pages of incomprehensible python
warnings for the crime of forgetting to put your toys away.)
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/aqmp/legacy.py | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/python/qemu/aqmp/legacy.py b/python/qemu/aqmp/legacy.py
index 9e7b9fb80b..2ccb136b02 100644
--- a/python/qemu/aqmp/legacy.py
+++ b/python/qemu/aqmp/legacy.py
@@ -16,6 +16,8 @@
import qemu.qmp
from qemu.qmp import QMPMessage, QMPReturnValue, SocketAddrT
+from .error import AQMPError
+from .protocol import Runstate
from .qmp_client import QMPClient
@@ -136,3 +138,19 @@ def settimeout(self, timeout: Optional[float]) -> None:
def send_fd_scm(self, fd: int) -> None:
self._aqmp.send_fd_scm(fd)
+
+ def __del__(self) -> None:
+ if self._aqmp.runstate == Runstate.IDLE:
+ return
+
+ if not self._aloop.is_running():
+ self.close()
+ else:
+ # Garbage collection ran while the event loop was running.
+ # Nothing we can do about it now, but if we don't raise our
+ # own error, the user will be treated to a lot of traceback
+ # they might not understand.
+ raise AQMPError(
+ "QEMUMonitorProtocol.close()"
+ " was not called before object was garbage collected"
+ )
--
2.31.1
- [PATCH 00/23] Python: delete qemu.qmp package, John Snow, 2021/11/24
- [PATCH 04/23] python/aqmp: add SocketAddrT to package root, John Snow, 2021/11/24
- [PATCH 02/23] python/aqmp: handle asyncio.TimeoutError on execute(), John Snow, 2021/11/24
- [PATCH 08/23] python/qmp: switch qmp-shell to AQMP, John Snow, 2021/11/24
- [PATCH 06/23] python/qmp: switch qemu-ga-client to AQMP, John Snow, 2021/11/24
- [PATCH 01/23] python/aqmp: add __del__ method to legacy interface,
John Snow <=
- [PATCH 11/23] python/machine: permanently switch to AQMP, John Snow, 2021/11/24
- [PATCH 05/23] python/qemu-ga-client: update instructions to newer CLI syntax, John Snow, 2021/11/24
- [PATCH 03/23] python/aqmp: copy type definitions from qmp, John Snow, 2021/11/24
- [PATCH 09/23] python: move qmp utilities to python/qemu/utils, John Snow, 2021/11/24
- [PATCH 19/23] python/aqmp: take QMPBadPortError and parse_address from qemu.qmp, John Snow, 2021/11/24
- [PATCH 07/23] python/qmp: switch qom tools to AQMP, John Snow, 2021/11/24
- [PATCH 12/23] scripts/cpu-x86-uarch-abi: fix CLI parsing, John Snow, 2021/11/24
- [PATCH 15/23] scripts/bench-block-job: switch to AQMP, John Snow, 2021/11/24
- [PATCH 17/23] iotests: switch to AQMP, John Snow, 2021/11/24
- [PATCH 14/23] scripts/render-block-graph: switch to AQMP, John Snow, 2021/11/24