* [PATCH v2 0/9] Python: Remove synchronous QMP library
@ 2022-03-30 17:28 John Snow
2022-03-30 17:28 ` [PATCH v2 1/9] python: temporarily silence pylint duplicate-code warnings John Snow
` (9 more replies)
0 siblings, 10 replies; 14+ messages in thread
From: John Snow @ 2022-03-30 17:28 UTC (permalink / raw)
To: qemu-devel
Cc: Kevin Wolf, Vladimir Sementsov-Ogievskiy, Beraldo Leal,
qemu-block, Markus Armbruster, Hanna Reitz, Cleber Rosa,
John Snow
Based-on: https://gitlab.com/jsnow/qemu/-/tree/python/
GitLab: https://gitlab.com/jsnow/qemu/-/tree/python-qmp-legacy-switch-pt1c
CI: https://gitlab.com/jsnow/qemu/-/pipelines/505169095
Hi, this series is part of an effort to publish the qemu.qmp package on
PyPI. It is the first of three series to complete this work:
--> (1) Switch the new async QMP library in as python/qemu/qmp
(2) Fork python/qemu/qmp out into its own repository,
with updated GitLab CI/CD targets to build packages.
(3) Update qemu.git to install qemu.qmp from PyPI,
and then delete python/qemu/qmp.
This series finalizes swapping out the old QMP library for the new
one. This leaves us with just one QMP library to worry about. It also
implements the rename of "qemu.aqmp" to "qemu.qmp".
This is the last patch series before I perform the actual fork.
These patches are (mostly) reviewed, so I'll likely stage these fairly
quickly barring any objections. The plan is to submit them as soon as
the tree re-opens to help prevent rot while I work on the fork.
John Snow (9):
python: temporarily silence pylint duplicate-code warnings
python/aqmp: take QMPBadPortError and parse_address from qemu.qmp
python/aqmp: fully separate from qmp.QEMUMonitorProtocol
python/aqmp: copy qmp docstrings to qemu.aqmp.legacy
python: remove the old QMP package
python: re-enable pylint duplicate-code warnings
python: rename qemu.aqmp to qemu.qmp
python: rename 'aqmp-tui' to 'qmp-tui'
python/qmp: remove pylint workaround from legacy.py
python/README.rst | 2 +-
python/qemu/qmp/README.rst | 9 -
python/qemu/aqmp/__init__.py | 59 ---
python/qemu/aqmp/legacy.py | 188 --------
python/qemu/aqmp/py.typed | 0
python/qemu/machine/machine.py | 4 +-
python/qemu/machine/qtest.py | 2 +-
python/qemu/qmp/__init__.py | 445 ++----------------
python/qemu/{aqmp => qmp}/error.py | 0
python/qemu/{aqmp => qmp}/events.py | 2 +-
python/qemu/qmp/legacy.py | 315 +++++++++++++
python/qemu/{aqmp => qmp}/message.py | 0
python/qemu/{aqmp => qmp}/models.py | 0
python/qemu/{aqmp => qmp}/protocol.py | 4 +-
python/qemu/{aqmp => qmp}/qmp_client.py | 16 +-
python/qemu/{aqmp => qmp}/qmp_shell.py | 4 +-
.../qemu/{aqmp/aqmp_tui.py => qmp/qmp_tui.py} | 15 +-
python/qemu/{aqmp => qmp}/util.py | 0
python/qemu/utils/qemu_ga_client.py | 4 +-
python/qemu/utils/qom.py | 2 +-
python/qemu/utils/qom_common.py | 4 +-
python/qemu/utils/qom_fuse.py | 2 +-
python/setup.cfg | 11 +-
python/tests/protocol.py | 14 +-
scripts/cpu-x86-uarch-abi.py | 2 +-
scripts/device-crash-test | 4 +-
scripts/qmp/qmp-shell | 2 +-
scripts/qmp/qmp-shell-wrap | 2 +-
scripts/render_block_graph.py | 4 +-
scripts/simplebench/bench_block_job.py | 2 +-
tests/qemu-iotests/iotests.py | 2 +-
tests/qemu-iotests/tests/mirror-top-perms | 4 +-
32 files changed, 409 insertions(+), 715 deletions(-)
delete mode 100644 python/qemu/qmp/README.rst
delete mode 100644 python/qemu/aqmp/__init__.py
delete mode 100644 python/qemu/aqmp/legacy.py
delete mode 100644 python/qemu/aqmp/py.typed
rename python/qemu/{aqmp => qmp}/error.py (100%)
rename python/qemu/{aqmp => qmp}/events.py (99%)
create mode 100644 python/qemu/qmp/legacy.py
rename python/qemu/{aqmp => qmp}/message.py (100%)
rename python/qemu/{aqmp => qmp}/models.py (100%)
rename python/qemu/{aqmp => qmp}/protocol.py (99%)
rename python/qemu/{aqmp => qmp}/qmp_client.py (97%)
rename python/qemu/{aqmp => qmp}/qmp_shell.py (99%)
rename python/qemu/{aqmp/aqmp_tui.py => qmp/qmp_tui.py} (98%)
rename python/qemu/{aqmp => qmp}/util.py (100%)
--
2.34.1
^ permalink raw reply [flat|nested] 14+ messages in thread
* [PATCH v2 1/9] python: temporarily silence pylint duplicate-code warnings
2022-03-30 17:28 [PATCH v2 0/9] Python: Remove synchronous QMP library John Snow
@ 2022-03-30 17:28 ` John Snow
2022-03-30 17:28 ` [PATCH v2 2/9] python/aqmp: take QMPBadPortError and parse_address from qemu.qmp John Snow
` (8 subsequent siblings)
9 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2022-03-30 17:28 UTC (permalink / raw)
To: qemu-devel
Cc: Kevin Wolf, Vladimir Sementsov-Ogievskiy, Beraldo Leal,
qemu-block, Markus Armbruster, Hanna Reitz,
Vladimir Sementsov-Ogievskiy, Cleber Rosa, John Snow
The next several commits copy some code from qemu.qmp to qemu.aqmp, then
delete qemu.qmp. In the interim, to prevent test failures, the duplicate
code detection needs to be silenced to prevent bisect problems with CI
testing.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
---
python/setup.cfg | 1 +
1 file changed, 1 insertion(+)
diff --git a/python/setup.cfg b/python/setup.cfg
index 241f243e8b9..cdeced44d2b 100644
--- a/python/setup.cfg
+++ b/python/setup.cfg
@@ -119,6 +119,7 @@ disable=consider-using-f-string,
too-many-function-args, # mypy handles this with less false positives.
too-many-instance-attributes,
no-member, # mypy also handles this better.
+ duplicate-code, # To be removed by the end of this patch series.
[pylint.basic]
# Good variable names which should always be accepted, separated by a comma.
--
2.34.1
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v2 2/9] python/aqmp: take QMPBadPortError and parse_address from qemu.qmp
2022-03-30 17:28 [PATCH v2 0/9] Python: Remove synchronous QMP library John Snow
2022-03-30 17:28 ` [PATCH v2 1/9] python: temporarily silence pylint duplicate-code warnings John Snow
@ 2022-03-30 17:28 ` John Snow
2022-03-30 17:28 ` [PATCH v2 3/9] python/aqmp: fully separate from qmp.QEMUMonitorProtocol John Snow
` (7 subsequent siblings)
9 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2022-03-30 17:28 UTC (permalink / raw)
To: qemu-devel
Cc: Kevin Wolf, Vladimir Sementsov-Ogievskiy, Beraldo Leal,
qemu-block, Markus Armbruster, Hanna Reitz,
Vladimir Sementsov-Ogievskiy, Cleber Rosa, John Snow
Shift these definitions over from the qmp package to the async qmp
package.
(Licensing: this is a lateral move, from GPLv2 (only) to GPLv2 (only))
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Reviewed-by: Beraldo Leal <bleal@redhat.com>
---
python/qemu/aqmp/aqmp_tui.py | 3 +--
python/qemu/aqmp/legacy.py | 30 ++++++++++++++++++++++++++----
python/qemu/qmp/__init__.py | 26 --------------------------
3 files changed, 27 insertions(+), 32 deletions(-)
diff --git a/python/qemu/aqmp/aqmp_tui.py b/python/qemu/aqmp/aqmp_tui.py
index 946ba9af24e..59d3036be38 100644
--- a/python/qemu/aqmp/aqmp_tui.py
+++ b/python/qemu/aqmp/aqmp_tui.py
@@ -35,9 +35,8 @@
import urwid
import urwid_readline
-from qemu.qmp import QEMUMonitorProtocol, QMPBadPortError
-
from .error import ProtocolError
+from .legacy import QEMUMonitorProtocol, QMPBadPortError
from .message import DeserializationError, Message, UnexpectedTypeError
from .protocol import ConnectError, Runstate
from .qmp_client import ExecInterruptedError, QMPClient
diff --git a/python/qemu/aqmp/legacy.py b/python/qemu/aqmp/legacy.py
index f86cb298049..f0262749491 100644
--- a/python/qemu/aqmp/legacy.py
+++ b/python/qemu/aqmp/legacy.py
@@ -33,9 +33,6 @@
from .qmp_client import QMPClient
-# (Temporarily) Re-export QMPBadPortError
-QMPBadPortError = qemu.qmp.QMPBadPortError
-
#: QMPMessage is an entire QMP message of any kind.
QMPMessage = Dict[str, Any]
@@ -56,6 +53,12 @@
# pylint: disable=missing-docstring
+class QMPBadPortError(QMPError):
+ """
+ Unable to parse socket address: Port was non-numerical.
+ """
+
+
class QEMUMonitorProtocol(qemu.qmp.QEMUMonitorProtocol):
def __init__(self, address: SocketAddrT,
server: bool = False,
@@ -86,7 +89,26 @@ def _get_greeting(self) -> Optional[QMPMessage]:
return None
# __enter__ and __exit__ need no changes
- # parse_address needs no changes
+
+ @classmethod
+ def parse_address(cls, address: str) -> SocketAddrT:
+ """
+ Parse a string into a QMP address.
+
+ Figure out if the argument is in the port:host form.
+ If it's not, it's probably a file path.
+ """
+ components = address.split(':')
+ if len(components) == 2:
+ try:
+ port = int(components[1])
+ except ValueError:
+ msg = f"Bad port: '{components[1]}' in '{address}'."
+ raise QMPBadPortError(msg) from None
+ return (components[0], port)
+
+ # Treat as filepath.
+ return address
def connect(self, negotiate: bool = True) -> Optional[QMPMessage]:
self._aqmp.await_greeting = negotiate
diff --git a/python/qemu/qmp/__init__.py b/python/qemu/qmp/__init__.py
index 358c0971d06..4e086411544 100644
--- a/python/qemu/qmp/__init__.py
+++ b/python/qemu/qmp/__init__.py
@@ -102,12 +102,6 @@ def __init__(self, reply: QMPMessage):
self.reply = reply
-class QMPBadPortError(QMPError):
- """
- Unable to parse socket address: Port was non-numerical.
- """
-
-
class QEMUMonitorProtocol:
"""
Provide an API to connect to QEMU via QEMU Monitor Protocol (QMP) and then
@@ -237,26 +231,6 @@ def __exit__(self,
# Implement context manager exit function.
self.close()
- @classmethod
- def parse_address(cls, address: str) -> SocketAddrT:
- """
- Parse a string into a QMP address.
-
- Figure out if the argument is in the port:host form.
- If it's not, it's probably a file path.
- """
- components = address.split(':')
- if len(components) == 2:
- try:
- port = int(components[1])
- except ValueError:
- msg = f"Bad port: '{components[1]}' in '{address}'."
- raise QMPBadPortError(msg) from None
- return (components[0], port)
-
- # Treat as filepath.
- return address
-
def connect(self, negotiate: bool = True) -> Optional[QMPMessage]:
"""
Connect to the QMP Monitor and perform capabilities negotiation.
--
2.34.1
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v2 3/9] python/aqmp: fully separate from qmp.QEMUMonitorProtocol
2022-03-30 17:28 [PATCH v2 0/9] Python: Remove synchronous QMP library John Snow
2022-03-30 17:28 ` [PATCH v2 1/9] python: temporarily silence pylint duplicate-code warnings John Snow
2022-03-30 17:28 ` [PATCH v2 2/9] python/aqmp: take QMPBadPortError and parse_address from qemu.qmp John Snow
@ 2022-03-30 17:28 ` John Snow
2022-03-30 17:28 ` [PATCH v2 4/9] python/aqmp: copy qmp docstrings to qemu.aqmp.legacy John Snow
` (6 subsequent siblings)
9 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2022-03-30 17:28 UTC (permalink / raw)
To: qemu-devel
Cc: Kevin Wolf, Vladimir Sementsov-Ogievskiy, Beraldo Leal,
qemu-block, Markus Armbruster, Hanna Reitz,
Vladimir Sementsov-Ogievskiy, Cleber Rosa, John Snow
After this patch, qemu.aqmp.legacy.QEMUMonitorProtocol no longer
inherits from qemu.qmp.QEMUMonitorProtocol. To do this, several
inherited methods need to be explicitly re-defined.
(Licensing: This is copying and modifying GPLv2-only code into a
GPLv2-only file.)
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Reviewed-by: Beraldo Leal <bleal@redhat.com>
---
python/qemu/aqmp/legacy.py | 37 +++++++++++++++++++++++++++++++------
1 file changed, 31 insertions(+), 6 deletions(-)
diff --git a/python/qemu/aqmp/legacy.py b/python/qemu/aqmp/legacy.py
index f0262749491..10c7c99c4f0 100644
--- a/python/qemu/aqmp/legacy.py
+++ b/python/qemu/aqmp/legacy.py
@@ -16,18 +16,18 @@
#
import asyncio
+from types import TracebackType
from typing import (
Any,
Awaitable,
Dict,
List,
Optional,
+ Type,
TypeVar,
Union,
)
-import qemu.qmp
-
from .error import QMPError
from .protocol import Runstate, SocketAddrT
from .qmp_client import QMPClient
@@ -59,12 +59,11 @@ class QMPBadPortError(QMPError):
"""
-class QEMUMonitorProtocol(qemu.qmp.QEMUMonitorProtocol):
+class QEMUMonitorProtocol:
def __init__(self, address: SocketAddrT,
server: bool = False,
nickname: Optional[str] = None):
- # pylint: disable=super-init-not-called
self._aqmp = QMPClient(nickname)
self._aloop = asyncio.get_event_loop()
self._address = address
@@ -88,7 +87,18 @@ def _get_greeting(self) -> Optional[QMPMessage]:
return self._aqmp.greeting._asdict()
return None
- # __enter__ and __exit__ need no changes
+ def __enter__(self: _T) -> _T:
+ # Implement context manager enter function.
+ return self
+
+ def __exit__(self,
+ # pylint: disable=duplicate-code
+ # see https://github.com/PyCQA/pylint/issues/3619
+ exc_type: Optional[Type[BaseException]],
+ exc_val: Optional[BaseException],
+ exc_tb: Optional[TracebackType]) -> None:
+ # Implement context manager exit function.
+ self.close()
@classmethod
def parse_address(cls, address: str) -> SocketAddrT:
@@ -142,7 +152,22 @@ def cmd_obj(self, qmp_cmd: QMPMessage) -> QMPMessage:
)
)
- # Default impl of cmd() delegates to cmd_obj
+ def cmd(self, name: str,
+ args: Optional[Dict[str, object]] = None,
+ cmd_id: Optional[object] = None) -> QMPMessage:
+ """
+ Build a QMP command and send it to the QMP Monitor.
+
+ @param name: command name (string)
+ @param args: command arguments (dict)
+ @param cmd_id: command id (dict, list, string or int)
+ """
+ qmp_cmd: QMPMessage = {'execute': name}
+ if args:
+ qmp_cmd['arguments'] = args
+ if cmd_id:
+ qmp_cmd['id'] = cmd_id
+ return self.cmd_obj(qmp_cmd)
def command(self, cmd: str, **kwds: object) -> QMPReturnValue:
return self._sync(
--
2.34.1
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v2 4/9] python/aqmp: copy qmp docstrings to qemu.aqmp.legacy
2022-03-30 17:28 [PATCH v2 0/9] Python: Remove synchronous QMP library John Snow
` (2 preceding siblings ...)
2022-03-30 17:28 ` [PATCH v2 3/9] python/aqmp: fully separate from qmp.QEMUMonitorProtocol John Snow
@ 2022-03-30 17:28 ` John Snow
2022-03-30 17:28 ` [PATCH v2 5/9] python: remove the old QMP package John Snow
` (5 subsequent siblings)
9 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2022-03-30 17:28 UTC (permalink / raw)
To: qemu-devel
Cc: Kevin Wolf, Vladimir Sementsov-Ogievskiy, Beraldo Leal,
qemu-block, Markus Armbruster, Hanna Reitz,
Vladimir Sementsov-Ogievskiy, Cleber Rosa, John Snow
Copy the docstrings out of qemu.qmp, adjusting them as necessary to
more accurately reflect the current state of this class.
(Licensing: This is copying and modifying GPLv2-only licensed docstrings
into a GPLv2-only file.)
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Reviewed-by: Beraldo Leal <bleal@redhat.com>
---
python/qemu/aqmp/legacy.py | 98 ++++++++++++++++++++++++++++++++++----
1 file changed, 90 insertions(+), 8 deletions(-)
diff --git a/python/qemu/aqmp/legacy.py b/python/qemu/aqmp/legacy.py
index 10c7c99c4f0..dfcd20bbd23 100644
--- a/python/qemu/aqmp/legacy.py
+++ b/python/qemu/aqmp/legacy.py
@@ -1,7 +1,13 @@
"""
-Sync QMP Wrapper
+(Legacy) Sync QMP Wrapper
-This class pretends to be qemu.qmp.QEMUMonitorProtocol.
+This module provides the `QEMUMonitorProtocol` class, which is a
+synchronous wrapper around `QMPClient`.
+
+Its design closely resembles that of the original QEMUMonitorProtocol
+class, originally written by Luiz Capitulino. It is provided here for
+compatibility with scripts inside the QEMU source tree that expect the
+old interface.
"""
#
@@ -50,9 +56,6 @@
# {} is the QMPReturnValue.
-# pylint: disable=missing-docstring
-
-
class QMPBadPortError(QMPError):
"""
Unable to parse socket address: Port was non-numerical.
@@ -60,6 +63,17 @@ class QMPBadPortError(QMPError):
class QEMUMonitorProtocol:
+ """
+ Provide an API to connect to QEMU via QEMU Monitor Protocol (QMP)
+ and then allow to handle commands and events.
+
+ :param address: QEMU address, can be either a unix socket path (string)
+ or a tuple in the form ( address, port ) for a TCP
+ connection
+ :param server: Act as the socket server. (See 'accept')
+ :param nickname: Optional nickname used for logging.
+ """
+
def __init__(self, address: SocketAddrT,
server: bool = False,
nickname: Optional[str] = None):
@@ -121,6 +135,12 @@ def parse_address(cls, address: str) -> SocketAddrT:
return address
def connect(self, negotiate: bool = True) -> Optional[QMPMessage]:
+ """
+ Connect to the QMP Monitor and perform capabilities negotiation.
+
+ :return: QMP greeting dict, or None if negotiate is false
+ :raise ConnectError: on connection errors
+ """
self._aqmp.await_greeting = negotiate
self._aqmp.negotiate = negotiate
@@ -130,6 +150,16 @@ def connect(self, negotiate: bool = True) -> Optional[QMPMessage]:
return self._get_greeting()
def accept(self, timeout: Optional[float] = 15.0) -> QMPMessage:
+ """
+ Await connection from QMP Monitor and perform capabilities negotiation.
+
+ :param timeout:
+ timeout in seconds (nonnegative float number, or None).
+ If None, there is no timeout, and this may block forever.
+
+ :return: QMP greeting dict
+ :raise ConnectError: on connection errors
+ """
self._aqmp.await_greeting = True
self._aqmp.negotiate = True
@@ -140,6 +170,12 @@ def accept(self, timeout: Optional[float] = 15.0) -> QMPMessage:
return ret
def cmd_obj(self, qmp_cmd: QMPMessage) -> QMPMessage:
+ """
+ Send a QMP command to the QMP Monitor.
+
+ :param qmp_cmd: QMP command to be sent as a Python dict
+ :return: QMP response as a Python dict
+ """
return dict(
self._sync(
# pylint: disable=protected-access
@@ -158,9 +194,9 @@ def cmd(self, name: str,
"""
Build a QMP command and send it to the QMP Monitor.
- @param name: command name (string)
- @param args: command arguments (dict)
- @param cmd_id: command id (dict, list, string or int)
+ :param name: command name (string)
+ :param args: command arguments (dict)
+ :param cmd_id: command id (dict, list, string or int)
"""
qmp_cmd: QMPMessage = {'execute': name}
if args:
@@ -170,6 +206,9 @@ def cmd(self, name: str,
return self.cmd_obj(qmp_cmd)
def command(self, cmd: str, **kwds: object) -> QMPReturnValue:
+ """
+ Build and send a QMP command to the monitor, report errors if any
+ """
return self._sync(
self._aqmp.execute(cmd, kwds),
self._timeout
@@ -177,6 +216,19 @@ def command(self, cmd: str, **kwds: object) -> QMPReturnValue:
def pull_event(self,
wait: Union[bool, float] = False) -> Optional[QMPMessage]:
+ """
+ Pulls a single event.
+
+ :param wait:
+ If False or 0, do not wait. Return None if no events ready.
+ If True, wait forever until the next event.
+ Otherwise, wait for the specified number of seconds.
+
+ :raise asyncio.TimeoutError:
+ When a timeout is requested and the timeout period elapses.
+
+ :return: The first available QMP event, or None.
+ """
if not wait:
# wait is False/0: "do not wait, do not except."
if self._aqmp.events.empty():
@@ -197,6 +249,20 @@ def pull_event(self,
)
def get_events(self, wait: Union[bool, float] = False) -> List[QMPMessage]:
+ """
+ Get a list of QMP events and clear all pending events.
+
+ :param wait:
+ If False or 0, do not wait. Return None if no events ready.
+ If True, wait until we have at least one event.
+ Otherwise, wait for up to the specified number of seconds for at
+ least one event.
+
+ :raise asyncio.TimeoutError:
+ When a timeout is requested and the timeout period elapses.
+
+ :return: A list of QMP events.
+ """
events = [dict(x) for x in self._aqmp.events.clear()]
if events:
return events
@@ -205,17 +271,33 @@ def get_events(self, wait: Union[bool, float] = False) -> List[QMPMessage]:
return [event] if event is not None else []
def clear_events(self) -> None:
+ """Clear current list of pending events."""
self._aqmp.events.clear()
def close(self) -> None:
+ """Close the connection."""
self._sync(
self._aqmp.disconnect()
)
def settimeout(self, timeout: Optional[float]) -> None:
+ """
+ Set the timeout for QMP RPC execution.
+
+ This timeout affects the `cmd`, `cmd_obj`, and `command` methods.
+ The `accept`, `pull_event` and `get_event` methods have their
+ own configurable timeouts.
+
+ :param timeout:
+ timeout in seconds, or None.
+ None will wait indefinitely.
+ """
self._timeout = timeout
def send_fd_scm(self, fd: int) -> None:
+ """
+ Send a file descriptor to the remote via SCM_RIGHTS.
+ """
self._aqmp.send_fd_scm(fd)
def __del__(self) -> None:
--
2.34.1
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v2 5/9] python: remove the old QMP package
2022-03-30 17:28 [PATCH v2 0/9] Python: Remove synchronous QMP library John Snow
` (3 preceding siblings ...)
2022-03-30 17:28 ` [PATCH v2 4/9] python/aqmp: copy qmp docstrings to qemu.aqmp.legacy John Snow
@ 2022-03-30 17:28 ` John Snow
2022-03-30 17:28 ` [PATCH v2 6/9] python: re-enable pylint duplicate-code warnings John Snow
` (4 subsequent siblings)
9 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2022-03-30 17:28 UTC (permalink / raw)
To: qemu-devel
Cc: Kevin Wolf, Vladimir Sementsov-Ogievskiy, Beraldo Leal,
qemu-block, Markus Armbruster, Hanna Reitz,
Vladimir Sementsov-Ogievskiy, Cleber Rosa, John Snow
Thank you for your service!
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Reviewed-by: Beraldo Leal <bleal@redhat.com>
---
python/PACKAGE.rst | 4 +-
python/README.rst | 2 +-
python/qemu/qmp/README.rst | 9 -
python/qemu/qmp/__init__.py | 396 ------------------------------------
python/qemu/qmp/py.typed | 0
python/setup.cfg | 3 +-
6 files changed, 4 insertions(+), 410 deletions(-)
delete mode 100644 python/qemu/qmp/README.rst
delete mode 100644 python/qemu/qmp/__init__.py
delete mode 100644 python/qemu/qmp/py.typed
diff --git a/python/PACKAGE.rst b/python/PACKAGE.rst
index b0b86cc4c31..ddfa9ba3f59 100644
--- a/python/PACKAGE.rst
+++ b/python/PACKAGE.rst
@@ -8,11 +8,11 @@ to change at any time.
Usage
-----
-The ``qemu.qmp`` subpackage provides a library for communicating with
+The ``qemu.aqmp`` subpackage provides a library for communicating with
QMP servers. The ``qemu.machine`` subpackage offers rudimentary
facilities for launching and managing QEMU processes. Refer to each
package's documentation
-(``>>> help(qemu.qmp)``, ``>>> help(qemu.machine)``)
+(``>>> help(qemu.aqmp)``, ``>>> help(qemu.machine)``)
for more information.
Contributing
diff --git a/python/README.rst b/python/README.rst
index fcf74f69eae..eb5213337d2 100644
--- a/python/README.rst
+++ b/python/README.rst
@@ -3,7 +3,7 @@ QEMU Python Tooling
This directory houses Python tooling used by the QEMU project to build,
configure, and test QEMU. It is organized by namespace (``qemu``), and
-then by package (e.g. ``qemu/machine``, ``qemu/qmp``, etc).
+then by package (e.g. ``qemu/machine``, ``qemu/aqmp``, etc).
``setup.py`` is used by ``pip`` to install this tooling to the current
environment. ``setup.cfg`` provides the packaging configuration used by
diff --git a/python/qemu/qmp/README.rst b/python/qemu/qmp/README.rst
deleted file mode 100644
index 5bfb82535f8..00000000000
--- a/python/qemu/qmp/README.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-qemu.qmp package
-================
-
-This package provides a library used for connecting to and communicating
-with QMP servers. It is used extensively by iotests, vm tests,
-avocado tests, and other utilities in the ./scripts directory. It is
-not a fully-fledged SDK and is subject to change at any time.
-
-See the documentation in ``__init__.py`` for more information.
diff --git a/python/qemu/qmp/__init__.py b/python/qemu/qmp/__init__.py
deleted file mode 100644
index 4e086411544..00000000000
--- a/python/qemu/qmp/__init__.py
+++ /dev/null
@@ -1,396 +0,0 @@
-"""
-QEMU Monitor Protocol (QMP) development library & tooling.
-
-This package provides a fairly low-level class for communicating to QMP
-protocol servers, as implemented by QEMU, the QEMU Guest Agent, and the
-QEMU Storage Daemon. This library is not intended for production use.
-
-`QEMUMonitorProtocol` is the primary class of interest, and all errors
-raised derive from `QMPError`.
-"""
-
-# Copyright (C) 2009, 2010 Red Hat Inc.
-#
-# Authors:
-# Luiz Capitulino <lcapitulino@redhat.com>
-#
-# This work is licensed under the terms of the GNU GPL, version 2. See
-# the COPYING file in the top-level directory.
-
-import errno
-import json
-import logging
-import socket
-import struct
-from types import TracebackType
-from typing import (
- Any,
- Dict,
- List,
- Optional,
- TextIO,
- Tuple,
- Type,
- TypeVar,
- Union,
- cast,
-)
-
-
-#: QMPMessage is an entire QMP message of any kind.
-QMPMessage = Dict[str, Any]
-
-#: QMPReturnValue is the 'return' value of a command.
-QMPReturnValue = object
-
-#: QMPObject is any object in a QMP message.
-QMPObject = Dict[str, object]
-
-# QMPMessage can be outgoing commands or incoming events/returns.
-# QMPReturnValue is usually a dict/json object, but due to QAPI's
-# 'returns-whitelist', it can actually be anything.
-#
-# {'return': {}} is a QMPMessage,
-# {} is the QMPReturnValue.
-
-
-InternetAddrT = Tuple[str, int]
-UnixAddrT = str
-SocketAddrT = Union[InternetAddrT, UnixAddrT]
-
-
-class QMPError(Exception):
- """
- QMP base exception
- """
-
-
-class QMPConnectError(QMPError):
- """
- QMP connection exception
- """
-
-
-class QMPCapabilitiesError(QMPError):
- """
- QMP negotiate capabilities exception
- """
-
-
-class QMPTimeoutError(QMPError):
- """
- QMP timeout exception
- """
-
-
-class QMPProtocolError(QMPError):
- """
- QMP protocol error; unexpected response
- """
-
-
-class QMPResponseError(QMPError):
- """
- Represents erroneous QMP monitor reply
- """
- def __init__(self, reply: QMPMessage):
- try:
- desc = reply['error']['desc']
- except KeyError:
- desc = reply
- super().__init__(desc)
- self.reply = reply
-
-
-class QEMUMonitorProtocol:
- """
- Provide an API to connect to QEMU via QEMU Monitor Protocol (QMP) and then
- allow to handle commands and events.
- """
-
- #: Logger object for debugging messages
- logger = logging.getLogger('QMP')
-
- def __init__(self, address: SocketAddrT,
- server: bool = False,
- nickname: Optional[str] = None):
- """
- Create a QEMUMonitorProtocol class.
-
- @param address: QEMU address, can be either a unix socket path (string)
- or a tuple in the form ( address, port ) for a TCP
- connection
- @param server: server mode listens on the socket (bool)
- @raise OSError on socket connection errors
- @note No connection is established, this is done by the connect() or
- accept() methods
- """
- self.__events: List[QMPMessage] = []
- self.__address = address
- self.__sock = self.__get_sock()
- self.__sockfile: Optional[TextIO] = None
- self._nickname = nickname
- if self._nickname:
- self.logger = logging.getLogger('QMP').getChild(self._nickname)
- if server:
- self.__sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
- self.__sock.bind(self.__address)
- self.__sock.listen(1)
-
- def __get_sock(self) -> socket.socket:
- if isinstance(self.__address, tuple):
- family = socket.AF_INET
- else:
- family = socket.AF_UNIX
- return socket.socket(family, socket.SOCK_STREAM)
-
- def __negotiate_capabilities(self) -> QMPMessage:
- greeting = self.__json_read()
- if greeting is None or "QMP" not in greeting:
- raise QMPConnectError
- # Greeting seems ok, negotiate capabilities
- resp = self.cmd('qmp_capabilities')
- if resp and "return" in resp:
- return greeting
- raise QMPCapabilitiesError
-
- def __json_read(self, only_event: bool = False) -> Optional[QMPMessage]:
- assert self.__sockfile is not None
- while True:
- data = self.__sockfile.readline()
- if not data:
- return None
- # By definition, any JSON received from QMP is a QMPMessage,
- # and we are asserting only at static analysis time that it
- # has a particular shape.
- resp: QMPMessage = json.loads(data)
- if 'event' in resp:
- self.logger.debug("<<< %s", resp)
- self.__events.append(resp)
- if not only_event:
- continue
- return resp
-
- def __get_events(self, wait: Union[bool, float] = False) -> None:
- """
- Check for new events in the stream and cache them in __events.
-
- @param wait (bool): block until an event is available.
- @param wait (float): If wait is a float, treat it as a timeout value.
-
- @raise QMPTimeoutError: If a timeout float is provided and the timeout
- period elapses.
- @raise QMPConnectError: If wait is True but no events could be
- retrieved or if some other error occurred.
- """
-
- # Current timeout and blocking status
- current_timeout = self.__sock.gettimeout()
-
- # Check for new events regardless and pull them into the cache:
- self.__sock.settimeout(0) # i.e. setblocking(False)
- try:
- self.__json_read()
- except OSError as err:
- # EAGAIN: No data available; not critical
- if err.errno != errno.EAGAIN:
- raise
- finally:
- self.__sock.settimeout(current_timeout)
-
- # Wait for new events, if needed.
- # if wait is 0.0, this means "no wait" and is also implicitly false.
- if not self.__events and wait:
- if isinstance(wait, float):
- self.__sock.settimeout(wait)
- try:
- ret = self.__json_read(only_event=True)
- except socket.timeout as err:
- raise QMPTimeoutError("Timeout waiting for event") from err
- except Exception as err:
- msg = "Error while reading from socket"
- raise QMPConnectError(msg) from err
- finally:
- self.__sock.settimeout(current_timeout)
-
- if ret is None:
- raise QMPConnectError("Error while reading from socket")
-
- T = TypeVar('T')
-
- def __enter__(self: T) -> T:
- # Implement context manager enter function.
- return self
-
- def __exit__(self,
- # pylint: disable=duplicate-code
- # see https://github.com/PyCQA/pylint/issues/3619
- exc_type: Optional[Type[BaseException]],
- exc_val: Optional[BaseException],
- exc_tb: Optional[TracebackType]) -> None:
- # Implement context manager exit function.
- self.close()
-
- def connect(self, negotiate: bool = True) -> Optional[QMPMessage]:
- """
- Connect to the QMP Monitor and perform capabilities negotiation.
-
- @return QMP greeting dict, or None if negotiate is false
- @raise OSError on socket connection errors
- @raise QMPConnectError if the greeting is not received
- @raise QMPCapabilitiesError if fails to negotiate capabilities
- """
- self.__sock.connect(self.__address)
- self.__sockfile = self.__sock.makefile(mode='r')
- if negotiate:
- return self.__negotiate_capabilities()
- return None
-
- def accept(self, timeout: Optional[float] = 15.0) -> QMPMessage:
- """
- Await connection from QMP Monitor and perform capabilities negotiation.
-
- @param timeout: timeout in seconds (nonnegative float number, or
- None). The value passed will set the behavior of the
- underneath QMP socket as described in [1].
- Default value is set to 15.0.
-
- @return QMP greeting dict
- @raise OSError on socket connection errors
- @raise QMPConnectError if the greeting is not received
- @raise QMPCapabilitiesError if fails to negotiate capabilities
-
- [1]
- https://docs.python.org/3/library/socket.html#socket.socket.settimeout
- """
- self.__sock.settimeout(timeout)
- self.__sock, _ = self.__sock.accept()
- self.__sockfile = self.__sock.makefile(mode='r')
- return self.__negotiate_capabilities()
-
- def cmd_obj(self, qmp_cmd: QMPMessage) -> QMPMessage:
- """
- Send a QMP command to the QMP Monitor.
-
- @param qmp_cmd: QMP command to be sent as a Python dict
- @return QMP response as a Python dict
- """
- self.logger.debug(">>> %s", qmp_cmd)
- self.__sock.sendall(json.dumps(qmp_cmd).encode('utf-8'))
- resp = self.__json_read()
- if resp is None:
- raise QMPConnectError("Unexpected empty reply from server")
- self.logger.debug("<<< %s", resp)
- return resp
-
- def cmd(self, name: str,
- args: Optional[Dict[str, object]] = None,
- cmd_id: Optional[object] = None) -> QMPMessage:
- """
- Build a QMP command and send it to the QMP Monitor.
-
- @param name: command name (string)
- @param args: command arguments (dict)
- @param cmd_id: command id (dict, list, string or int)
- """
- qmp_cmd: QMPMessage = {'execute': name}
- if args:
- qmp_cmd['arguments'] = args
- if cmd_id:
- qmp_cmd['id'] = cmd_id
- return self.cmd_obj(qmp_cmd)
-
- def command(self, cmd: str, **kwds: object) -> QMPReturnValue:
- """
- Build and send a QMP command to the monitor, report errors if any
- """
- ret = self.cmd(cmd, kwds)
- if 'error' in ret:
- raise QMPResponseError(ret)
- if 'return' not in ret:
- raise QMPProtocolError(
- "'return' key not found in QMP response '{}'".format(str(ret))
- )
- return cast(QMPReturnValue, ret['return'])
-
- def pull_event(self,
- wait: Union[bool, float] = False) -> Optional[QMPMessage]:
- """
- Pulls a single event.
-
- @param wait (bool): block until an event is available.
- @param wait (float): If wait is a float, treat it as a timeout value.
-
- @raise QMPTimeoutError: If a timeout float is provided and the timeout
- period elapses.
- @raise QMPConnectError: If wait is True but no events could be
- retrieved or if some other error occurred.
-
- @return The first available QMP event, or None.
- """
- self.__get_events(wait)
-
- if self.__events:
- return self.__events.pop(0)
- return None
-
- def get_events(self, wait: bool = False) -> List[QMPMessage]:
- """
- Get a list of available QMP events and clear all pending events.
-
- @param wait (bool): block until an event is available.
- @param wait (float): If wait is a float, treat it as a timeout value.
-
- @raise QMPTimeoutError: If a timeout float is provided and the timeout
- period elapses.
- @raise QMPConnectError: If wait is True but no events could be
- retrieved or if some other error occurred.
-
- @return The list of available QMP events.
- """
- self.__get_events(wait)
- events = self.__events
- self.__events = []
- return events
-
- def clear_events(self) -> None:
- """
- Clear current list of pending events.
- """
- self.__events = []
-
- def close(self) -> None:
- """
- Close the socket and socket file.
- """
- if self.__sock:
- self.__sock.close()
- if self.__sockfile:
- self.__sockfile.close()
-
- def settimeout(self, timeout: Optional[float]) -> None:
- """
- Set the socket timeout.
-
- @param timeout (float): timeout in seconds (non-zero), or None.
- @note This is a wrap around socket.settimeout
-
- @raise ValueError: if timeout was set to 0.
- """
- if timeout == 0:
- msg = "timeout cannot be 0; this engages non-blocking mode."
- msg += " Use 'None' instead to disable timeouts."
- raise ValueError(msg)
- self.__sock.settimeout(timeout)
-
- def send_fd_scm(self, fd: int) -> None:
- """
- Send a file descriptor to the remote via SCM_RIGHTS.
- """
- if self.__sock.family != socket.AF_UNIX:
- raise RuntimeError("Can't use SCM_RIGHTS on non-AF_UNIX socket.")
-
- self.__sock.sendmsg(
- [b' '],
- [(socket.SOL_SOCKET, socket.SCM_RIGHTS, struct.pack('@i', fd))]
- )
diff --git a/python/qemu/qmp/py.typed b/python/qemu/qmp/py.typed
deleted file mode 100644
index e69de29bb2d..00000000000
diff --git a/python/setup.cfg b/python/setup.cfg
index cdeced44d2b..4340c29a24f 100644
--- a/python/setup.cfg
+++ b/python/setup.cfg
@@ -24,10 +24,9 @@ classifiers =
[options]
python_requires = >= 3.6
packages =
- qemu.qmp
+ qemu.aqmp
qemu.machine
qemu.utils
- qemu.aqmp
[options.package_data]
* = py.typed
--
2.34.1
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v2 6/9] python: re-enable pylint duplicate-code warnings
2022-03-30 17:28 [PATCH v2 0/9] Python: Remove synchronous QMP library John Snow
` (4 preceding siblings ...)
2022-03-30 17:28 ` [PATCH v2 5/9] python: remove the old QMP package John Snow
@ 2022-03-30 17:28 ` John Snow
2022-03-30 17:28 ` [PATCH v2 7/9] python: rename qemu.aqmp to qemu.qmp John Snow
` (3 subsequent siblings)
9 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2022-03-30 17:28 UTC (permalink / raw)
To: qemu-devel
Cc: Kevin Wolf, Vladimir Sementsov-Ogievskiy, Beraldo Leal,
qemu-block, Markus Armbruster, Hanna Reitz,
Vladimir Sementsov-Ogievskiy, Cleber Rosa, John Snow
With the old library gone, there's nothing duplicated in the tree, so
the warning suppression can be removed.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
Reviewed-by: Beraldo Leal <bleal@redhat.com>
---
python/setup.cfg | 1 -
1 file changed, 1 deletion(-)
diff --git a/python/setup.cfg b/python/setup.cfg
index 4340c29a24f..49e3c285f19 100644
--- a/python/setup.cfg
+++ b/python/setup.cfg
@@ -118,7 +118,6 @@ disable=consider-using-f-string,
too-many-function-args, # mypy handles this with less false positives.
too-many-instance-attributes,
no-member, # mypy also handles this better.
- duplicate-code, # To be removed by the end of this patch series.
[pylint.basic]
# Good variable names which should always be accepted, separated by a comma.
--
2.34.1
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v2 7/9] python: rename qemu.aqmp to qemu.qmp
2022-03-30 17:28 [PATCH v2 0/9] Python: Remove synchronous QMP library John Snow
` (5 preceding siblings ...)
2022-03-30 17:28 ` [PATCH v2 6/9] python: re-enable pylint duplicate-code warnings John Snow
@ 2022-03-30 17:28 ` John Snow
2022-03-30 19:20 ` Vladimir Sementsov-Ogievskiy
2022-03-30 17:28 ` [PATCH v2 8/9] python: rename 'aqmp-tui' to 'qmp-tui' John Snow
` (2 subsequent siblings)
9 siblings, 1 reply; 14+ messages in thread
From: John Snow @ 2022-03-30 17:28 UTC (permalink / raw)
To: qemu-devel
Cc: Kevin Wolf, Vladimir Sementsov-Ogievskiy, Beraldo Leal,
qemu-block, Markus Armbruster, Hanna Reitz, Cleber Rosa,
John Snow
Now that we are fully switched over to the new QMP library, move it back
over the old namespace. This is being done primarily so that we may
upload this package simply as "qemu.qmp" without introducing confusion
over whether or not "aqmp" is a new protocol or not.
The trade-off is increased confusion inside the QEMU developer
tree. Sorry!
Note: the 'private' member "_aqmp" in legacy.py also changes to "_qmp";
not out of necessity, but just to remove any traces of the "aqmp"
name.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Beraldo Leal <bleal@redhat.com>
Acked-by: Hanna Reitz <hreitz@redhat.com>
---
python/PACKAGE.rst | 4 +--
python/README.rst | 4 +--
python/qemu/machine/machine.py | 4 +--
python/qemu/machine/qtest.py | 2 +-
python/qemu/{aqmp => qmp}/__init__.py | 6 ++--
python/qemu/{aqmp => qmp}/aqmp_tui.py | 0
python/qemu/{aqmp => qmp}/error.py | 0
python/qemu/{aqmp => qmp}/events.py | 2 +-
python/qemu/{aqmp => qmp}/legacy.py | 38 +++++++++++------------
python/qemu/{aqmp => qmp}/message.py | 0
python/qemu/{aqmp => qmp}/models.py | 0
python/qemu/{aqmp => qmp}/protocol.py | 4 +--
python/qemu/{aqmp => qmp}/py.typed | 0
python/qemu/{aqmp => qmp}/qmp_client.py | 16 +++++-----
python/qemu/{aqmp => qmp}/qmp_shell.py | 4 +--
python/qemu/{aqmp => qmp}/util.py | 0
python/qemu/utils/qemu_ga_client.py | 4 +--
python/qemu/utils/qom.py | 2 +-
python/qemu/utils/qom_common.py | 4 +--
python/qemu/utils/qom_fuse.py | 2 +-
python/setup.cfg | 10 +++---
python/tests/protocol.py | 14 ++++-----
scripts/cpu-x86-uarch-abi.py | 2 +-
scripts/device-crash-test | 4 +--
scripts/qmp/qmp-shell | 2 +-
scripts/qmp/qmp-shell-wrap | 2 +-
scripts/render_block_graph.py | 4 +--
scripts/simplebench/bench_block_job.py | 2 +-
tests/qemu-iotests/iotests.py | 2 +-
tests/qemu-iotests/tests/mirror-top-perms | 4 +--
30 files changed, 71 insertions(+), 71 deletions(-)
rename python/qemu/{aqmp => qmp}/__init__.py (87%)
rename python/qemu/{aqmp => qmp}/aqmp_tui.py (100%)
rename python/qemu/{aqmp => qmp}/error.py (100%)
rename python/qemu/{aqmp => qmp}/events.py (99%)
rename python/qemu/{aqmp => qmp}/legacy.py (91%)
rename python/qemu/{aqmp => qmp}/message.py (100%)
rename python/qemu/{aqmp => qmp}/models.py (100%)
rename python/qemu/{aqmp => qmp}/protocol.py (99%)
rename python/qemu/{aqmp => qmp}/py.typed (100%)
rename python/qemu/{aqmp => qmp}/qmp_client.py (97%)
rename python/qemu/{aqmp => qmp}/qmp_shell.py (99%)
rename python/qemu/{aqmp => qmp}/util.py (100%)
diff --git a/python/PACKAGE.rst b/python/PACKAGE.rst
index ddfa9ba3f59..b0b86cc4c31 100644
--- a/python/PACKAGE.rst
+++ b/python/PACKAGE.rst
@@ -8,11 +8,11 @@ to change at any time.
Usage
-----
-The ``qemu.aqmp`` subpackage provides a library for communicating with
+The ``qemu.qmp`` subpackage provides a library for communicating with
QMP servers. The ``qemu.machine`` subpackage offers rudimentary
facilities for launching and managing QEMU processes. Refer to each
package's documentation
-(``>>> help(qemu.aqmp)``, ``>>> help(qemu.machine)``)
+(``>>> help(qemu.qmp)``, ``>>> help(qemu.machine)``)
for more information.
Contributing
diff --git a/python/README.rst b/python/README.rst
index eb5213337d2..9c1fceaee73 100644
--- a/python/README.rst
+++ b/python/README.rst
@@ -3,7 +3,7 @@ QEMU Python Tooling
This directory houses Python tooling used by the QEMU project to build,
configure, and test QEMU. It is organized by namespace (``qemu``), and
-then by package (e.g. ``qemu/machine``, ``qemu/aqmp``, etc).
+then by package (e.g. ``qemu/machine``, ``qemu/qmp``, etc).
``setup.py`` is used by ``pip`` to install this tooling to the current
environment. ``setup.cfg`` provides the packaging configuration used by
@@ -59,7 +59,7 @@ Package installation also normally provides executable console scripts,
so that tools like ``qmp-shell`` are always available via $PATH. To
invoke them without installation, you can invoke e.g.:
-``> PYTHONPATH=~/src/qemu/python python3 -m qemu.aqmp.qmp_shell``
+``> PYTHONPATH=~/src/qemu/python python3 -m qemu.qmp.qmp_shell``
The mappings between console script name and python module path can be
found in ``setup.cfg``.
diff --git a/python/qemu/machine/machine.py b/python/qemu/machine/machine.py
index 41be025ac7b..07ac5a710be 100644
--- a/python/qemu/machine/machine.py
+++ b/python/qemu/machine/machine.py
@@ -40,8 +40,8 @@
TypeVar,
)
-from qemu.aqmp import SocketAddrT
-from qemu.aqmp.legacy import (
+from qemu.qmp import SocketAddrT
+from qemu.qmp.legacy import (
QEMUMonitorProtocol,
QMPMessage,
QMPReturnValue,
diff --git a/python/qemu/machine/qtest.py b/python/qemu/machine/qtest.py
index 13e0aaff846..1a1fc6c9b08 100644
--- a/python/qemu/machine/qtest.py
+++ b/python/qemu/machine/qtest.py
@@ -26,7 +26,7 @@
TextIO,
)
-from qemu.aqmp import SocketAddrT
+from qemu.qmp import SocketAddrT
from .machine import QEMUMachine
diff --git a/python/qemu/aqmp/__init__.py b/python/qemu/qmp/__init__.py
similarity index 87%
rename from python/qemu/aqmp/__init__.py
rename to python/qemu/qmp/__init__.py
index 2b69b264f4f..69190d057a5 100644
--- a/python/qemu/aqmp/__init__.py
+++ b/python/qemu/qmp/__init__.py
@@ -6,8 +6,8 @@
QEMU Guest Agent, and the QEMU Storage Daemon.
`QMPClient` provides the main functionality of this package. All errors
-raised by this library derive from `QMPError`, see `aqmp.error` for
-additional detail. See `aqmp.events` for an in-depth tutorial on
+raised by this library derive from `QMPError`, see `qmp.error` for
+additional detail. See `qmp.events` for an in-depth tutorial on
managing QMP events.
"""
@@ -36,7 +36,7 @@
# Suppress logging unless an application engages it.
-logging.getLogger('qemu.aqmp').addHandler(logging.NullHandler())
+logging.getLogger('qemu.qmp').addHandler(logging.NullHandler())
# The order of these fields impact the Sphinx documentation order.
diff --git a/python/qemu/aqmp/aqmp_tui.py b/python/qemu/qmp/aqmp_tui.py
similarity index 100%
rename from python/qemu/aqmp/aqmp_tui.py
rename to python/qemu/qmp/aqmp_tui.py
diff --git a/python/qemu/aqmp/error.py b/python/qemu/qmp/error.py
similarity index 100%
rename from python/qemu/aqmp/error.py
rename to python/qemu/qmp/error.py
diff --git a/python/qemu/aqmp/events.py b/python/qemu/qmp/events.py
similarity index 99%
rename from python/qemu/aqmp/events.py
rename to python/qemu/qmp/events.py
index f3d4e2b5e85..6199776cc66 100644
--- a/python/qemu/aqmp/events.py
+++ b/python/qemu/qmp/events.py
@@ -1,5 +1,5 @@
"""
-AQMP Events and EventListeners
+QMP Events and EventListeners
Asynchronous QMP uses `EventListener` objects to listen for events. An
`EventListener` is a FIFO event queue that can be pre-filtered to listen
diff --git a/python/qemu/aqmp/legacy.py b/python/qemu/qmp/legacy.py
similarity index 91%
rename from python/qemu/aqmp/legacy.py
rename to python/qemu/qmp/legacy.py
index dfcd20bbd23..a8629b44dff 100644
--- a/python/qemu/aqmp/legacy.py
+++ b/python/qemu/qmp/legacy.py
@@ -78,13 +78,13 @@ def __init__(self, address: SocketAddrT,
server: bool = False,
nickname: Optional[str] = None):
- self._aqmp = QMPClient(nickname)
+ self._qmp = QMPClient(nickname)
self._aloop = asyncio.get_event_loop()
self._address = address
self._timeout: Optional[float] = None
if server:
- self._sync(self._aqmp.start_server(self._address))
+ self._sync(self._qmp.start_server(self._address))
_T = TypeVar('_T')
@@ -96,9 +96,9 @@ def _sync(
)
def _get_greeting(self) -> Optional[QMPMessage]:
- if self._aqmp.greeting is not None:
+ if self._qmp.greeting is not None:
# pylint: disable=protected-access
- return self._aqmp.greeting._asdict()
+ return self._qmp.greeting._asdict()
return None
def __enter__(self: _T) -> _T:
@@ -141,11 +141,11 @@ def connect(self, negotiate: bool = True) -> Optional[QMPMessage]:
:return: QMP greeting dict, or None if negotiate is false
:raise ConnectError: on connection errors
"""
- self._aqmp.await_greeting = negotiate
- self._aqmp.negotiate = negotiate
+ self._qmp.await_greeting = negotiate
+ self._qmp.negotiate = negotiate
self._sync(
- self._aqmp.connect(self._address)
+ self._qmp.connect(self._address)
)
return self._get_greeting()
@@ -160,10 +160,10 @@ def accept(self, timeout: Optional[float] = 15.0) -> QMPMessage:
:return: QMP greeting dict
:raise ConnectError: on connection errors
"""
- self._aqmp.await_greeting = True
- self._aqmp.negotiate = True
+ self._qmp.await_greeting = True
+ self._qmp.negotiate = True
- self._sync(self._aqmp.accept(), timeout)
+ self._sync(self._qmp.accept(), timeout)
ret = self._get_greeting()
assert ret is not None
@@ -183,7 +183,7 @@ def cmd_obj(self, qmp_cmd: QMPMessage) -> QMPMessage:
# _raw() isn't a public API, because turning off
# automatic ID assignment is discouraged. For
# compatibility with iotests *only*, do it anyway.
- self._aqmp._raw(qmp_cmd, assign_id=False),
+ self._qmp._raw(qmp_cmd, assign_id=False),
self._timeout
)
)
@@ -210,7 +210,7 @@ def command(self, cmd: str, **kwds: object) -> QMPReturnValue:
Build and send a QMP command to the monitor, report errors if any
"""
return self._sync(
- self._aqmp.execute(cmd, kwds),
+ self._qmp.execute(cmd, kwds),
self._timeout
)
@@ -231,7 +231,7 @@ def pull_event(self,
"""
if not wait:
# wait is False/0: "do not wait, do not except."
- if self._aqmp.events.empty():
+ if self._qmp.events.empty():
return None
# If wait is 'True', wait forever. If wait is False/0, the events
@@ -243,7 +243,7 @@ def pull_event(self,
return dict(
self._sync(
- self._aqmp.events.get(),
+ self._qmp.events.get(),
timeout
)
)
@@ -263,7 +263,7 @@ def get_events(self, wait: Union[bool, float] = False) -> List[QMPMessage]:
:return: A list of QMP events.
"""
- events = [dict(x) for x in self._aqmp.events.clear()]
+ events = [dict(x) for x in self._qmp.events.clear()]
if events:
return events
@@ -272,12 +272,12 @@ def get_events(self, wait: Union[bool, float] = False) -> List[QMPMessage]:
def clear_events(self) -> None:
"""Clear current list of pending events."""
- self._aqmp.events.clear()
+ self._qmp.events.clear()
def close(self) -> None:
"""Close the connection."""
self._sync(
- self._aqmp.disconnect()
+ self._qmp.disconnect()
)
def settimeout(self, timeout: Optional[float]) -> None:
@@ -298,10 +298,10 @@ def send_fd_scm(self, fd: int) -> None:
"""
Send a file descriptor to the remote via SCM_RIGHTS.
"""
- self._aqmp.send_fd_scm(fd)
+ self._qmp.send_fd_scm(fd)
def __del__(self) -> None:
- if self._aqmp.runstate == Runstate.IDLE:
+ if self._qmp.runstate == Runstate.IDLE:
return
if not self._aloop.is_running():
diff --git a/python/qemu/aqmp/message.py b/python/qemu/qmp/message.py
similarity index 100%
rename from python/qemu/aqmp/message.py
rename to python/qemu/qmp/message.py
diff --git a/python/qemu/aqmp/models.py b/python/qemu/qmp/models.py
similarity index 100%
rename from python/qemu/aqmp/models.py
rename to python/qemu/qmp/models.py
diff --git a/python/qemu/aqmp/protocol.py b/python/qemu/qmp/protocol.py
similarity index 99%
rename from python/qemu/aqmp/protocol.py
rename to python/qemu/qmp/protocol.py
index 36fae57f277..6ea86650ad2 100644
--- a/python/qemu/aqmp/protocol.py
+++ b/python/qemu/qmp/protocol.py
@@ -196,9 +196,9 @@ class AsyncProtocol(Generic[T]):
:param name:
Name used for logging messages, if any. By default, messages
- will log to 'qemu.aqmp.protocol', but each individual connection
+ will log to 'qemu.qmp.protocol', but each individual connection
can be given its own logger by giving it a name; messages will
- then log to 'qemu.aqmp.protocol.${name}'.
+ then log to 'qemu.qmp.protocol.${name}'.
"""
# pylint: disable=too-many-instance-attributes
diff --git a/python/qemu/aqmp/py.typed b/python/qemu/qmp/py.typed
similarity index 100%
rename from python/qemu/aqmp/py.typed
rename to python/qemu/qmp/py.typed
diff --git a/python/qemu/aqmp/qmp_client.py b/python/qemu/qmp/qmp_client.py
similarity index 97%
rename from python/qemu/aqmp/qmp_client.py
rename to python/qemu/qmp/qmp_client.py
index 90a8737f03a..5dcda04a756 100644
--- a/python/qemu/aqmp/qmp_client.py
+++ b/python/qemu/qmp/qmp_client.py
@@ -192,7 +192,7 @@ async def run(self, address='/tmp/qemu.socket'):
await self.qmp.runstate_changed.wait()
await self.disconnect()
- See `aqmp.events` for more detail on event handling patterns.
+ See `qmp.events` for more detail on event handling patterns.
"""
#: Logger object used for debugging messages.
logger = logging.getLogger(__name__)
@@ -416,7 +416,7 @@ def _do_send(self, msg: Message) -> None:
@upper_half
def _get_exec_id(self) -> str:
- exec_id = f"__aqmp#{self._execute_id:05d}"
+ exec_id = f"__qmp#{self._execute_id:05d}"
self._execute_id += 1
return exec_id
@@ -476,7 +476,7 @@ async def _execute(self, msg: Message, assign_id: bool = True) -> Message:
An execution ID will be assigned if assign_id is `True`. It can be
disabled, but this requires that an ID is manually assigned
instead. For manually assigned IDs, you must not use the string
- '__aqmp#' anywhere in the ID.
+ '__qmp#' anywhere in the ID.
:param msg: The QMP `Message` to execute.
:param assign_id: If True, assign a new execution ID.
@@ -490,7 +490,7 @@ async def _execute(self, msg: Message, assign_id: bool = True) -> Message:
msg['id'] = self._get_exec_id()
elif 'id' in msg:
assert isinstance(msg['id'], str)
- assert '__aqmp#' not in msg['id']
+ assert '__qmp#' not in msg['id']
exec_id = await self._issue(msg)
return await self._reply(exec_id)
@@ -512,7 +512,7 @@ async def _raw(
Assign an arbitrary execution ID to this message. If
`False`, the existing id must either be absent (and no other
such pending execution may omit an ID) or a string. If it is
- a string, it must not start with '__aqmp#' and no other such
+ a string, it must not start with '__qmp#' and no other such
pending execution may currently be using that ID.
:return: Execution reply from the server.
@@ -524,7 +524,7 @@ async def _raw(
When assign_id is `False`, an ID is given, and it is not a string.
:raise ValueError:
When assign_id is `False`, but the ID is not usable;
- Either because it starts with '__aqmp#' or it is already in-use.
+ Either because it starts with '__qmp#' or it is already in-use.
"""
# 1. convert generic Mapping or bytes to a QMP Message
# 2. copy Message objects so that we assign an ID only to the copy.
@@ -534,9 +534,9 @@ async def _raw(
if not assign_id and 'id' in msg:
if not isinstance(exec_id, str):
raise TypeError(f"ID ('{exec_id}') must be a string.")
- if exec_id.startswith('__aqmp#'):
+ if exec_id.startswith('__qmp#'):
raise ValueError(
- f"ID ('{exec_id}') must not start with '__aqmp#'."
+ f"ID ('{exec_id}') must not start with '__qmp#'."
)
if not assign_id and exec_id in self._pending:
diff --git a/python/qemu/aqmp/qmp_shell.py b/python/qemu/qmp/qmp_shell.py
similarity index 99%
rename from python/qemu/aqmp/qmp_shell.py
rename to python/qemu/qmp/qmp_shell.py
index c23f1b19280..619ab42cedd 100644
--- a/python/qemu/aqmp/qmp_shell.py
+++ b/python/qemu/qmp/qmp_shell.py
@@ -98,8 +98,8 @@
Sequence,
)
-from qemu.aqmp import ConnectError, QMPError, SocketAddrT
-from qemu.aqmp.legacy import (
+from qemu.qmp import ConnectError, QMPError, SocketAddrT
+from qemu.qmp.legacy import (
QEMUMonitorProtocol,
QMPBadPortError,
QMPMessage,
diff --git a/python/qemu/aqmp/util.py b/python/qemu/qmp/util.py
similarity index 100%
rename from python/qemu/aqmp/util.py
rename to python/qemu/qmp/util.py
diff --git a/python/qemu/utils/qemu_ga_client.py b/python/qemu/utils/qemu_ga_client.py
index 15ed430c618..8c38a7ac9c0 100644
--- a/python/qemu/utils/qemu_ga_client.py
+++ b/python/qemu/utils/qemu_ga_client.py
@@ -50,8 +50,8 @@
Sequence,
)
-from qemu.aqmp import ConnectError, SocketAddrT
-from qemu.aqmp.legacy import QEMUMonitorProtocol
+from qemu.qmp import ConnectError, SocketAddrT
+from qemu.qmp.legacy import QEMUMonitorProtocol
# This script has not seen many patches or careful attention in quite
diff --git a/python/qemu/utils/qom.py b/python/qemu/utils/qom.py
index bb5d1a78f59..bcf192f4774 100644
--- a/python/qemu/utils/qom.py
+++ b/python/qemu/utils/qom.py
@@ -32,7 +32,7 @@
import argparse
-from qemu.aqmp import ExecuteError
+from qemu.qmp import ExecuteError
from .qom_common import QOMCommand
diff --git a/python/qemu/utils/qom_common.py b/python/qemu/utils/qom_common.py
index e034a6f2476..80da1b23041 100644
--- a/python/qemu/utils/qom_common.py
+++ b/python/qemu/utils/qom_common.py
@@ -27,8 +27,8 @@
TypeVar,
)
-from qemu.aqmp import QMPError
-from qemu.aqmp.legacy import QEMUMonitorProtocol
+from qemu.qmp import QMPError
+from qemu.qmp.legacy import QEMUMonitorProtocol
class ObjectPropertyInfo:
diff --git a/python/qemu/utils/qom_fuse.py b/python/qemu/utils/qom_fuse.py
index 653a76b93b9..8dcd59fcde6 100644
--- a/python/qemu/utils/qom_fuse.py
+++ b/python/qemu/utils/qom_fuse.py
@@ -48,7 +48,7 @@
import fuse
from fuse import FUSE, FuseOSError, Operations
-from qemu.aqmp import ExecuteError
+from qemu.qmp import ExecuteError
from .qom_common import QOMCommand
diff --git a/python/setup.cfg b/python/setup.cfg
index 49e3c285f19..773e51b34e7 100644
--- a/python/setup.cfg
+++ b/python/setup.cfg
@@ -24,7 +24,7 @@ classifiers =
[options]
python_requires = >= 3.6
packages =
- qemu.aqmp
+ qemu.qmp
qemu.machine
qemu.utils
@@ -66,9 +66,9 @@ console_scripts =
qom-tree = qemu.utils.qom:QOMTree.entry_point
qom-fuse = qemu.utils.qom_fuse:QOMFuse.entry_point [fuse]
qemu-ga-client = qemu.utils.qemu_ga_client:main
- qmp-shell = qemu.aqmp.qmp_shell:main
- qmp-shell-wrap = qemu.aqmp.qmp_shell:main_wrap
- aqmp-tui = qemu.aqmp.aqmp_tui:main [tui]
+ qmp-shell = qemu.qmp.qmp_shell:main
+ qmp-shell-wrap = qemu.qmp.qmp_shell:main_wrap
+ aqmp-tui = qemu.qmp.aqmp_tui:main [tui]
[flake8]
extend-ignore = E722 # Prefer pylint's bare-except checks to flake8's
@@ -84,7 +84,7 @@ namespace_packages = True
# fusepy has no type stubs:
allow_subclassing_any = True
-[mypy-qemu.aqmp.aqmp_tui]
+[mypy-qemu.qmp.aqmp_tui]
# urwid and urwid_readline have no type stubs:
allow_subclassing_any = True
diff --git a/python/tests/protocol.py b/python/tests/protocol.py
index d6849ad3062..56c4d441f9c 100644
--- a/python/tests/protocol.py
+++ b/python/tests/protocol.py
@@ -6,9 +6,9 @@
import avocado
-from qemu.aqmp import ConnectError, Runstate
-from qemu.aqmp.protocol import AsyncProtocol, StateError
-from qemu.aqmp.util import asyncio_run, create_task
+from qemu.qmp import ConnectError, Runstate
+from qemu.qmp.protocol import AsyncProtocol, StateError
+from qemu.qmp.util import asyncio_run, create_task
class NullProtocol(AsyncProtocol[None]):
@@ -183,7 +183,7 @@ def testDefaultName(self):
def testLogger(self):
self.assertEqual(
self.proto.logger.name,
- 'qemu.aqmp.protocol'
+ 'qemu.qmp.protocol'
)
def testName(self):
@@ -196,7 +196,7 @@ def testName(self):
self.assertEqual(
self.proto.logger.name,
- 'qemu.aqmp.protocol.Steve'
+ 'qemu.qmp.protocol.Steve'
)
self.assertEqual(
@@ -431,7 +431,7 @@ async def _bad_connection(self, family: str):
await self.proto.start_server_and_accept('/dev/null')
async def _hanging_connection(self):
- with TemporaryDirectory(suffix='.aqmp') as tmpdir:
+ with TemporaryDirectory(suffix='.qmp') as tmpdir:
sock = os.path.join(tmpdir, type(self.proto).__name__ + ".sock")
await self.proto.start_server_and_accept(sock)
@@ -587,7 +587,7 @@ async def _asyncTearDown(self):
@TestBase.async_test
async def testSmoke(self):
- with TemporaryDirectory(suffix='.aqmp') as tmpdir:
+ with TemporaryDirectory(suffix='.qmp') as tmpdir:
sock = os.path.join(tmpdir, type(self.proto).__name__ + ".sock")
server_task = create_task(self.server.start_server_and_accept(sock))
diff --git a/scripts/cpu-x86-uarch-abi.py b/scripts/cpu-x86-uarch-abi.py
index c262d2f0277..82ff07582f8 100644
--- a/scripts/cpu-x86-uarch-abi.py
+++ b/scripts/cpu-x86-uarch-abi.py
@@ -6,7 +6,7 @@
# compatibility levels for each CPU model.
#
-from qemu.aqmp.legacy import QEMUMonitorProtocol
+from qemu.qmp.legacy import QEMUMonitorProtocol
import sys
if len(sys.argv) != 2:
diff --git a/scripts/device-crash-test b/scripts/device-crash-test
index 7fbd99158be..4bfc68c0087 100755
--- a/scripts/device-crash-test
+++ b/scripts/device-crash-test
@@ -36,7 +36,7 @@ from itertools import chain
sys.path.append(os.path.join(os.path.dirname(__file__), '..', 'python'))
from qemu.machine import QEMUMachine
-from qemu.aqmp import ConnectError
+from qemu.qmp import ConnectError
logger = logging.getLogger('device-crash-test')
dbg = logger.debug
@@ -517,7 +517,7 @@ def main():
# Async QMP, when in use, is chatty about connection failures.
# This script knowingly generates a ton of connection errors.
# Silence this logger.
- logging.getLogger('qemu.aqmp.qmp_client').setLevel(logging.CRITICAL)
+ logging.getLogger('qemu.qmp.qmp_client').setLevel(logging.CRITICAL)
fatal_failures = []
wl_stats = {}
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 31b19d73e22..4a20f97db70 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -4,7 +4,7 @@ import os
import sys
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
-from qemu.aqmp import qmp_shell
+from qemu.qmp import qmp_shell
if __name__ == '__main__':
diff --git a/scripts/qmp/qmp-shell-wrap b/scripts/qmp/qmp-shell-wrap
index 66846e36d1f..9e94da114f5 100755
--- a/scripts/qmp/qmp-shell-wrap
+++ b/scripts/qmp/qmp-shell-wrap
@@ -4,7 +4,7 @@ import os
import sys
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
-from qemu.aqmp import qmp_shell
+from qemu.qmp import qmp_shell
if __name__ == '__main__':
diff --git a/scripts/render_block_graph.py b/scripts/render_block_graph.py
index b33fb70d5ee..8f731a5cfe1 100755
--- a/scripts/render_block_graph.py
+++ b/scripts/render_block_graph.py
@@ -25,8 +25,8 @@
from graphviz import Digraph
sys.path.append(os.path.join(os.path.dirname(__file__), '..', 'python'))
-from qemu.aqmp import QMPError
-from qemu.aqmp.legacy import QEMUMonitorProtocol
+from qemu.qmp import QMPError
+from qemu.qmp.legacy import QEMUMonitorProtocol
def perm(arr):
diff --git a/scripts/simplebench/bench_block_job.py b/scripts/simplebench/bench_block_job.py
index af9d1646a46..56191db44b2 100755
--- a/scripts/simplebench/bench_block_job.py
+++ b/scripts/simplebench/bench_block_job.py
@@ -27,7 +27,7 @@
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
from qemu.machine import QEMUMachine
-from qemu.aqmp import ConnectError
+from qemu.qmp import ConnectError
def bench_block_job(cmd, cmd_args, qemu_args):
diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
index 56cbad244f9..87eb5f542f5 100644
--- a/tests/qemu-iotests/iotests.py
+++ b/tests/qemu-iotests/iotests.py
@@ -37,8 +37,8 @@
from contextlib import contextmanager
-from qemu.aqmp.legacy import QMPMessage, QEMUMonitorProtocol
from qemu.machine import qtest
+from qemu.qmp.legacy import QMPMessage, QEMUMonitorProtocol
from qemu.utils import VerboseProcessError
# Use this logger for logging messages directly from the iotests module
diff --git a/tests/qemu-iotests/tests/mirror-top-perms b/tests/qemu-iotests/tests/mirror-top-perms
index a9f275cd7f2..8bca5927089 100755
--- a/tests/qemu-iotests/tests/mirror-top-perms
+++ b/tests/qemu-iotests/tests/mirror-top-perms
@@ -97,8 +97,8 @@ class TestMirrorTopPerms(iotests.QMPTestCase):
self.vm_b.add_blockdev(f'file,node-name=drive0,filename={source}')
self.vm_b.add_device('virtio-blk,drive=drive0,share-rw=on')
try:
- # Silence AQMP logging errors temporarily.
- with change_log_level('qemu.aqmp'):
+ # Silence QMP logging errors temporarily.
+ with change_log_level('qemu.qmp'):
self.vm_b.launch()
print('ERROR: VM B launched successfully, '
'this should not have happened')
--
2.34.1
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v2 8/9] python: rename 'aqmp-tui' to 'qmp-tui'
2022-03-30 17:28 [PATCH v2 0/9] Python: Remove synchronous QMP library John Snow
` (6 preceding siblings ...)
2022-03-30 17:28 ` [PATCH v2 7/9] python: rename qemu.aqmp to qemu.qmp John Snow
@ 2022-03-30 17:28 ` John Snow
2022-03-30 19:22 ` Vladimir Sementsov-Ogievskiy
2022-03-30 17:28 ` [PATCH v2 9/9] python/qmp: remove pylint workaround from legacy.py John Snow
2022-03-30 20:54 ` [PATCH v2 0/9] Python: Remove synchronous QMP library John Snow
9 siblings, 1 reply; 14+ messages in thread
From: John Snow @ 2022-03-30 17:28 UTC (permalink / raw)
To: qemu-devel
Cc: Kevin Wolf, Vladimir Sementsov-Ogievskiy, Beraldo Leal,
qemu-block, Markus Armbruster, Hanna Reitz, Cleber Rosa,
John Snow
This is the last vestige of the "aqmp" moniker surviving in the tree; remove it.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Beraldo Leal <bleal@redhat.com>
---
python/qemu/qmp/{aqmp_tui.py => qmp_tui.py} | 12 ++++++------
python/setup.cfg | 6 +++---
2 files changed, 9 insertions(+), 9 deletions(-)
rename python/qemu/qmp/{aqmp_tui.py => qmp_tui.py} (98%)
diff --git a/python/qemu/qmp/aqmp_tui.py b/python/qemu/qmp/qmp_tui.py
similarity index 98%
rename from python/qemu/qmp/aqmp_tui.py
rename to python/qemu/qmp/qmp_tui.py
index 59d3036be38..ce239d8979b 100644
--- a/python/qemu/qmp/aqmp_tui.py
+++ b/python/qemu/qmp/qmp_tui.py
@@ -6,13 +6,13 @@
# This work is licensed under the terms of the GNU LGPL, version 2 or
# later. See the COPYING file in the top-level directory.
"""
-AQMP TUI
+QMP TUI
-AQMP TUI is an asynchronous interface built on top the of the AQMP library.
+QMP TUI is an asynchronous interface built on top the of the QMP library.
It is the successor of QMP-shell and is bought-in as a replacement for it.
-Example Usage: aqmp-tui <SOCKET | TCP IP:PORT>
-Full Usage: aqmp-tui --help
+Example Usage: qmp-tui <SOCKET | TCP IP:PORT>
+Full Usage: qmp-tui --help
"""
import argparse
@@ -129,7 +129,7 @@ def has_handler_type(logger: logging.Logger,
class App(QMPClient):
"""
- Implements the AQMP TUI.
+ Implements the QMP TUI.
Initializes the widgets and starts the urwid event loop.
@@ -612,7 +612,7 @@ def main() -> None:
Driver of the whole script, parses arguments, initialize the TUI and
the logger.
"""
- parser = argparse.ArgumentParser(description='AQMP TUI')
+ parser = argparse.ArgumentParser(description='QMP TUI')
parser.add_argument('qmp_server', help='Address of the QMP server. '
'Format <UNIX socket path | TCP addr:port>')
parser.add_argument('--num-retries', type=int, default=10,
diff --git a/python/setup.cfg b/python/setup.cfg
index 773e51b34e7..e877ea56475 100644
--- a/python/setup.cfg
+++ b/python/setup.cfg
@@ -51,7 +51,7 @@ devel =
fuse =
fusepy >= 2.0.4
-# AQMP TUI dependencies
+# QMP TUI dependencies
tui =
urwid >= 2.1.2
urwid-readline >= 0.13
@@ -68,7 +68,7 @@ console_scripts =
qemu-ga-client = qemu.utils.qemu_ga_client:main
qmp-shell = qemu.qmp.qmp_shell:main
qmp-shell-wrap = qemu.qmp.qmp_shell:main_wrap
- aqmp-tui = qemu.qmp.aqmp_tui:main [tui]
+ qmp-tui = qemu.qmp.qmp_tui:main [tui]
[flake8]
extend-ignore = E722 # Prefer pylint's bare-except checks to flake8's
@@ -84,7 +84,7 @@ namespace_packages = True
# fusepy has no type stubs:
allow_subclassing_any = True
-[mypy-qemu.qmp.aqmp_tui]
+[mypy-qemu.qmp.qmp_tui]
# urwid and urwid_readline have no type stubs:
allow_subclassing_any = True
--
2.34.1
^ permalink raw reply related [flat|nested] 14+ messages in thread
* [PATCH v2 9/9] python/qmp: remove pylint workaround from legacy.py
2022-03-30 17:28 [PATCH v2 0/9] Python: Remove synchronous QMP library John Snow
` (7 preceding siblings ...)
2022-03-30 17:28 ` [PATCH v2 8/9] python: rename 'aqmp-tui' to 'qmp-tui' John Snow
@ 2022-03-30 17:28 ` John Snow
2022-03-30 19:25 ` Vladimir Sementsov-Ogievskiy
2022-03-30 20:54 ` [PATCH v2 0/9] Python: Remove synchronous QMP library John Snow
9 siblings, 1 reply; 14+ messages in thread
From: John Snow @ 2022-03-30 17:28 UTC (permalink / raw)
To: qemu-devel
Cc: Kevin Wolf, Vladimir Sementsov-Ogievskiy, Beraldo Leal,
qemu-block, Markus Armbruster, Hanna Reitz, Cleber Rosa,
John Snow
Pylint upgraded recently (2.13.z) and having a pylint: disable comment
in the middle of an argument field causes it some grief (It appears to
stop parsing when it encounters it, causing some syntax problems). Since
the duplicate line threshold was bumped up in 22305c2a081b, we don't
need this workaround anymore. Drop it.
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/qmp/legacy.py | 2 --
1 file changed, 2 deletions(-)
diff --git a/python/qemu/qmp/legacy.py b/python/qemu/qmp/legacy.py
index a8629b44dff..03b5574618f 100644
--- a/python/qemu/qmp/legacy.py
+++ b/python/qemu/qmp/legacy.py
@@ -106,8 +106,6 @@ def __enter__(self: _T) -> _T:
return self
def __exit__(self,
- # pylint: disable=duplicate-code
- # see https://github.com/PyCQA/pylint/issues/3619
exc_type: Optional[Type[BaseException]],
exc_val: Optional[BaseException],
exc_tb: Optional[TracebackType]) -> None:
--
2.34.1
^ permalink raw reply related [flat|nested] 14+ messages in thread
* Re: [PATCH v2 7/9] python: rename qemu.aqmp to qemu.qmp
2022-03-30 17:28 ` [PATCH v2 7/9] python: rename qemu.aqmp to qemu.qmp John Snow
@ 2022-03-30 19:20 ` Vladimir Sementsov-Ogievskiy
0 siblings, 0 replies; 14+ messages in thread
From: Vladimir Sementsov-Ogievskiy @ 2022-03-30 19:20 UTC (permalink / raw)
To: John Snow, qemu-devel
Cc: Beraldo Leal, Cleber Rosa, Markus Armbruster, Kevin Wolf,
Hanna Reitz, qemu-block
30.03.2022 20:28, John Snow wrote:
> Now that we are fully switched over to the new QMP library, move it back
> over the old namespace. This is being done primarily so that we may
> upload this package simply as "qemu.qmp" without introducing confusion
> over whether or not "aqmp" is a new protocol or not.
>
> The trade-off is increased confusion inside the QEMU developer
> tree. Sorry!
>
> Note: the 'private' member "_aqmp" in legacy.py also changes to "_qmp";
> not out of necessity, but just to remove any traces of the "aqmp"
> name.
>
> Signed-off-by: John Snow<jsnow@redhat.com>
> Reviewed-by: Beraldo Leal<bleal@redhat.com>
> Acked-by: Hanna Reitz<hreitz@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@openvz.org>
--
Best regards,
Vladimir
^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: [PATCH v2 8/9] python: rename 'aqmp-tui' to 'qmp-tui'
2022-03-30 17:28 ` [PATCH v2 8/9] python: rename 'aqmp-tui' to 'qmp-tui' John Snow
@ 2022-03-30 19:22 ` Vladimir Sementsov-Ogievskiy
0 siblings, 0 replies; 14+ messages in thread
From: Vladimir Sementsov-Ogievskiy @ 2022-03-30 19:22 UTC (permalink / raw)
To: John Snow, qemu-devel
Cc: Beraldo Leal, Cleber Rosa, Markus Armbruster, Kevin Wolf,
Hanna Reitz, qemu-block
30.03.2022 20:28, John Snow wrote:
> This is the last vestige of the "aqmp" moniker surviving in the tree; remove it.
>
> Signed-off-by: John Snow<jsnow@redhat.com>
> Reviewed-by: Beraldo Leal<bleal@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@openvz.org>
--
Best regards,
Vladimir
^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: [PATCH v2 9/9] python/qmp: remove pylint workaround from legacy.py
2022-03-30 17:28 ` [PATCH v2 9/9] python/qmp: remove pylint workaround from legacy.py John Snow
@ 2022-03-30 19:25 ` Vladimir Sementsov-Ogievskiy
0 siblings, 0 replies; 14+ messages in thread
From: Vladimir Sementsov-Ogievskiy @ 2022-03-30 19:25 UTC (permalink / raw)
To: John Snow, qemu-devel
Cc: Beraldo Leal, Cleber Rosa, Markus Armbruster, Kevin Wolf,
Hanna Reitz, qemu-block
30.03.2022 20:28, John Snow wrote:
> Pylint upgraded recently (2.13.z) and having a pylint: disable comment
> in the middle of an argument field causes it some grief (It appears to
> stop parsing when it encounters it, causing some syntax problems). Since
> the duplicate line threshold was bumped up in 22305c2a081b, we don't
> need this workaround anymore. Drop it.
>
> Signed-off-by: John Snow<jsnow@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@openvz.org>
--
Best regards,
Vladimir
^ permalink raw reply [flat|nested] 14+ messages in thread
* Re: [PATCH v2 0/9] Python: Remove synchronous QMP library
2022-03-30 17:28 [PATCH v2 0/9] Python: Remove synchronous QMP library John Snow
` (8 preceding siblings ...)
2022-03-30 17:28 ` [PATCH v2 9/9] python/qmp: remove pylint workaround from legacy.py John Snow
@ 2022-03-30 20:54 ` John Snow
9 siblings, 0 replies; 14+ messages in thread
From: John Snow @ 2022-03-30 20:54 UTC (permalink / raw)
To: qemu-devel
Cc: Kevin Wolf, Vladimir Sementsov-Ogievskiy, Beraldo Leal,
Qemu-block, Markus Armbruster, Hanna Reitz, Cleber Rosa
On Wed, Mar 30, 2022 at 1:28 PM John Snow <jsnow@redhat.com> wrote:
>
> Based-on: https://gitlab.com/jsnow/qemu/-/tree/python/
> GitLab: https://gitlab.com/jsnow/qemu/-/tree/python-qmp-legacy-switch-pt1c
> CI: https://gitlab.com/jsnow/qemu/-/pipelines/505169095
>
> Hi, this series is part of an effort to publish the qemu.qmp package on
> PyPI. It is the first of three series to complete this work:
>
> --> (1) Switch the new async QMP library in as python/qemu/qmp
> (2) Fork python/qemu/qmp out into its own repository,
> with updated GitLab CI/CD targets to build packages.
> (3) Update qemu.git to install qemu.qmp from PyPI,
> and then delete python/qemu/qmp.
>
> This series finalizes swapping out the old QMP library for the new
> one. This leaves us with just one QMP library to worry about. It also
> implements the rename of "qemu.aqmp" to "qemu.qmp".
>
> This is the last patch series before I perform the actual fork.
>
> These patches are (mostly) reviewed, so I'll likely stage these fairly
> quickly barring any objections. The plan is to submit them as soon as
> the tree re-opens to help prevent rot while I work on the fork.
>
> John Snow (9):
> python: temporarily silence pylint duplicate-code warnings
> python/aqmp: take QMPBadPortError and parse_address from qemu.qmp
> python/aqmp: fully separate from qmp.QEMUMonitorProtocol
> python/aqmp: copy qmp docstrings to qemu.aqmp.legacy
> python: remove the old QMP package
> python: re-enable pylint duplicate-code warnings
> python: rename qemu.aqmp to qemu.qmp
> python: rename 'aqmp-tui' to 'qmp-tui'
> python/qmp: remove pylint workaround from legacy.py
>
> python/README.rst | 2 +-
> python/qemu/qmp/README.rst | 9 -
> python/qemu/aqmp/__init__.py | 59 ---
> python/qemu/aqmp/legacy.py | 188 --------
> python/qemu/aqmp/py.typed | 0
> python/qemu/machine/machine.py | 4 +-
> python/qemu/machine/qtest.py | 2 +-
> python/qemu/qmp/__init__.py | 445 ++----------------
> python/qemu/{aqmp => qmp}/error.py | 0
> python/qemu/{aqmp => qmp}/events.py | 2 +-
> python/qemu/qmp/legacy.py | 315 +++++++++++++
> python/qemu/{aqmp => qmp}/message.py | 0
> python/qemu/{aqmp => qmp}/models.py | 0
> python/qemu/{aqmp => qmp}/protocol.py | 4 +-
> python/qemu/{aqmp => qmp}/qmp_client.py | 16 +-
> python/qemu/{aqmp => qmp}/qmp_shell.py | 4 +-
> .../qemu/{aqmp/aqmp_tui.py => qmp/qmp_tui.py} | 15 +-
> python/qemu/{aqmp => qmp}/util.py | 0
> python/qemu/utils/qemu_ga_client.py | 4 +-
> python/qemu/utils/qom.py | 2 +-
> python/qemu/utils/qom_common.py | 4 +-
> python/qemu/utils/qom_fuse.py | 2 +-
> python/setup.cfg | 11 +-
> python/tests/protocol.py | 14 +-
> scripts/cpu-x86-uarch-abi.py | 2 +-
> scripts/device-crash-test | 4 +-
> scripts/qmp/qmp-shell | 2 +-
> scripts/qmp/qmp-shell-wrap | 2 +-
> scripts/render_block_graph.py | 4 +-
> scripts/simplebench/bench_block_job.py | 2 +-
> tests/qemu-iotests/iotests.py | 2 +-
> tests/qemu-iotests/tests/mirror-top-perms | 4 +-
> 32 files changed, 409 insertions(+), 715 deletions(-)
> delete mode 100644 python/qemu/qmp/README.rst
> delete mode 100644 python/qemu/aqmp/__init__.py
> delete mode 100644 python/qemu/aqmp/legacy.py
> delete mode 100644 python/qemu/aqmp/py.typed
> rename python/qemu/{aqmp => qmp}/error.py (100%)
> rename python/qemu/{aqmp => qmp}/events.py (99%)
> create mode 100644 python/qemu/qmp/legacy.py
> rename python/qemu/{aqmp => qmp}/message.py (100%)
> rename python/qemu/{aqmp => qmp}/models.py (100%)
> rename python/qemu/{aqmp => qmp}/protocol.py (99%)
> rename python/qemu/{aqmp => qmp}/qmp_client.py (97%)
> rename python/qemu/{aqmp => qmp}/qmp_shell.py (99%)
> rename python/qemu/{aqmp/aqmp_tui.py => qmp/qmp_tui.py} (98%)
> rename python/qemu/{aqmp => qmp}/util.py (100%)
>
> --
> 2.34.1
>
Thanks, I've tentatively queued this on my Python branch. It won't be
going out until the tree opens again, so there's some time yet to
lodge a formal complaint. O:-)
--js
^ permalink raw reply [flat|nested] 14+ messages in thread
end of thread, other threads:[~2022-03-30 20:56 UTC | newest]
Thread overview: 14+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-03-30 17:28 [PATCH v2 0/9] Python: Remove synchronous QMP library John Snow
2022-03-30 17:28 ` [PATCH v2 1/9] python: temporarily silence pylint duplicate-code warnings John Snow
2022-03-30 17:28 ` [PATCH v2 2/9] python/aqmp: take QMPBadPortError and parse_address from qemu.qmp John Snow
2022-03-30 17:28 ` [PATCH v2 3/9] python/aqmp: fully separate from qmp.QEMUMonitorProtocol John Snow
2022-03-30 17:28 ` [PATCH v2 4/9] python/aqmp: copy qmp docstrings to qemu.aqmp.legacy John Snow
2022-03-30 17:28 ` [PATCH v2 5/9] python: remove the old QMP package John Snow
2022-03-30 17:28 ` [PATCH v2 6/9] python: re-enable pylint duplicate-code warnings John Snow
2022-03-30 17:28 ` [PATCH v2 7/9] python: rename qemu.aqmp to qemu.qmp John Snow
2022-03-30 19:20 ` Vladimir Sementsov-Ogievskiy
2022-03-30 17:28 ` [PATCH v2 8/9] python: rename 'aqmp-tui' to 'qmp-tui' John Snow
2022-03-30 19:22 ` Vladimir Sementsov-Ogievskiy
2022-03-30 17:28 ` [PATCH v2 9/9] python/qmp: remove pylint workaround from legacy.py John Snow
2022-03-30 19:25 ` Vladimir Sementsov-Ogievskiy
2022-03-30 20:54 ` [PATCH v2 0/9] Python: Remove synchronous QMP library John Snow
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.