Python patches

New functionality in qmp-shell from Dan, and some packaging fixes. -----BEGIN PGP SIGNATURE----- iQIzBAABCAAdFiEE+ber27ys35W+dsvQfe+BBqr8OQ4FAmIWsGMACgkQfe+BBqr8 OQ4/exAAs8v9kL+PYfgkkgaYnGQqjjEPGLxBMBPb4GntV+Uufxcy+HleeC5ZfIxR psJSblOPYZipu3lzpcgHJV+eK2em6aNZzBOet0D8aNBJvOccDc2mf9Nx6XirpH3r x/fpBMqAyyyNJ6lwzgIMx2cn+OD592L2gakHb7v6JBVsarD2lZcvaaZJerKA1VZp LPFSvKZzKjC50zPiz3V8rC1ItuRR3BgnF7D5vKW1i5+qTEXrK0oNG58K80Id6Iq0 n7BA2tulRCgqtsQrwsbgWb21MwrEFxvZBloctU+zyF3YwKieWzBMTNw2Wje5uKiL 9PF4NAv9bZ/jvXmkXvtv1yU+d0gM7BlR0aTimNlFX2IWjxdhwR4e3evTygJxaWr/ XZa0zfVCUh8AYkZJr9JNrRkVgkgysbXxeOzve3D8aD3BNijopbpyGL0d0JZwvoXk JT731BxxEHSh8L52NTscuqslHVN27KvllZ/iGV9sbSMcHRdE45kHtzCTi3YEjc2s cqzefZlL85TB5jnoyxjERG/5gYmEjy9L9v3Dw6HK8FAZ0evkXzPOD/xZkwM7bo0h iK4E/faagrOur1kuV5edu0J8ZEabUZzDv3fjx6nJEnN/ObgLL8cAewfP7FDsR7rn KiD8v0Fsi8aUrBmJ8Gh7vZyFlhGxjrZ3Ne7U3PfwN5tMoisdHls= =y8du -----END PGP SIGNATURE----- Merge remote-tracking branch 'remotes/jsnow-gitlab/tags/python-pull-request' into staging Python patches New functionality in qmp-shell from Dan, and some packaging fixes. # gpg: Signature made Wed 23 Feb 2022 22:08:35 GMT # gpg: using RSA key F9B7ABDBBCACDF95BE76CBD07DEF8106AAFC390E # gpg: Good signature from "John Snow (John Huston) <jsnow@redhat.com>" [full] # Primary key fingerprint: FAEB 9711 A12C F475 812F 18F2 88A9 064D 1835 61EB # Subkey fingerprint: F9B7 ABDB BCAC DF95 BE76 CBD0 7DEF 8106 AAFC 390E * remotes/jsnow-gitlab/tags/python-pull-request: MAINTAINERS: python - remove ehabkost and add bleal Revert "python: pin setuptools below v60.0.0" Python: add setuptools v60.0 workaround Python: discourage direct setup.py install python: support recording QMP session to a file python: introduce qmp-shell-wrap convenience tool Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
2022-02-24 12:48:14 +00:00 · 2022-02-24 12:48:14 +00:00 · fa435db8ce
commit fa435db8ce
parent 4aa2e497a9 89d38c74f4
8 changed files with 118 additions and 15 deletions
--- a/4
+++ b/4
@ -2747,13 +2747,13 @@ F: backends/cryptodev*.c
 Python library
 M: John Snow <jsnow@redhat.com>
 M: Cleber Rosa <crosa@redhat.com>
-R: Eduardo Habkost <eduardo@habkost.net>
+R: Beraldo Leal <bleal@redhat.com>
 S: Maintained
 F: python/
 T: git https://gitlab.com/jsnow/qemu.git python

 Python scripts
