From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: Eduardo Habkost <ehabkost@redhat.com>,
Eric Blake <eblake@redhat.com>,
Stefan Hajnoczi <stefanha@redhat.com>,
Markus Armbruster <armbru@redhat.com>,
Wainer dos Santos Moschetta <wainersm@redhat.com>,
"Niteesh G . S ." <niteesh.gs@gmail.com>,
Willian Rampazzo <wrampazz@redhat.com>,
Cleber Rosa <crosa@redhat.com>, John Snow <jsnow@redhat.com>
Subject: [PATCH v2 23/24] python/aqmp: add scary message
Date: Fri, 16 Jul 2021 20:32:52 -0400 [thread overview]
Message-ID: <20210717003253.457418-24-jsnow@redhat.com> (raw)
In-Reply-To: <20210717003253.457418-1-jsnow@redhat.com>
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 ef2903fa7fc..321ea5c5c4b 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
from .events import EventListener
from .message import Message
@@ -28,6 +30,18 @@
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
--
2.31.1
next prev parent reply other threads:[~2021-07-17 0:50 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-17 0:32 [PATCH v2 00/24] python: introduce Asynchronous QMP package John Snow
2021-07-17 0:32 ` [PATCH v2 01/24] python/aqmp: add asynchronous QMP (AQMP) subpackage John Snow
2021-07-17 0:32 ` [PATCH v2 02/24] python/aqmp: add error classes John Snow
2021-08-03 16:01 ` Eric Blake
2021-08-03 17:34 ` John Snow
2021-08-03 17:40 ` Eric Blake
2021-08-03 18:01 ` John Snow
2021-07-17 0:32 ` [PATCH v2 03/24] python/pylint: Add exception for TypeVar names ('T') John Snow
2021-07-17 0:32 ` [PATCH v2 04/24] python/aqmp: add asyncio compatibility wrappers John Snow
2021-07-17 0:32 ` [PATCH v2 05/24] python/aqmp: add generic async message-based protocol support John Snow
2021-07-17 0:32 ` [PATCH v2 06/24] python/aqmp: add runstate state machine to AsyncProtocol John Snow
2021-07-17 0:32 ` [PATCH v2 07/24] python/aqmp: Add logging utility helpers John Snow
2021-07-17 0:32 ` [PATCH v2 08/24] python/aqmp: add logging to AsyncProtocol John Snow
2021-07-17 0:32 ` [PATCH v2 09/24] python/aqmp: add AsyncProtocol.accept() method John Snow
2021-07-17 0:32 ` [PATCH v2 10/24] python/aqmp: add configurable read buffer limit John Snow
2021-07-17 0:32 ` [PATCH v2 11/24] python/aqmp: add _cb_inbound and _cb_inbound logging hooks John Snow
2021-07-20 18:51 ` Niteesh G. S.
2021-07-20 19:13 ` John Snow
2021-07-17 0:32 ` [PATCH v2 12/24] python/aqmp: add AsyncProtocol._readline() method John Snow
2021-07-17 0:32 ` [PATCH v2 13/24] python/aqmp: add QMP Message format John Snow
2021-07-17 0:32 ` [PATCH v2 14/24] python/aqmp: add well-known QMP object models John Snow
2021-07-17 0:32 ` [PATCH v2 15/24] python/aqmp: add QMP event support John Snow
2021-07-17 0:32 ` [PATCH v2 16/24] python/pylint: disable too-many-function-args John Snow
2021-07-17 0:32 ` [PATCH v2 17/24] python/aqmp: add QMP protocol support John Snow
2021-07-17 0:32 ` [PATCH v2 18/24] python/pylint: disable no-member check John Snow
2021-07-17 0:32 ` [PATCH v2 19/24] python/aqmp: Add message routing to QMP protocol John Snow
2021-07-17 0:32 ` [PATCH v2 20/24] python/aqmp: add execute() interfaces John Snow
2021-07-17 0:32 ` [PATCH v2 21/24] python/aqmp: add _raw() execution interface John Snow
2021-07-17 0:32 ` [PATCH v2 22/24] python/aqmp: add asyncio_run compatibility wrapper John Snow
2021-07-17 0:32 ` John Snow [this message]
2021-07-17 0:32 ` [PATCH v2 24/24] python/aqmp: add AsyncProtocol unit tests John Snow
2021-07-20 20:34 ` Beraldo Leal
2021-08-02 17:24 ` John Snow
2021-07-21 17:03 ` [PATCH v2 00/24] python: introduce Asynchronous QMP package Niteesh G. S.
[not found] ` <CAFn=p-YciuuRySs1F82ZyP_QGed=fbRZmzH3v7VNtdV-xM-XaA@mail.gmail.com>
[not found] ` <CAN6ztm-LKWMZTURfE_q0bWpoXVKGMoqmm2jj4_CTb_kj-kEjYg@mail.gmail.com>
2021-07-21 19:55 ` John Snow
2021-07-21 20:02 ` Niteesh G. S.
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210717003253.457418-24-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=eblake@redhat.com \
--cc=ehabkost@redhat.com \
--cc=niteesh.gs@gmail.com \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.com \
--cc=wainersm@redhat.com \
--cc=wrampazz@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).