diff options
| author | John Snow <jsnow@redhat.com> | 2021-09-15 12:29:51 -0400 |
|---|---|---|
| committer | John Snow <jsnow@redhat.com> | 2021-09-27 12:10:29 -0400 |
| commit | ed6d4d7a95c2d508b7e6609f573042e3dabc52da (patch) | |
| tree | ce30b4c94592401a4c08983c32bbe57131555bdb | |
| parent | debbabd77f340758099212985dac75b3c1bedd47 (diff) | |
python/aqmp: add scary message
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>
Message-id: 20210915162955.333025-24-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
| -rw-r--r-- | python/qemu/aqmp/__init__.py | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/python/qemu/aqmp/__init__.py b/python/qemu/aqmp/__init__.py index 4b7df53e00..ab1782999c 100644 --- a/python/qemu/aqmp/__init__.py +++ b/python/qemu/aqmp/__init__.py @@ -21,6 +21,8 @@ managing QMP events. # 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 from .events import EventListener from .message import Message @@ -28,6 +30,18 @@ from .protocol import ConnectError, Runstate, StateError from .qmp_client import ExecInterruptedError, ExecuteError, QMPClient +_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 |