[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 20/20] python/aqmp: add scary message
From: |
John Snow |
Subject: |
[PATCH 20/20] python/aqmp: add scary message |
Date: |
Thu, 1 Jul 2021 00:13:13 -0400 |
Add a warning whenever AQMP is used to steer people gently away from
using it for the time-being.
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/aqmp/__init__.py | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/python/qemu/aqmp/__init__.py b/python/qemu/aqmp/__init__.py
index 5cd7df87c6..f85500e0a2 100644
--- a/python/qemu/aqmp/__init__.py
+++ b/python/qemu/aqmp/__init__.py
@@ -21,6 +21,8 @@
# This work is licensed under the terms of the GNU GPL, version 2. See
# the COPYING file in the top-level directory.
+import warnings
+
from .error import AQMPError, MultiException
from .events import EventListener
from .message import Message
@@ -28,6 +30,18 @@
from .qmp_protocol import QMP, ExecInterruptedError, ExecuteError
+_WMSG = """
+
+The Asynchronous QMP library is currently in development and its API
+should be considered highly fluid and subject to change. It should
+not be used by any other scripts checked into the QEMU tree.
+
+Proceed with caution!
+"""
+
+warnings.warn(_WMSG, FutureWarning)
+
+
# The order of these fields impact the Sphinx documentation order.
__all__ = (
# Classes, most to least important
--
2.31.1
- [PATCH 13/20] python/aqmp: add well-known QMP object models, (continued)
- [PATCH 13/20] python/aqmp: add well-known QMP object models, John Snow, 2021/07/01
- [PATCH 12/20] python/aqmp: add QMP Message format, John Snow, 2021/07/01
- [PATCH 16/20] python/aqmp: Add message routing to QMP protocol, John Snow, 2021/07/01
- [PATCH 17/20] python/aqmp: add execute() interfaces, John Snow, 2021/07/01
- [PATCH 15/20] python/aqmp: add QMP protocol support, John Snow, 2021/07/01
- [PATCH 14/20] python/aqmp: add QMP event support, John Snow, 2021/07/01
- [PATCH 18/20] python/aqmp: add _raw() execution interface, John Snow, 2021/07/01
- [PATCH 19/20] python/aqmp: add asyncio_run compatibility wrapper, John Snow, 2021/07/01
- [PATCH 20/20] python/aqmp: add scary message,
John Snow <=
- Re: [PATCH 00/20] python: introduce Asynchronous QMP package, Stefan Hajnoczi, 2021/07/05