Add a warning whenever AQMP is used to steer people gently away from using it for the time-being.
Signed-off-by: John Snow <js...@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