-M: Eduardo Habkost <eduardo@habkost.net>
+M: John Snow <jsnow@redhat.com>
 M: Cleber Rosa <crosa@redhat.com>
 S: Odd Fixes
 F: scripts/*.py
--- a/python/Makefile
+++ b/python/Makefile
@ -68,8 +68,6 @@ $(QEMU_VENV_DIR) $(QEMU_VENV_DIR)/bin/activate: setup.cfg
 		echo "ACTIVATE $(QEMU_VENV_DIR)";		\
 		. $(QEMU_VENV_DIR)/bin/activate;		\
 		echo "INSTALL qemu[devel] $(QEMU_VENV_DIR)";	\
-		pip install --disable-pip-version-check		\
-			"setuptools<60.0.0" 1>/dev/null;	\
 		make develop 1>/dev/null;			\
 	)
 	@touch $(QEMU_VENV_DIR)
--- a/python/qemu/aqmp/qmp_shell.py
+++ b/python/qemu/aqmp/qmp_shell.py
@ -86,8 +86,10 @@ import logging
 import os
 import re
 import readline
+from subprocess import Popen
 import sys
 from typing import (
+    IO,
    Iterator,
    List,
    NoReturn,
@ -167,8 +169,11 @@ class QMPShell(QEMUMonitorProtocol):
    :param verbose: Echo outgoing QMP messages to console.
    """
    def __init__(self, address: SocketAddrT,
-                 pretty: bool = False, verbose: bool = False):
-        super().__init__(address)
+                 pretty: bool = False,
+                 verbose: bool = False,
+                 server: bool = False,
+                 logfile: Optional[str] = None):
+        super().__init__(address, server=server)
        self._greeting: Optional[QMPMessage] = None
        self._completer = QMPCompleter()
        self._transmode = False
@ -177,6 +182,10 @@ class QMPShell(QEMUMonitorProtocol):
                                      '.qmp-shell_history')
        self.pretty = pretty
        self.verbose = verbose
+        self.logfile = None
+
+        if logfile is not None:
+            self.logfile = open(logfile, "w", encoding='utf-8')

    def close(self) -> None:
        # Hook into context manager of parent to save shell history.
@ -317,11 +326,11 @@ class QMPShell(QEMUMonitorProtocol):
        self._cli_expr(cmdargs[1:], qmpcmd['arguments'])
        return qmpcmd

-    def _print(self, qmp_message: object) -> None:
+    def _print(self, qmp_message: object, fh: IO[str] = sys.stdout) -> None:
        jsobj = json.dumps(qmp_message,
                           indent=4 if self.pretty else None,
                           sort_keys=self.pretty)
-        print(str(jsobj))
+        print(str(jsobj), file=fh)

    def _execute_cmd(self, cmdline: str) -> bool:
        try:
@ -344,6 +353,9 @@ class QMPShell(QEMUMonitorProtocol):
            print('Disconnected')
            return False
        self._print(resp)
+        if self.logfile is not None:
+            cmd = {**qmpcmd, **resp}
+            self._print(cmd, fh=self.logfile)
        return True

    def connect(self, negotiate: bool = True) -> None:
@ -409,8 +421,11 @@ class HMPShell(QMPShell):
    :param verbose: Echo outgoing QMP messages to console.
    """
    def __init__(self, address: SocketAddrT,
-                 pretty: bool = False, verbose: bool = False):
-        super().__init__(address, pretty, verbose)
+                 pretty: bool = False,
+                 verbose: bool = False,
+                 server: bool = False,
+                 logfile: Optional[str] = None):
+        super().__init__(address, pretty, verbose, server, logfile)
        self._cpu_index = 0

    def _cmd_completion(self) -> None:
@ -503,6 +518,8 @@ def main() -> None:
                        help='Verbose (echo commands sent and received)')
    parser.add_argument('-p', '--pretty', action='store_true',
                        help='Pretty-print JSON')
+    parser.add_argument('-l', '--logfile',
+                        help='Save log of all QMP messages to PATH')

    default_server = os.environ.get('QMP_SOCKET')
    parser.add_argument('qmp_server', action='store',
@ -521,7 +538,7 @@ def main() -> None:
        parser.error(f"Bad port number: {args.qmp_server}")
        return  # pycharm doesn't know error() is noreturn

-    with shell_class(address, args.pretty, args.verbose) as qemu:
+    with shell_class(address, args.pretty, args.verbose, args.logfile) as qemu:
        try:
            qemu.connect(negotiate=not args.skip_negotiation)
        except ConnectError as err:
@ -533,5 +550,60 @@ def main() -> None:
            pass


+def main_wrap() -> None:
+    """
+    qmp-shell-wrap entry point: parse command line arguments and
+    start the REPL.
+    """
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-H', '--hmp', action='store_true',
+                        help='Use HMP interface')
+    parser.add_argument('-v', '--verbose', action='store_true',
+                        help='Verbose (echo commands sent and received)')
+    parser.add_argument('-p', '--pretty', action='store_true',
+                        help='Pretty-print JSON')
+    parser.add_argument('-l', '--logfile',
+                        help='Save log of all QMP messages to PATH')
+
+    parser.add_argument('command', nargs=argparse.REMAINDER,
+                        help='QEMU command line to invoke')
+
+    args = parser.parse_args()
+
+    cmd = args.command
+    if len(cmd) != 0 and cmd[0] == '--':
+        cmd = cmd[1:]
+    if len(cmd) == 0:
+        cmd = ["qemu-system-x86_64"]
+
+    sockpath = "qmp-shell-wrap-%d" % os.getpid()
+    cmd += ["-qmp", "unix:%s" % sockpath]
+
+    shell_class = HMPShell if args.hmp else QMPShell
+
+    try:
+        address = shell_class.parse_address(sockpath)
+    except QMPBadPortError:
+        parser.error(f"Bad port number: {sockpath}")
+        return  # pycharm doesn't know error() is noreturn
+
+    try:
+        with shell_class(address, args.pretty, args.verbose,
+                         True, args.logfile) as qemu:
+            with Popen(cmd):
+
+                try:
+                    qemu.accept()
+                except ConnectError as err:
+                    if isinstance(err.exc, OSError):
+                        die(f"Couldn't connect to {args.qmp_server}: {err!s}")
+                    die(str(err))
+
+                for _ in qemu.repl():
+                    pass
+    finally:
+        os.unlink(sockpath)
+
+
 if __name__ == '__main__':
    main()
--- a/python/setup.cfg
+++ b/python/setup.cfg
@ -68,6 +68,7 @@ console_scripts =
    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]

 [flake8]
@ -113,7 +114,10 @@ ignore_missing_imports = True
 # no Warning level messages displayed, use "--disable=all --enable=classes
 # --disable=W".
 disable=consider-using-f-string,
+        consider-using-with,
+        too-many-arguments,
        too-many-function-args,  # mypy handles this with less false positives.
+        too-many-instance-attributes,
        no-member,  # mypy also handles this better.

 [pylint.basic]
@ -163,7 +167,6 @@ deps =
    .[devel]
    .[fuse]  # Workaround to trigger tox venv rebuild
    .[tui]   # Workaround to trigger tox venv rebuild
-    setuptools < 60  # Workaround, please see commit msg.
 commands =
    make check

--- a/python/setup.py
+++ b/python/setup.py
@ -5,9 +5,26 @@ Copyright (c) 2020-2021 John Snow for Red Hat, Inc.
 """

 import setuptools
+from setuptools.command import bdist_egg
+import sys
 import pkg_resources


+class bdist_egg_guard(bdist_egg.bdist_egg):
+    """
+    Protect against bdist_egg from being executed
+
+    This prevents calling 'setup.py install' directly, as the 'install'
+    CLI option will invoke the deprecated bdist_egg hook. "pip install"
+    calls the more modern bdist_wheel hook, which is what we want.
+    """
+    def run(self):
+        sys.exit(
+            'Installation directly via setup.py is not supported.\n'
+            'Please use `pip install .` instead.'
+        )
+
+
 def main():
    """
    QEMU tooling installer
@ -16,7 +33,7 @@ def main():
    # https://medium.com/@daveshawley/safely-using-setup-cfg-for-metadata-1babbe54c108
    pkg_resources.require('setuptools>=39.2')

-    setuptools.setup()
+    setuptools.setup(cmdclass={'bdist_egg': bdist_egg_guard})


 if __name__ == '__main__':
--- a/python/tests/iotests-pylint.sh
+++ b/python/tests/iotests-pylint.sh
@ -1,4 +1,5 @@
 #!/bin/sh -e

 cd ../tests/qemu-iotests/
-python3 -m linters --pylint
+# See commit message for environment variable explainer.
+SETUPTOOLS_USE_DISTUTILS=stdlib python3 -m linters --pylint
--- a/python/tests/pylint.sh
+++ b/python/tests/pylint.sh
@ -1,2 +1,3 @@
 #!/bin/sh -e
-python3 -m pylint qemu/
+# See commit message for environment variable explainer.
+SETUPTOOLS_USE_DISTUTILS=stdlib python3 -m pylint qemu/
--- a/scripts/qmp/qmp-shell-wrap
+++ b/scripts/qmp/qmp-shell-wrap
@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+
+import os
+import sys
+
+sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
+from qemu.qmp import qmp_shell
+
+
+if __name__ == '__main__':
+    qmp_shell.main_wrap()