* [PULL 01/72] python/pipenv: Update Pipfile.lock
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 02/72] python/qmp: Fix type of SocketAddrT John Snow
` (71 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
In a previous commit, I added tox to the development requirements of the
Python library. I never bothered to add them to the Pipfile, because
they aren't needed there. Here, I sync it anyway in its own commit so
that when we add new packages later that the diffstats will not
confusingly appear to pull in lots of extra packages.
Ideally I could tell Pipenv simply not to install these, but it doesn't
seem to support that, exactly. The alternative is removing Tox from the
development requires, which I'd rather not do.
The other alternative is re-specifying all of the dependencies of
setup.cfg in the Pipfile, which I'd also rather not do.
Picking what feels least-worst here.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210603003719.1321369-2-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/Pipfile.lock | 91 +++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 88 insertions(+), 3 deletions(-)
diff --git a/python/Pipfile.lock b/python/Pipfile.lock
index 6e344f5fad..f2a3f91d0f 100644
--- a/python/Pipfile.lock
+++ b/python/Pipfile.lock
@@ -22,6 +22,13 @@
}
},
"develop": {
+ "appdirs": {
+ "hashes": [
+ "sha256:7d5d0167b2b1ba821647616af46a749d1c653740dd0d2415100fe26e27afdf41",
+ "sha256:a841dacd6b99318a741b166adb07e19ee71a274450e68237b4650ca1055ab128"
+ ],
+ "version": "==1.4.4"
+ },
"astroid": {
"hashes": [
"sha256:4db03ab5fc3340cf619dbc25e42c2cc3755154ce6009469766d7143d1fc2ee4e",
@@ -38,6 +45,20 @@
"markers": "python_version >= '3.6'",
"version": "==88.1"
},
+ "distlib": {
+ "hashes": [
+ "sha256:106fef6dc37dd8c0e2c0a60d3fca3e77460a48907f335fa28420463a6f799736",
+ "sha256:23e223426b28491b1ced97dc3bbe183027419dfc7982b4fa2f05d5f3ff10711c"
+ ],
+ "version": "==0.3.2"
+ },
+ "filelock": {
+ "hashes": [
+ "sha256:18d82244ee114f543149c66a6e0c14e9c4f8a1044b5cdaadd0f82159d6a6ff59",
+ "sha256:929b7d63ec5b7d6b71b0fa5ac14e030b3f70b75747cef1b10da9b879fef15836"
+ ],
+ "version": "==3.0.12"
+ },
"flake8": {
"hashes": [
"sha256:07528381786f2a6237b061f6e96610a4167b226cb926e2aa2b6b1d78057c576b",
@@ -54,6 +75,14 @@
"markers": "python_version < '3.8'",
"version": "==4.0.1"
},
+ "importlib-resources": {
+ "hashes": [
+ "sha256:54161657e8ffc76596c4ede7080ca68cb02962a2e074a2586b695a93a925d36e",
+ "sha256:e962bff7440364183203d179d7ae9ad90cb1f2b74dcb84300e88ecc42dca3351"
+ ],
+ "markers": "python_version < '3.7'",
+ "version": "==5.1.4"
+ },
"isort": {
"hashes": [
"sha256:0a943902919f65c5684ac4e0154b1ad4fac6dcaa5d9f3426b732f1c8b5419be6",
@@ -132,6 +161,30 @@
],
"version": "==0.4.3"
},
+ "packaging": {
+ "hashes": [
+ "sha256:5b327ac1320dc863dca72f4514ecc086f31186744b84a230374cc1fd776feae5",
+ "sha256:67714da7f7bc052e064859c05c595155bd1ee9f69f76557e21f051443c20947a"
+ ],
+ "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'",
+ "version": "==20.9"
+ },
+ "pluggy": {
+ "hashes": [
+ "sha256:15b2acde666561e1298d71b523007ed7364de07029219b604cf808bfa1c765b0",
+ "sha256:966c145cd83c96502c3c3868f50408687b38434af77734af1e9ca461a4081d2d"
+ ],
+ "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'",
+ "version": "==0.13.1"
+ },
+ "py": {
+ "hashes": [
+ "sha256:21b81bda15b66ef5e1a777a21c4dcd9c20ad3efd0b3f817e7a809035269e1bd3",
+ "sha256:3b80836aa6d1feeaa108e046da6423ab8f6ceda6468545ae8d02d9d58d18818a"
+ ],
+ "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'",
+ "version": "==1.10.0"
+ },
"pycodestyle": {
"hashes": [
"sha256:514f76d918fcc0b55c6680472f0a37970994e07bbb80725808c17089be302068",
@@ -156,18 +209,42 @@
"markers": "python_version ~= '3.6'",
"version": "==2.8.2"
},
+ "pyparsing": {
+ "hashes": [
+ "sha256:c203ec8783bf771a155b207279b9bccb8dea02d8f0c9e5f8ead507bc3246ecc1",
+ "sha256:ef9d7589ef3c200abe66653d3f1ab1033c3c419ae9b9bdb1240a85b024efc88b"
+ ],
+ "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'",
+ "version": "==2.4.7"
+ },
"qemu": {
"editable": true,
"path": "."
},
+ "six": {
+ "hashes": [
+ "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926",
+ "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"
+ ],
+ "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'",
+ "version": "==1.16.0"
+ },
"toml": {
"hashes": [
"sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b",
"sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f"
],
- "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2'",
+ "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'",
"version": "==0.10.2"
},
+ "tox": {
+ "hashes": [
+ "sha256:307a81ddb82bd463971a273f33e9533a24ed22185f27db8ce3386bff27d324e3",
+ "sha256:b0b5818049a1c1997599d42012a637a33f24c62ab8187223fdd318fa8522637b"
+ ],
+ "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'",
+ "version": "==3.23.1"
+ },
"typed-ast": {
"hashes": [
"sha256:01ae5f73431d21eead5015997ab41afa53aa1fbe252f9da060be5dad2c730ace",
@@ -201,7 +278,7 @@
"sha256:f8afcf15cc511ada719a88e013cec87c11aff7b91f019295eb4530f96fe5ef2f",
"sha256:fb1bbeac803adea29cedd70781399c99138358c26d05fcbd23c13016b7f5ec65"
],
- "markers": "implementation_name == 'cpython' and python_version < '3.8'",
+ "markers": "python_version < '3.8' and implementation_name == 'cpython'",
"version": "==1.4.3"
},
"typing-extensions": {
@@ -213,6 +290,14 @@
"markers": "python_version < '3.8'",
"version": "==3.10.0.0"
},
+ "virtualenv": {
+ "hashes": [
+ "sha256:14fdf849f80dbb29a4eb6caa9875d476ee2a5cf76a5f5415fa2f1606010ab467",
+ "sha256:2b0126166ea7c9c3661f5b8e06773d28f83322de7a3ff7d06f0aed18c9de6a76"
+ ],
+ "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'",
+ "version": "==20.4.7"
+ },
"wrapt": {
"hashes": [
"sha256:b62ffa81fb85f4332a4f609cab4ac40709470da05643a082ec1eb88e6d9b97d7"
@@ -224,7 +309,7 @@
"sha256:3607921face881ba3e026887d8150cca609d517579abe052ac81fc5aeffdbd76",
"sha256:51cb66cc54621609dd593d1787f286ee42a5c0adbb4b29abea5a63edc3e03098"
],
- "markers": "python_version >= '3.6'",
+ "markers": "python_version < '3.10'",
"version": "==3.4.1"
}
}
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 02/72] python/qmp: Fix type of SocketAddrT
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
2021-06-18 23:03 ` [PULL 01/72] python/pipenv: Update Pipfile.lock John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 03/72] python/qmp: add parse_address classmethod John Snow
` (70 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Eduardo Habkost, John Snow, Markus Armbruster,
Cleber Rosa, Philippe Mathieu-Daudé
In porting the qom tools, qmp-shell, etc; it becomes evident that this
type is wrong.
This is an integer, not a string. We didn't catch this before because
none of QEMUMonitorProtocol's *users* happen to be checked, and the
internal logic of this class is otherwise self-consistent. Additionally,
mypy was not introspecting into the socket() interface to realize we
were passing a bad type for AF_INET. Fixed now.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-id: 20210603003719.1321369-3-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/qmp/__init__.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/python/qemu/qmp/__init__.py b/python/qemu/qmp/__init__.py
index 9606248a3d..5fb970f8a8 100644
--- a/python/qemu/qmp/__init__.py
+++ b/python/qemu/qmp/__init__.py
@@ -44,7 +44,7 @@
QMPMessage = Dict[str, Any]
QMPReturnValue = Dict[str, Any]
-InternetAddrT = Tuple[str, str]
+InternetAddrT = Tuple[str, int]
UnixAddrT = str
SocketAddrT = Union[InternetAddrT, UnixAddrT]
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 03/72] python/qmp: add parse_address classmethod
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
2021-06-18 23:03 ` [PULL 01/72] python/pipenv: Update Pipfile.lock John Snow
2021-06-18 23:03 ` [PULL 02/72] python/qmp: Fix type of SocketAddrT John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 04/72] python/qmp: Add qom script rewrites John Snow
` (69 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
This takes the place of qmp-shell's __get_address function. It also
allows other utilities to share the same parser and syntax for
specifying QMP locations.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210603003719.1321369-4-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/qmp/__init__.py | 26 ++++++++++++++++++++++++++
scripts/qmp/qmp-shell | 21 ++-------------------
2 files changed, 28 insertions(+), 19 deletions(-)
diff --git a/python/qemu/qmp/__init__.py b/python/qemu/qmp/__init__.py
index 5fb970f8a8..822c793c32 100644
--- a/python/qemu/qmp/__init__.py
+++ b/python/qemu/qmp/__init__.py
@@ -92,6 +92,12 @@ 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
@@ -219,6 +225,26 @@ 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.
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index b4d06096ab..d5ae8a9b21 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -89,8 +89,6 @@ class QMPCompleter(list):
class QMPShellError(Exception):
pass
-class QMPShellBadPort(QMPShellError):
- pass
class FuzzyJSON(ast.NodeTransformer):
'''This extension of ast.NodeTransformer filters literal "true/false/null"
@@ -109,7 +107,7 @@ class FuzzyJSON(ast.NodeTransformer):
# _execute_cmd()). Let's design a better one.
class QMPShell(qmp.QEMUMonitorProtocol):
def __init__(self, address, pretty=False):
- super(QMPShell, self).__init__(self.__get_address(address))
+ super(QMPShell, self).__init__(self.parse_address(address))
self._greeting = None
self._completer = None
self._pretty = pretty
@@ -118,21 +116,6 @@ class QMPShell(qmp.QEMUMonitorProtocol):
self._histfile = os.path.join(os.path.expanduser('~'),
'.qmp-shell_history')
- def __get_address(self, arg):
- """
- Figure out if the argument is in the port:host form, if it's not it's
- probably a file path.
- """
- addr = arg.split(':')
- if len(addr) == 2:
- try:
- port = int(addr[1])
- except ValueError:
- raise QMPShellBadPort
- return ( addr[0], port )
- # socket path
- return arg
-
def _fill_completion(self):
cmds = self.cmd('query-commands')
if 'error' in cmds:
@@ -437,7 +420,7 @@ def main():
if qemu is None:
fail_cmdline()
- except QMPShellBadPort:
+ except qmp.QMPBadPortError:
die('bad port number in command-line')
try:
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 04/72] python/qmp: Add qom script rewrites
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (2 preceding siblings ...)
2021-06-18 23:03 ` [PULL 03/72] python/qmp: add parse_address classmethod John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 05/72] python/qmp: add qom script entry points John Snow
` (68 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Inspired by qom-set, qom-get, qom-tree and qom-list; combine all four of
those scripts into a single script.
A later addition of qom-fuse as an 'extension' necessitates that some
common features are split out and shared between them.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210603003719.1321369-5-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/qmp/qom.py | 262 ++++++++++++++++++++++++++++++++++
python/qemu/qmp/qom_common.py | 178 +++++++++++++++++++++++
2 files changed, 440 insertions(+)
create mode 100644 python/qemu/qmp/qom.py
create mode 100644 python/qemu/qmp/qom_common.py
diff --git a/python/qemu/qmp/qom.py b/python/qemu/qmp/qom.py
new file mode 100644
index 0000000000..7fe1448b5d
--- /dev/null
+++ b/python/qemu/qmp/qom.py
@@ -0,0 +1,262 @@
+"""
+QEMU Object Model testing tools.
+
+usage: qom [-h] {set,get,list,tree} ...
+
+Query and manipulate QOM data
+
+optional arguments:
+ -h, --help show this help message and exit
+
+QOM commands:
+ {set,get,list,tree}
+ set Set a QOM property value
+ get Get a QOM property value
+ list List QOM properties at a given path
+ tree Show QOM tree from a given path
+"""
+##
+# Copyright John Snow 2020, for Red Hat, Inc.
+# Copyright IBM, Corp. 2011
+#
+# Authors:
+# John Snow <jsnow@redhat.com>
+# Anthony Liguori <aliguori@amazon.com>
+#
+# This work is licensed under the terms of the GNU GPL, version 2 or later.
+# See the COPYING file in the top-level directory.
+#
+# Based on ./scripts/qmp/qom-[set|get|tree|list]
+##
+
+import argparse
+
+from . import QMPResponseError
+from .qom_common import QOMCommand
+
+
+class QOMSet(QOMCommand):
+ """
+ QOM Command - Set a property to a given value.
+
+ usage: qom-set [-h] [--socket SOCKET] <path>.<property> <value>
+
+ Set a QOM property value
+
+ positional arguments:
+ <path>.<property> QOM path and property, separated by a period '.'
+ <value> new QOM property value
+
+ optional arguments:
+ -h, --help show this help message and exit
+ --socket SOCKET, -s SOCKET
+ QMP socket path or address (addr:port). May also be
+ set via QMP_SOCKET environment variable.
+ """
+ name = 'set'
+ help = 'Set a QOM property value'
+
+ @classmethod
+ def configure_parser(cls, parser: argparse.ArgumentParser) -> None:
+ super().configure_parser(parser)
+ cls.add_path_prop_arg(parser)
+ parser.add_argument(
+ 'value',
+ metavar='<value>',
+ action='store',
+ help='new QOM property value'
+ )
+
+ def __init__(self, args: argparse.Namespace):
+ super().__init__(args)
+ self.path, self.prop = args.path_prop.rsplit('.', 1)
+ self.value = args.value
+
+ def run(self) -> int:
+ rsp = self.qmp.command(
+ 'qom-set',
+ path=self.path,
+ property=self.prop,
+ value=self.value
+ )
+ print(rsp)
+ return 0
+
+
+class QOMGet(QOMCommand):
+ """
+ QOM Command - Get a property's current value.
+
+ usage: qom-get [-h] [--socket SOCKET] <path>.<property>
+
+ Get a QOM property value
+
+ positional arguments:
+ <path>.<property> QOM path and property, separated by a period '.'
+
+ optional arguments:
+ -h, --help show this help message and exit
+ --socket SOCKET, -s SOCKET
+ QMP socket path or address (addr:port). May also be
+ set via QMP_SOCKET environment variable.
+ """
+ name = 'get'
+ help = 'Get a QOM property value'
+
+ @classmethod
+ def configure_parser(cls, parser: argparse.ArgumentParser) -> None:
+ super().configure_parser(parser)
+ cls.add_path_prop_arg(parser)
+
+ def __init__(self, args: argparse.Namespace):
+ super().__init__(args)
+ try:
+ tmp = args.path_prop.rsplit('.', 1)
+ except ValueError as err:
+ raise ValueError('Invalid format for <path>.<property>') from err
+ self.path = tmp[0]
+ self.prop = tmp[1]
+
+ def run(self) -> int:
+ rsp = self.qmp.command(
+ 'qom-get',
+ path=self.path,
+ property=self.prop
+ )
+ if isinstance(rsp, dict):
+ for key, value in rsp.items():
+ print(f"{key}: {value}")
+ else:
+ print(rsp)
+ return 0
+
+
+class QOMList(QOMCommand):
+ """
+ QOM Command - List the properties at a given path.
+
+ usage: qom-list [-h] [--socket SOCKET] <path>
+
+ List QOM properties at a given path
+
+ positional arguments:
+ <path> QOM path
+
+ optional arguments:
+ -h, --help show this help message and exit
+ --socket SOCKET, -s SOCKET
+ QMP socket path or address (addr:port). May also be
+ set via QMP_SOCKET environment variable.
+ """
+ name = 'list'
+ help = 'List QOM properties at a given path'
+
+ @classmethod
+ def configure_parser(cls, parser: argparse.ArgumentParser) -> None:
+ super().configure_parser(parser)
+ parser.add_argument(
+ 'path',
+ metavar='<path>',
+ action='store',
+ help='QOM path',
+ )
+
+ def __init__(self, args: argparse.Namespace):
+ super().__init__(args)
+ self.path = args.path
+
+ def run(self) -> int:
+ rsp = self.qom_list(self.path)
+ for item in rsp:
+ if item.child:
+ print(f"{item.name}/")
+ elif item.link:
+ print(f"@{item.name}/")
+ else:
+ print(item.name)
+ return 0
+
+
+class QOMTree(QOMCommand):
+ """
+ QOM Command - Show the full tree below a given path.
+
+ usage: qom-tree [-h] [--socket SOCKET] [<path>]
+
+ Show QOM tree from a given path
+
+ positional arguments:
+ <path> QOM path
+
+ optional arguments:
+ -h, --help show this help message and exit
+ --socket SOCKET, -s SOCKET
+ QMP socket path or address (addr:port). May also be
+ set via QMP_SOCKET environment variable.
+ """
+ name = 'tree'
+ help = 'Show QOM tree from a given path'
+
+ @classmethod
+ def configure_parser(cls, parser: argparse.ArgumentParser) -> None:
+ super().configure_parser(parser)
+ parser.add_argument(
+ 'path',
+ metavar='<path>',
+ action='store',
+ help='QOM path',
+ nargs='?',
+ default='/'
+ )
+
+ def __init__(self, args: argparse.Namespace):
+ super().__init__(args)
+ self.path = args.path
+
+ def _list_node(self, path: str) -> None:
+ print(path)
+ items = self.qom_list(path)
+ for item in items:
+ if item.child:
+ continue
+ try:
+ rsp = self.qmp.command('qom-get', path=path,
+ property=item.name)
+ print(f" {item.name}: {rsp} ({item.type})")
+ except QMPResponseError as err:
+ print(f" {item.name}: <EXCEPTION: {err!s}> ({item.type})")
+ print('')
+ for item in items:
+ if not item.child:
+ continue
+ if path == '/':
+ path = ''
+ self._list_node(f"{path}/{item.name}")
+
+ def run(self) -> int:
+ self._list_node(self.path)
+ return 0
+
+
+def main() -> int:
+ """QOM script main entry point."""
+ parser = argparse.ArgumentParser(
+ description='Query and manipulate QOM data'
+ )
+ subparsers = parser.add_subparsers(
+ title='QOM commands',
+ dest='command'
+ )
+
+ for command in QOMCommand.__subclasses__():
+ command.register(subparsers)
+
+ args = parser.parse_args()
+
+ if args.command is None:
+ parser.error('Command not specified.')
+ return 1
+
+ cmd_class = args.cmd_class
+ assert isinstance(cmd_class, type(QOMCommand))
+ return cmd_class.command_runner(args)
diff --git a/python/qemu/qmp/qom_common.py b/python/qemu/qmp/qom_common.py
new file mode 100644
index 0000000000..f82b16772d
--- /dev/null
+++ b/python/qemu/qmp/qom_common.py
@@ -0,0 +1,178 @@
+"""
+QOM Command abstractions.
+"""
+##
+# Copyright John Snow 2020, for Red Hat, Inc.
+# Copyright IBM, Corp. 2011
+#
+# Authors:
+# John Snow <jsnow@redhat.com>
+# Anthony Liguori <aliguori@amazon.com>
+#
+# This work is licensed under the terms of the GNU GPL, version 2 or later.
+# See the COPYING file in the top-level directory.
+#
+# Based on ./scripts/qmp/qom-[set|get|tree|list]
+##
+
+import argparse
+import os
+import sys
+from typing import (
+ Any,
+ Dict,
+ List,
+ Optional,
+ Type,
+ TypeVar,
+)
+
+from . import QEMUMonitorProtocol, QMPError
+
+
+# The following is needed only for a type alias.
+Subparsers = argparse._SubParsersAction # pylint: disable=protected-access
+
+
+class ObjectPropertyInfo:
+ """
+ Represents the return type from e.g. qom-list.
+ """
+ def __init__(self, name: str, type_: str,
+ description: Optional[str] = None,
+ default_value: Optional[object] = None):
+ self.name = name
+ self.type = type_
+ self.description = description
+ self.default_value = default_value
+
+ @classmethod
+ def make(cls, value: Dict[str, Any]) -> 'ObjectPropertyInfo':
+ """
+ Build an ObjectPropertyInfo from a Dict with an unknown shape.
+ """
+ assert value.keys() >= {'name', 'type'}
+ assert value.keys() <= {'name', 'type', 'description', 'default-value'}
+ return cls(value['name'], value['type'],
+ value.get('description'),
+ value.get('default-value'))
+
+ @property
+ def child(self) -> bool:
+ """Is this property a child property?"""
+ return self.type.startswith('child<')
+
+ @property
+ def link(self) -> bool:
+ """Is this property a link property?"""
+ return self.type.startswith('link<')
+
+
+CommandT = TypeVar('CommandT', bound='QOMCommand')
+
+
+class QOMCommand:
+ """
+ Represents a QOM sub-command.
+
+ :param args: Parsed arguments, as returned from parser.parse_args.
+ """
+ name: str
+ help: str
+
+ def __init__(self, args: argparse.Namespace):
+ if args.socket is None:
+ raise QMPError("No QMP socket path or address given")
+ self.qmp = QEMUMonitorProtocol(
+ QEMUMonitorProtocol.parse_address(args.socket)
+ )
+ self.qmp.connect()
+
+ @classmethod
+ def register(cls, subparsers: Subparsers) -> None:
+ """
+ Register this command with the argument parser.
+
+ :param subparsers: argparse subparsers object, from "add_subparsers".
+ """
+ subparser = subparsers.add_parser(cls.name, help=cls.help,
+ description=cls.help)
+ cls.configure_parser(subparser)
+
+ @classmethod
+ def configure_parser(cls, parser: argparse.ArgumentParser) -> None:
+ """
+ Configure a parser with this command's arguments.
+
+ :param parser: argparse parser or subparser object.
+ """
+ default_path = os.environ.get('QMP_SOCKET')
+ parser.add_argument(
+ '--socket', '-s',
+ dest='socket',
+ action='store',
+ help='QMP socket path or address (addr:port).'
+ ' May also be set via QMP_SOCKET environment variable.',
+ default=default_path
+ )
+ parser.set_defaults(cmd_class=cls)
+
+ @classmethod
+ def add_path_prop_arg(cls, parser: argparse.ArgumentParser) -> None:
+ """
+ Add the <path>.<proptery> positional argument to this command.
+
+ :param parser: The parser to add the argument to.
+ """
+ parser.add_argument(
+ 'path_prop',
+ metavar='<path>.<property>',
+ action='store',
+ help="QOM path and property, separated by a period '.'"
+ )
+
+ def run(self) -> int:
+ """
+ Run this command.
+
+ :return: 0 on success, 1 otherwise.
+ """
+ raise NotImplementedError
+
+ def qom_list(self, path: str) -> List[ObjectPropertyInfo]:
+ """
+ :return: a strongly typed list from the 'qom-list' command.
+ """
+ rsp = self.qmp.command('qom-list', path=path)
+ # qom-list returns List[ObjectPropertyInfo]
+ assert isinstance(rsp, list)
+ return [ObjectPropertyInfo.make(x) for x in rsp]
+
+ @classmethod
+ def command_runner(
+ cls: Type[CommandT],
+ args: argparse.Namespace
+ ) -> int:
+ """
+ Run a fully-parsed subcommand, with error-handling for the CLI.
+
+ :return: The return code from `.run()`.
+ """
+ try:
+ cmd = cls(args)
+ return cmd.run()
+ except QMPError as err:
+ print(f"{type(err).__name__}: {err!s}", file=sys.stderr)
+ return -1
+
+ @classmethod
+ def entry_point(cls) -> int:
+ """
+ Build this command's parser, parse arguments, and run the command.
+
+ :return: `run`'s return code.
+ """
+ parser = argparse.ArgumentParser(description=cls.help)
+ cls.configure_parser(parser)
+ args = parser.parse_args()
+ return cls.command_runner(args)
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 05/72] python/qmp: add qom script entry points
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (3 preceding siblings ...)
2021-06-18 23:03 ` [PULL 04/72] python/qmp: Add qom script rewrites John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 06/72] scripts/qmp: redirect qom-xxx scripts to python/qemu/qmp/ John Snow
` (67 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Eduardo Habkost, John Snow, Markus Armbruster,
Cleber Rosa, Philippe Mathieu-Daudé
Add the 'qom', 'qom-set', 'qom-get', 'qom-list', and 'qom-tree' scripts
to the qemu.qmp package. When you install this package, these scripts
will become available on your command line.
(e.g. when inside of a venv, `cd python && pip install .` will add
'qom', 'qom-set', etc to your $PATH.)
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-id: 20210603003719.1321369-6-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/setup.cfg | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/python/setup.cfg b/python/setup.cfg
index 0fcdec6f32..a19029d538 100644
--- a/python/setup.cfg
+++ b/python/setup.cfg
@@ -37,6 +37,14 @@ devel =
pylint >= 2.8.0
tox >= 3.18.0
+[options.entry_points]
+console_scripts =
+ qom = qemu.qmp.qom:main
+ qom-set = qemu.qmp.qom:QOMSet.entry_point
+ qom-get = qemu.qmp.qom:QOMGet.entry_point
+ qom-list = qemu.qmp.qom:QOMList.entry_point
+ qom-tree = qemu.qmp.qom:QOMTree.entry_point
+
[flake8]
extend-ignore = E722 # Prefer pylint's bare-except checks to flake8's
exclude = __pycache__,
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 06/72] scripts/qmp: redirect qom-xxx scripts to python/qemu/qmp/
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (4 preceding siblings ...)
2021-06-18 23:03 ` [PULL 05/72] python/qmp: add qom script entry points John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 07/72] scripts/qom-fuse: apply isort rules John Snow
` (66 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Eduardo Habkost, John Snow, Markus Armbruster,
Cleber Rosa, Philippe Mathieu-Daudé
Redirect to the new qom scripts. These forwarders can be deleted
eventually when there has been more time for the dust on the Python
packaging to settle and people understand how to find these commands.
Note: You can run these by setting $PYTHONPATH in your shell and then
running "python3 -m qemu.qmp.qom", or you can install the qemu namespace
package and use the "qom" or "qom-set" scripts.
I've written how to install the package elsewhere, but for the sake of
git-blame, cd to ./python, and then do:
- pip3 install [--user] [-e] .
--user will install to your local user install (will not work inside of
a venv), omitting this flag installs to your system-wide packages
(outside of a venv) or to your current virtual environment (inside the
venv).
When installing to a venv or to your system-wide packages, "qom"
should be in your $PATH already. If you do a user install, you may
need to add ~/.local/bin to your $PATH if you haven't already.
-e installs in editable mode: the installed package is effectively just
a symlink to this folder; so changes to your git working tree are
reflected in the installed package.
Note: installing these packages to an environment outside a venv can be
dangerous: Many QEMU scripts will begin to prefer the installed version
instead of the version directly in the tree. Use with caution. editable
mode is recommended when working outside of a venv.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-id: 20210603003719.1321369-7-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qom-get | 66 +++------------------------------------
scripts/qmp/qom-list | 63 +++----------------------------------
scripts/qmp/qom-set | 63 +++----------------------------------
scripts/qmp/qom-tree | 74 +++-----------------------------------------
4 files changed, 16 insertions(+), 250 deletions(-)
diff --git a/scripts/qmp/qom-get b/scripts/qmp/qom-get
index 666df71832..e4f3e0c013 100755
--- a/scripts/qmp/qom-get
+++ b/scripts/qmp/qom-get
@@ -1,69 +1,11 @@
#!/usr/bin/env python3
-##
-# QEMU Object Model test tools
-#
-# Copyright IBM, Corp. 2011
-#
-# Authors:
-# Anthony Liguori <aliguori@us.ibm.com>
-#
-# This work is licensed under the terms of the GNU GPL, version 2 or later. See
-# the COPYING file in the top-level directory.
-##
-import sys
import os
+import sys
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
-from qemu.qmp import QEMUMonitorProtocol
+from qemu.qmp.qom import QOMGet
-cmd, args = sys.argv[0], sys.argv[1:]
-socket_path = None
-path = None
-prop = None
-def usage():
- return '''environment variables:
- QMP_SOCKET=<path | addr:port>
-usage:
- %s [-h] [-s <QMP socket path | addr:port>] <path>.<property>
-''' % cmd
-
-def usage_error(error_msg = "unspecified error"):
- sys.stderr.write('%s\nERROR: %s\n' % (usage(), error_msg))
- exit(1)
-
-if len(args) > 0:
- if args[0] == "-h":
- print(usage())
- exit(0);
- elif args[0] == "-s":
- try:
- socket_path = args[1]
- except:
- usage_error("missing argument: QMP socket path or address");
- args = args[2:]
-
-if not socket_path:
- if 'QMP_SOCKET' in os.environ:
- socket_path = os.environ['QMP_SOCKET']
- else:
- usage_error("no QMP socket path or address given");
-
-if len(args) > 0:
- try:
- path, prop = args[0].rsplit('.', 1)
- except:
- usage_error("invalid format for path/property/value")
-else:
- usage_error("not enough arguments")
-
-srv = QEMUMonitorProtocol(socket_path)
-srv.connect()
-
-rsp = srv.command('qom-get', path=path, property=prop)
-if type(rsp) == dict:
- for i in rsp.keys():
- print('%s: %s' % (i, rsp[i]))
-else:
- print(rsp)
+if __name__ == '__main__':
+ sys.exit(QOMGet.entry_point())
diff --git a/scripts/qmp/qom-list b/scripts/qmp/qom-list
index 5074fd939f..7a071a54e1 100755
--- a/scripts/qmp/qom-list
+++ b/scripts/qmp/qom-list
@@ -1,66 +1,11 @@
#!/usr/bin/env python3
-##
-# QEMU Object Model test tools
-#
-# Copyright IBM, Corp. 2011
-#
-# Authors:
-# Anthony Liguori <aliguori@us.ibm.com>
-#
-# This work is licensed under the terms of the GNU GPL, version 2 or later. See
-# the COPYING file in the top-level directory.
-##
-import sys
import os
+import sys
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
-from qemu.qmp import QEMUMonitorProtocol
+from qemu.qmp.qom import QOMList
-cmd, args = sys.argv[0], sys.argv[1:]
-socket_path = None
-path = None
-prop = None
-def usage():
- return '''environment variables:
- QMP_SOCKET=<path | addr:port>
-usage:
- %s [-h] [-s <QMP socket path | addr:port>] [<path>]
-''' % cmd
-
-def usage_error(error_msg = "unspecified error"):
- sys.stderr.write('%s\nERROR: %s\n' % (usage(), error_msg))
- exit(1)
-
-if len(args) > 0:
- if args[0] == "-h":
- print(usage())
- exit(0);
- elif args[0] == "-s":
- try:
- socket_path = args[1]
- except:
- usage_error("missing argument: QMP socket path or address");
- args = args[2:]
-
-if not socket_path:
- if 'QMP_SOCKET' in os.environ:
- socket_path = os.environ['QMP_SOCKET']
- else:
- usage_error("no QMP socket path or address given");
-
-srv = QEMUMonitorProtocol(socket_path)
-srv.connect()
-
-if len(args) == 0:
- print('/')
- sys.exit(0)
-
-for item in srv.command('qom-list', path=args[0]):
- if item['type'].startswith('child<'):
- print('%s/' % item['name'])
- elif item['type'].startswith('link<'):
- print('@%s/' % item['name'])
- else:
- print('%s' % item['name'])
+if __name__ == '__main__':
+ sys.exit(QOMList.entry_point())
diff --git a/scripts/qmp/qom-set b/scripts/qmp/qom-set
index 240a78187f..9ca9e2ba10 100755
--- a/scripts/qmp/qom-set
+++ b/scripts/qmp/qom-set
@@ -1,66 +1,11 @@
#!/usr/bin/env python3
-##
-# QEMU Object Model test tools
-#
-# Copyright IBM, Corp. 2011
-#
-# Authors:
-# Anthony Liguori <aliguori@us.ibm.com>
-#
-# This work is licensed under the terms of the GNU GPL, version 2 or later. See
-# the COPYING file in the top-level directory.
-##
-import sys
import os
+import sys
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
-from qemu.qmp import QEMUMonitorProtocol
+from qemu.qmp.qom import QOMSet
-cmd, args = sys.argv[0], sys.argv[1:]
-socket_path = None
-path = None
-prop = None
-value = None
-def usage():
- return '''environment variables:
- QMP_SOCKET=<path | addr:port>
-usage:
- %s [-h] [-s <QMP socket path | addr:port>] <path>.<property> <value>
-''' % cmd
-
-def usage_error(error_msg = "unspecified error"):
- sys.stderr.write('%s\nERROR: %s\n' % (usage(), error_msg))
- exit(1)
-
-if len(args) > 0:
- if args[0] == "-h":
- print(usage())
- exit(0);
- elif args[0] == "-s":
- try:
- socket_path = args[1]
- except:
- usage_error("missing argument: QMP socket path or address");
- args = args[2:]
-
-if not socket_path:
- if 'QMP_SOCKET' in os.environ:
- socket_path = os.environ['QMP_SOCKET']
- else:
- usage_error("no QMP socket path or address given");
-
-if len(args) > 1:
- try:
- path, prop = args[0].rsplit('.', 1)
- except:
- usage_error("invalid format for path/property/value")
- value = args[1]
-else:
- usage_error("not enough arguments")
-
-srv = QEMUMonitorProtocol(socket_path)
-srv.connect()
-
-print(srv.command('qom-set', path=path, property=prop, value=value))
+if __name__ == '__main__':
+ sys.exit(QOMSet.entry_point())
diff --git a/scripts/qmp/qom-tree b/scripts/qmp/qom-tree
index 25b0781323..7d0ccca3a4 100755
--- a/scripts/qmp/qom-tree
+++ b/scripts/qmp/qom-tree
@@ -1,77 +1,11 @@
#!/usr/bin/env python3
-##
-# QEMU Object Model test tools
-#
-# Copyright IBM, Corp. 2011
-# Copyright (c) 2013 SUSE LINUX Products GmbH
-#
-# Authors:
-# Anthony Liguori <aliguori@amazon.com>
-# Andreas Faerber <afaerber@suse.de>
-#
-# This work is licensed under the terms of the GNU GPL, version 2 or later. See
-# the COPYING file in the top-level directory.
-##
-import sys
import os
+import sys
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
-from qemu.qmp import QEMUMonitorProtocol
+from qemu.qmp.qom import QOMTree
-cmd, args = sys.argv[0], sys.argv[1:]
-socket_path = None
-path = None
-prop = None
-def usage():
- return '''environment variables:
- QMP_SOCKET=<path | addr:port>
-usage:
- %s [-h] [-s <QMP socket path | addr:port>] [<path>]
-''' % cmd
-
-def usage_error(error_msg = "unspecified error"):
- sys.stderr.write('%s\nERROR: %s\n' % (usage(), error_msg))
- exit(1)
-
-if len(args) > 0:
- if args[0] == "-h":
- print(usage())
- exit(0);
- elif args[0] == "-s":
- try:
- socket_path = args[1]
- except:
- usage_error("missing argument: QMP socket path or address");
- args = args[2:]
-
-if not socket_path:
- if 'QMP_SOCKET' in os.environ:
- socket_path = os.environ['QMP_SOCKET']
- else:
- usage_error("no QMP socket path or address given");
-
-srv = QEMUMonitorProtocol(socket_path)
-srv.connect()
-
-def list_node(path):
- print('%s' % path)
- items = srv.command('qom-list', path=path)
- for item in items:
- if not item['type'].startswith('child<'):
- try:
- print(' %s: %s (%s)' % (item['name'], srv.command('qom-get', path=path, property=item['name']), item['type']))
- except:
- print(' %s: <EXCEPTION> (%s)' % (item['name'], item['type']))
- print('')
- for item in items:
- if item['type'].startswith('child<'):
- list_node((path if (path != '/') else '') + '/' + item['name'])
-
-if len(args) == 0:
- path = '/'
-else:
- path = args[0]
-
-list_node(path)
+if __name__ == '__main__':
+ sys.exit(QOMTree.entry_point())
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 07/72] scripts/qom-fuse: apply isort rules
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (5 preceding siblings ...)
2021-06-18 23:03 ` [PULL 06/72] scripts/qmp: redirect qom-xxx scripts to python/qemu/qmp/ John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 08/72] scripts/qom-fuse: apply flake8 rules John Snow
` (65 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Eduardo Habkost, John Snow, Markus Armbruster,
Cleber Rosa, Philippe Mathieu-Daudé
Hint: you can use symlinks to create qom_fuse.py in python/qemu/qmp/ and
point to scripts/qom-fuse to apply the standard linting rules to this
script.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-id: 20210603003719.1321369-8-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qom-fuse | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/scripts/qmp/qom-fuse b/scripts/qmp/qom-fuse
index 7c7cff8edf..62deb9adb1 100755
--- a/scripts/qmp/qom-fuse
+++ b/scripts/qmp/qom-fuse
@@ -13,14 +13,20 @@
# the COPYING file in the top-level directory.
##
-import fuse, stat
-from fuse import FUSE, FuseOSError, Operations
-import os, posix, sys
from errno import *
+import os
+import posix
+import stat
+import sys
+
+import fuse
+from fuse import FUSE, FuseOSError, Operations
+
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
from qemu.qmp import QEMUMonitorProtocol
+
fuse.fuse_python_api = (0, 2)
class QOMFS(Operations):
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 08/72] scripts/qom-fuse: apply flake8 rules
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (6 preceding siblings ...)
2021-06-18 23:03 ` [PULL 07/72] scripts/qom-fuse: apply isort rules John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 09/72] python: Add 'fh' to known-good variable names John Snow
` (64 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Eduardo Habkost, John Snow, Markus Armbruster,
Cleber Rosa, Philippe Mathieu-Daudé
flake8 still has one warning because of the sys.path hack, but that will
be going away by the end of this patch series.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-id: 20210603003719.1321369-9-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qom-fuse | 81 +++++++++++++++++++++++---------------------
1 file changed, 43 insertions(+), 38 deletions(-)
diff --git a/scripts/qmp/qom-fuse b/scripts/qmp/qom-fuse
index 62deb9adb1..ca30e92867 100755
--- a/scripts/qmp/qom-fuse
+++ b/scripts/qmp/qom-fuse
@@ -9,13 +9,12 @@
# Anthony Liguori <aliguori@us.ibm.com>
# Markus Armbruster <armbru@redhat.com>
#
-# This work is licensed under the terms of the GNU GPL, version 2 or later. See
-# the COPYING file in the top-level directory.
+# This work is licensed under the terms of the GNU GPL, version 2 or later.
+# See the COPYING file in the top-level directory.
##
-from errno import *
+from errno import ENOENT, EPERM
import os
-import posix
import stat
import sys
@@ -29,6 +28,7 @@ from qemu.qmp import QEMUMonitorProtocol
fuse.fuse_python_api = (0, 2)
+
class QOMFS(Operations):
def __init__(self, qmp):
self.qmp = qmp
@@ -45,7 +45,7 @@ class QOMFS(Operations):
def is_object(self, path):
try:
- items = self.qmp.command('qom-list', path=path)
+ self.qmp.command('qom-list', path=path)
return True
except:
return False
@@ -85,7 +85,7 @@ class QOMFS(Operations):
path = '/'
try:
data = self.qmp.command('qom-get', path=path, property=prop)
- data += '\n' # make values shell friendly
+ data += '\n' # make values shell friendly
except:
raise FuseOSError(EPERM)
@@ -104,38 +104,44 @@ class QOMFS(Operations):
def getattr(self, path, fh=None):
if self.is_link(path):
- value = { 'st_mode': 0o755 | stat.S_IFLNK,
- 'st_ino': self.get_ino(path),
- 'st_dev': 0,
- 'st_nlink': 2,
- 'st_uid': 1000,
- 'st_gid': 1000,
- 'st_size': 4096,
- 'st_atime': 0,
- 'st_mtime': 0,
- 'st_ctime': 0 }
+ value = {
+ 'st_mode': 0o755 | stat.S_IFLNK,
+ 'st_ino': self.get_ino(path),
+ 'st_dev': 0,
+ 'st_nlink': 2,
+ 'st_uid': 1000,
+ 'st_gid': 1000,
+ 'st_size': 4096,
+ 'st_atime': 0,
+ 'st_mtime': 0,
+ 'st_ctime': 0
+ }
elif self.is_object(path):
- value = { 'st_mode': 0o755 | stat.S_IFDIR,
- 'st_ino': self.get_ino(path),
- 'st_dev': 0,
- 'st_nlink': 2,
- 'st_uid': 1000,
- 'st_gid': 1000,
- 'st_size': 4096,
- 'st_atime': 0,
- 'st_mtime': 0,
- 'st_ctime': 0 }
+ value = {
+ 'st_mode': 0o755 | stat.S_IFDIR,
+ 'st_ino': self.get_ino(path),
+ 'st_dev': 0,
+ 'st_nlink': 2,
+ 'st_uid': 1000,
+ 'st_gid': 1000,
+ 'st_size': 4096,
+ 'st_atime': 0,
+ 'st_mtime': 0,
+ 'st_ctime': 0
+ }
elif self.is_property(path):
- value = { 'st_mode': 0o644 | stat.S_IFREG,
- 'st_ino': self.get_ino(path),
- 'st_dev': 0,
- 'st_nlink': 1,
- 'st_uid': 1000,
- 'st_gid': 1000,
- 'st_size': 4096,
- 'st_atime': 0,
- 'st_mtime': 0,
- 'st_ctime': 0 }
+ value = {
+ 'st_mode': 0o644 | stat.S_IFREG,
+ 'st_ino': self.get_ino(path),
+ 'st_dev': 0,
+ 'st_nlink': 1,
+ 'st_uid': 1000,
+ 'st_gid': 1000,
+ 'st_size': 4096,
+ 'st_atime': 0,
+ 'st_mtime': 0,
+ 'st_ctime': 0
+ }
else:
raise FuseOSError(ENOENT)
return value
@@ -146,8 +152,7 @@ class QOMFS(Operations):
for item in self.qmp.command('qom-list', path=path):
yield str(item['name'])
+
if __name__ == '__main__':
- import os
-
fuse = FUSE(QOMFS(QEMUMonitorProtocol(os.environ['QMP_SOCKET'])),
sys.argv[1], foreground=True)
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 09/72] python: Add 'fh' to known-good variable names
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (7 preceding siblings ...)
2021-06-18 23:03 ` [PULL 08/72] scripts/qom-fuse: apply flake8 rules John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 10/72] scripts/qom-fuse: Apply pylint rules John Snow
` (63 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
fd and fh are fine: we often use these for "file descriptor" or "file
handle" accordingly. It is rarely the case that you need to enforce a
more semantically meaningful name beyond "This is the file we are using
right now."
While we're here: add comments for all of the non-standard pylint
names. (And the underscore.)
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210603003719.1321369-10-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/setup.cfg | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/python/setup.cfg b/python/setup.cfg
index a19029d538..c9b9445af9 100644
--- a/python/setup.cfg
+++ b/python/setup.cfg
@@ -78,9 +78,10 @@ good-names=i,
k,
ex,
Run,
- _,
- fd,
- c,
+ _, # By convention: Unused variable
+ fh, # fh = open(...)
+ fd, # fd = os.open(...)
+ c, # for c in string: ...
[pylint.similarities]
# Ignore imports when computing similarities.
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 10/72] scripts/qom-fuse: Apply pylint rules
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (8 preceding siblings ...)
2021-06-18 23:03 ` [PULL 09/72] python: Add 'fh' to known-good variable names John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 11/72] scripts/qom-fuse: Add docstrings John Snow
` (62 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Eduardo Habkost, John Snow, Markus Armbruster,
Cleber Rosa, Philippe Mathieu-Daudé
- Catch specific exceptions from QMP
- Reraise errors with explicit context
- method parameters should match parent's names
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-id: 20210603003719.1321369-11-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qom-fuse | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/scripts/qmp/qom-fuse b/scripts/qmp/qom-fuse
index ca30e92867..805e99c8ec 100755
--- a/scripts/qmp/qom-fuse
+++ b/scripts/qmp/qom-fuse
@@ -23,7 +23,7 @@ from fuse import FUSE, FuseOSError, Operations
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
-from qemu.qmp import QEMUMonitorProtocol
+from qemu.qmp import QEMUMonitorProtocol, QMPResponseError
fuse.fuse_python_api = (0, 2)
@@ -47,7 +47,7 @@ class QOMFS(Operations):
try:
self.qmp.command('qom-list', path=path)
return True
- except:
+ except QMPResponseError:
return False
def is_property(self, path):
@@ -59,7 +59,7 @@ class QOMFS(Operations):
if item['name'] == prop:
return True
return False
- except:
+ except QMPResponseError:
return False
def is_link(self, path):
@@ -73,10 +73,10 @@ class QOMFS(Operations):
return True
return False
return False
- except:
+ except QMPResponseError:
return False
- def read(self, path, length, offset, fh):
+ def read(self, path, size, offset, fh):
if not self.is_property(path):
return -ENOENT
@@ -86,13 +86,13 @@ class QOMFS(Operations):
try:
data = self.qmp.command('qom-get', path=path, property=prop)
data += '\n' # make values shell friendly
- except:
- raise FuseOSError(EPERM)
+ except QMPResponseError as err:
+ raise FuseOSError(EPERM) from err
if offset > len(data):
return ''
- return bytes(data[offset:][:length], encoding='utf-8')
+ return bytes(data[offset:][:size], encoding='utf-8')
def readlink(self, path):
if not self.is_link(path):
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 11/72] scripts/qom-fuse: Add docstrings
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (9 preceding siblings ...)
2021-06-18 23:03 ` [PULL 10/72] scripts/qom-fuse: Apply pylint rules John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 12/72] scripts/qom-fuse: Convert to QOMCommand John Snow
` (61 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
The methods inherited from fuse don't need docstrings; that's up to
fusepy to handle.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210603003719.1321369-12-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qom-fuse | 21 +++++++++++++++++++--
1 file changed, 19 insertions(+), 2 deletions(-)
diff --git a/scripts/qmp/qom-fuse b/scripts/qmp/qom-fuse
index 805e99c8ec..1fb3008a16 100755
--- a/scripts/qmp/qom-fuse
+++ b/scripts/qmp/qom-fuse
@@ -1,7 +1,19 @@
#!/usr/bin/env python3
+"""
+QEMU Object Model FUSE filesystem tool
+
+This script offers a simple FUSE filesystem within which the QOM tree
+may be browsed, queried and edited using traditional shell tooling.
+
+This script requires the 'fusepy' python package.
+
+ENV:
+ QMP_SOCKET: Path to the QMP server socket
+
+Usage:
+ qom-fuse /mount/to/here
+"""
##
-# QEMU Object Model test tools
-#
# Copyright IBM, Corp. 2012
# Copyright (C) 2020 Red Hat, Inc.
#
@@ -30,6 +42,7 @@ fuse.fuse_python_api = (0, 2)
class QOMFS(Operations):
+ """QOMFS implements fuse.Operations to provide a QOM filesystem."""
def __init__(self, qmp):
self.qmp = qmp
self.qmp.connect()
@@ -37,6 +50,7 @@ class QOMFS(Operations):
self.ino_count = 1
def get_ino(self, path):
+ """Get an inode number for a given QOM path."""
if path in self.ino_map:
return self.ino_map[path]
self.ino_map[path] = self.ino_count
@@ -44,6 +58,7 @@ class QOMFS(Operations):
return self.ino_map[path]
def is_object(self, path):
+ """Is the given QOM path an object?"""
try:
self.qmp.command('qom-list', path=path)
return True
@@ -51,6 +66,7 @@ class QOMFS(Operations):
return False
def is_property(self, path):
+ """Is the given QOM path a property?"""
path, prop = path.rsplit('/', 1)
if path == '':
path = '/'
@@ -63,6 +79,7 @@ class QOMFS(Operations):
return False
def is_link(self, path):
+ """Is the given QOM path a link?"""
path, prop = path.rsplit('/', 1)
if path == '':
path = '/'
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 12/72] scripts/qom-fuse: Convert to QOMCommand
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (10 preceding siblings ...)
2021-06-18 23:03 ` [PULL 11/72] scripts/qom-fuse: Add docstrings John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 13/72] scripts/qom-fuse: use QOMCommand.qom_list() John Snow
` (60 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Move qom-fuse onto the QOMCommand base established in
python/qemu/qmp/qom_common.py. The interface doesn't change
incompatibly, "qom-fuse mountpoint" still works as an invocation, and
QMP_SOCKET is still used as the environment variable.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210603003719.1321369-13-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qom-fuse | 59 ++++++++++++++++++++++++++++++++++----------
1 file changed, 46 insertions(+), 13 deletions(-)
diff --git a/scripts/qmp/qom-fuse b/scripts/qmp/qom-fuse
index 1fb3008a16..1676fb78d9 100755
--- a/scripts/qmp/qom-fuse
+++ b/scripts/qmp/qom-fuse
@@ -7,11 +7,19 @@ may be browsed, queried and edited using traditional shell tooling.
This script requires the 'fusepy' python package.
-ENV:
- QMP_SOCKET: Path to the QMP server socket
-Usage:
- qom-fuse /mount/to/here
+usage: qom-fuse [-h] [--socket SOCKET] <mount>
+
+Mount a QOM tree as a FUSE filesystem
+
+positional arguments:
+ <mount> Mount point
+
+optional arguments:
+ -h, --help show this help message and exit
+ --socket SOCKET, -s SOCKET
+ QMP socket path or address (addr:port). May also be
+ set via QMP_SOCKET environment variable.
"""
##
# Copyright IBM, Corp. 2012
@@ -25,30 +33,56 @@ Usage:
# See the COPYING file in the top-level directory.
##
+import argparse
from errno import ENOENT, EPERM
import os
import stat
import sys
+from typing import Dict
import fuse
from fuse import FUSE, FuseOSError, Operations
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
-from qemu.qmp import QEMUMonitorProtocol, QMPResponseError
+from qemu.qmp import QMPResponseError
+from qemu.qmp.qom_common import QOMCommand
fuse.fuse_python_api = (0, 2)
-class QOMFS(Operations):
- """QOMFS implements fuse.Operations to provide a QOM filesystem."""
- def __init__(self, qmp):
- self.qmp = qmp
- self.qmp.connect()
- self.ino_map = {}
+class QOMFuse(QOMCommand, Operations):
+ """
+ QOMFuse implements both fuse.Operations and QOMCommand.
+
+ Operations implements the FS, and QOMCommand implements the CLI command.
+ """
+ name = 'fuse'
+ help = 'Mount a QOM tree as a FUSE filesystem'
+ fuse: FUSE
+
+ @classmethod
+ def configure_parser(cls, parser: argparse.ArgumentParser) -> None:
+ super().configure_parser(parser)
+ parser.add_argument(
+ 'mount',
+ metavar='<mount>',
+ action='store',
+ help="Mount point",
+ )
+
+ def __init__(self, args: argparse.Namespace):
+ super().__init__(args)
+ self.mount = args.mount
+ self.ino_map: Dict[str, int] = {}
self.ino_count = 1
+ def run(self) -> int:
+ print(f"Mounting QOMFS to '{self.mount}'", file=sys.stderr)
+ self.fuse = FUSE(self, self.mount, foreground=True)
+ return 0
+
def get_ino(self, path):
"""Get an inode number for a given QOM path."""
if path in self.ino_map:
@@ -171,5 +205,4 @@ class QOMFS(Operations):
if __name__ == '__main__':
- fuse = FUSE(QOMFS(QEMUMonitorProtocol(os.environ['QMP_SOCKET'])),
- sys.argv[1], foreground=True)
+ sys.exit(QOMFuse.entry_point())
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 13/72] scripts/qom-fuse: use QOMCommand.qom_list()
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (11 preceding siblings ...)
2021-06-18 23:03 ` [PULL 12/72] scripts/qom-fuse: Convert to QOMCommand John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 14/72] scripts/qom-fuse: ensure QOMFuse.read always returns bytes John Snow
` (59 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Eduardo Habkost, John Snow, Markus Armbruster,
Cleber Rosa, Philippe Mathieu-Daudé
the qom_list method provides a type-safe object that's easier to type
check, so switch to using it.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-id: 20210603003719.1321369-14-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qom-fuse | 18 ++++++++----------
1 file changed, 8 insertions(+), 10 deletions(-)
diff --git a/scripts/qmp/qom-fuse b/scripts/qmp/qom-fuse
index 1676fb78d9..703a97e75f 100755
--- a/scripts/qmp/qom-fuse
+++ b/scripts/qmp/qom-fuse
@@ -94,7 +94,7 @@ class QOMFuse(QOMCommand, Operations):
def is_object(self, path):
"""Is the given QOM path an object?"""
try:
- self.qmp.command('qom-list', path=path)
+ self.qom_list(path)
return True
except QMPResponseError:
return False
@@ -105,8 +105,8 @@ class QOMFuse(QOMCommand, Operations):
if path == '':
path = '/'
try:
- for item in self.qmp.command('qom-list', path=path):
- if item['name'] == prop:
+ for item in self.qom_list(path):
+ if item.name == prop:
return True
return False
except QMPResponseError:
@@ -118,11 +118,9 @@ class QOMFuse(QOMCommand, Operations):
if path == '':
path = '/'
try:
- for item in self.qmp.command('qom-list', path=path):
- if item['name'] == prop:
- if item['type'].startswith('link<'):
- return True
- return False
+ for item in self.qom_list(path):
+ if item.name == prop and item.link:
+ return True
return False
except QMPResponseError:
return False
@@ -200,8 +198,8 @@ class QOMFuse(QOMCommand, Operations):
def readdir(self, path, fh):
yield '.'
yield '..'
- for item in self.qmp.command('qom-list', path=path):
- yield str(item['name'])
+ for item in self.qom_list(path):
+ yield item.name
if __name__ == '__main__':
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 14/72] scripts/qom-fuse: ensure QOMFuse.read always returns bytes
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (12 preceding siblings ...)
2021-06-18 23:03 ` [PULL 13/72] scripts/qom-fuse: use QOMCommand.qom_list() John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 15/72] scripts/qom-fuse: add static type hints John Snow
` (58 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Eduardo Habkost, John Snow, Markus Armbruster,
Cleber Rosa, Philippe Mathieu-Daudé
- Use FuseOSError to signal ENOENT instead of returning it
- Wrap qom-get in str(), as we don't always know its type
- The empty return should be b'', not ''.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-id: 20210603003719.1321369-15-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qom-fuse | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/scripts/qmp/qom-fuse b/scripts/qmp/qom-fuse
index 703a97e75f..0d11f73152 100755
--- a/scripts/qmp/qom-fuse
+++ b/scripts/qmp/qom-fuse
@@ -127,19 +127,19 @@ class QOMFuse(QOMCommand, Operations):
def read(self, path, size, offset, fh):
if not self.is_property(path):
- return -ENOENT
+ raise FuseOSError(ENOENT)
path, prop = path.rsplit('/', 1)
if path == '':
path = '/'
try:
- data = self.qmp.command('qom-get', path=path, property=prop)
+ data = str(self.qmp.command('qom-get', path=path, property=prop))
data += '\n' # make values shell friendly
except QMPResponseError as err:
raise FuseOSError(EPERM) from err
if offset > len(data):
- return ''
+ return b''
return bytes(data[offset:][:size], encoding='utf-8')
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 15/72] scripts/qom-fuse: add static type hints
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (13 preceding siblings ...)
2021-06-18 23:03 ` [PULL 14/72] scripts/qom-fuse: ensure QOMFuse.read always returns bytes John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:03 ` [PULL 16/72] python: add optional FUSE dependencies John Snow
` (57 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Because fusepy does not have type hints, add some targeted warning
suppressions.
Namely, we need to allow subclassing something of an unknown type (in
qom_fuse.py), and we need to allow missing imports (recorded against
fuse itself) because mypy will be unable to import fusepy (even when
installed) as it has no types nor type stubs available.
Note: Until now, it was possible to run invocations like 'mypy qemu/'
from ./python and have that work. However, these targeted suppressions
require that you run 'mypy -p qemu/' instead. The correct, canonical
invocation is recorded in ./python/tests/mypy.sh and all of the various
CI invocations always use this correct form.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210603003719.1321369-16-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/setup.cfg | 8 ++++++++
scripts/qmp/qom-fuse | 26 +++++++++++++++++---------
2 files changed, 25 insertions(+), 9 deletions(-)
diff --git a/python/setup.cfg b/python/setup.cfg
index c9b9445af9..ba8d29fd62 100644
--- a/python/setup.cfg
+++ b/python/setup.cfg
@@ -57,6 +57,14 @@ python_version = 3.6
warn_unused_configs = True
namespace_packages = True
+[mypy-qemu.qmp.qom_fuse]
+# fusepy has no type stubs:
+allow_subclassing_any = True
+
+[mypy-fuse]
+# fusepy has no type stubs:
+ignore_missing_imports = True
+
[pylint.messages control]
# Disable the message, report, category or checker with the given id(s). You
# can either give multiple identifiers separated by comma (,) or put this
diff --git a/scripts/qmp/qom-fuse b/scripts/qmp/qom-fuse
index 0d11f73152..a5a7a304a3 100755
--- a/scripts/qmp/qom-fuse
+++ b/scripts/qmp/qom-fuse
@@ -38,7 +38,14 @@ from errno import ENOENT, EPERM
import os
import stat
import sys
-from typing import Dict
+from typing import (
+ IO,
+ Dict,
+ Iterator,
+ Mapping,
+ Optional,
+ Union,
+)
import fuse
from fuse import FUSE, FuseOSError, Operations
@@ -83,7 +90,7 @@ class QOMFuse(QOMCommand, Operations):
self.fuse = FUSE(self, self.mount, foreground=True)
return 0
- def get_ino(self, path):
+ def get_ino(self, path: str) -> int:
"""Get an inode number for a given QOM path."""
if path in self.ino_map:
return self.ino_map[path]
@@ -91,7 +98,7 @@ class QOMFuse(QOMCommand, Operations):
self.ino_count += 1
return self.ino_map[path]
- def is_object(self, path):
+ def is_object(self, path: str) -> bool:
"""Is the given QOM path an object?"""
try:
self.qom_list(path)
@@ -99,7 +106,7 @@ class QOMFuse(QOMCommand, Operations):
except QMPResponseError:
return False
- def is_property(self, path):
+ def is_property(self, path: str) -> bool:
"""Is the given QOM path a property?"""
path, prop = path.rsplit('/', 1)
if path == '':
@@ -112,7 +119,7 @@ class QOMFuse(QOMCommand, Operations):
except QMPResponseError:
return False
- def is_link(self, path):
+ def is_link(self, path: str) -> bool:
"""Is the given QOM path a link?"""
path, prop = path.rsplit('/', 1)
if path == '':
@@ -125,7 +132,7 @@ class QOMFuse(QOMCommand, Operations):
except QMPResponseError:
return False
- def read(self, path, size, offset, fh):
+ def read(self, path: str, size: int, offset: int, fh: IO[bytes]) -> bytes:
if not self.is_property(path):
raise FuseOSError(ENOENT)
@@ -143,7 +150,7 @@ class QOMFuse(QOMCommand, Operations):
return bytes(data[offset:][:size], encoding='utf-8')
- def readlink(self, path):
+ def readlink(self, path: str) -> Union[bool, str]:
if not self.is_link(path):
return False
path, prop = path.rsplit('/', 1)
@@ -151,7 +158,8 @@ class QOMFuse(QOMCommand, Operations):
return prefix + str(self.qmp.command('qom-get', path=path,
property=prop))
- def getattr(self, path, fh=None):
+ def getattr(self, path: str,
+ fh: Optional[IO[bytes]] = None) -> Mapping[str, object]:
if self.is_link(path):
value = {
'st_mode': 0o755 | stat.S_IFLNK,
@@ -195,7 +203,7 @@ class QOMFuse(QOMCommand, Operations):
raise FuseOSError(ENOENT)
return value
- def readdir(self, path, fh):
+ def readdir(self, path: str, fh: IO[bytes]) -> Iterator[str]:
yield '.'
yield '..'
for item in self.qom_list(path):
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 16/72] python: add optional FUSE dependencies
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (14 preceding siblings ...)
2021-06-18 23:03 ` [PULL 15/72] scripts/qom-fuse: add static type hints John Snow
@ 2021-06-18 23:03 ` John Snow
2021-06-18 23:04 ` [PULL 17/72] scripts/qom-fuse: move to python/qemu/qmp/qom_fuse.py John Snow
` (56 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:03 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
In preparation for moving qom-fuse over to the python package, we need
some new dependencies to support it.
Add an optional 'fusepy' dependency that users of the package can opt
into with e.g. "pip install qemu[fuse]" which installs the requirements
necessary to obtain the additional functionality.
Add the same fusepy dependency to the 'devel' extras group --
unfortunately I do not see a way for optional groups to imply other
optional groups at present, so the dependency is repeated. The
development group needs to include the full set of dependencies for the
purpose of static analysis of all features offered by this library.
Lastly, add the [fuse] extras group to tox's configuration as a
workaround so that if a stale tox environment is found when running
`make check-tox`, tox will know to rebuild its environments.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210603003719.1321369-17-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/Pipfile.lock | 6 ++++++
python/setup.cfg | 9 ++++++++-
2 files changed, 14 insertions(+), 1 deletion(-)
diff --git a/python/Pipfile.lock b/python/Pipfile.lock
index f2a3f91d0f..5bb3f1b635 100644
--- a/python/Pipfile.lock
+++ b/python/Pipfile.lock
@@ -67,6 +67,12 @@
"markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'",
"version": "==3.9.2"
},
+ "fusepy": {
+ "hashes": [
+ "sha256:72ff783ec2f43de3ab394e3f7457605bf04c8cf288a2f4068b4cde141d4ee6bd"
+ ],
+ "version": "==3.0.1"
+ },
"importlib-metadata": {
"hashes": [
"sha256:8c501196e49fb9df5df43833bdb1e4328f64847763ec8a50703148b73784d581",
diff --git a/python/setup.cfg b/python/setup.cfg
index ba8d29fd62..aca6f31185 100644
--- a/python/setup.cfg
+++ b/python/setup.cfg
@@ -32,11 +32,16 @@ packages =
devel =
avocado-framework >= 87.0
flake8 >= 3.6.0
+ fusepy >= 2.0.4
isort >= 5.1.2
mypy >= 0.770
pylint >= 2.8.0
tox >= 3.18.0
+# Provides qom-fuse functionality
+fuse =
+ fusepy >= 2.0.4
+
[options.entry_points]
console_scripts =
qom = qemu.qmp.qom:main
@@ -114,6 +119,8 @@ envlist = py36, py37, py38, py39, py310
[testenv]
allowlist_externals = make
-deps = .[devel]
+deps =
+ .[devel]
+ .[fuse] # Workaround to trigger tox venv rebuild
commands =
make check
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 17/72] scripts/qom-fuse: move to python/qemu/qmp/qom_fuse.py
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (15 preceding siblings ...)
2021-06-18 23:03 ` [PULL 16/72] python: add optional FUSE dependencies John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 18/72] scripts/qom-fuse: add redirection shim to python/qemu/qmp/qom-fuse.py John Snow
` (55 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Move qom-fuse over to the python package now that it passes the
linter. Update the import paradigms so that it continues to pass in the
context of the Python package.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210603003719.1321369-18-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qom-fuse => python/qemu/qmp/qom_fuse.py | 12 ++----------
1 file changed, 2 insertions(+), 10 deletions(-)
rename scripts/qmp/qom-fuse => python/qemu/qmp/qom_fuse.py (95%)
mode change 100755 => 100644
diff --git a/scripts/qmp/qom-fuse b/python/qemu/qmp/qom_fuse.py
old mode 100755
new mode 100644
similarity index 95%
rename from scripts/qmp/qom-fuse
rename to python/qemu/qmp/qom_fuse.py
index a5a7a304a3..43f4671fdb
--- a/scripts/qmp/qom-fuse
+++ b/python/qemu/qmp/qom_fuse.py
@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
"""
QEMU Object Model FUSE filesystem tool
@@ -35,7 +34,6 @@
import argparse
from errno import ENOENT, EPERM
-import os
import stat
import sys
from typing import (
@@ -50,10 +48,8 @@
import fuse
from fuse import FUSE, FuseOSError, Operations
-
-sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
-from qemu.qmp import QMPResponseError
-from qemu.qmp.qom_common import QOMCommand
+from . import QMPResponseError
+from .qom_common import QOMCommand
fuse.fuse_python_api = (0, 2)
@@ -208,7 +204,3 @@ def readdir(self, path: str, fh: IO[bytes]) -> Iterator[str]:
yield '..'
for item in self.qom_list(path):
yield item.name
-
-
-if __name__ == '__main__':
- sys.exit(QOMFuse.entry_point())
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 18/72] scripts/qom-fuse: add redirection shim to python/qemu/qmp/qom-fuse.py
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (16 preceding siblings ...)
2021-06-18 23:04 ` [PULL 17/72] scripts/qom-fuse: move to python/qemu/qmp/qom_fuse.py John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 19/72] python/qmp: add fuse command to 'qom' tools John Snow
` (54 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Eduardo Habkost, John Snow, Markus Armbruster,
Cleber Rosa, Philippe Mathieu-Daudé
By leaving the script absent for a commit, git-blame travels to the new
file instead of staying on the shim.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-id: 20210603003719.1321369-19-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qom-fuse | 11 +++++++++++
1 file changed, 11 insertions(+)
create mode 100755 scripts/qmp/qom-fuse
diff --git a/scripts/qmp/qom-fuse b/scripts/qmp/qom-fuse
new file mode 100755
index 0000000000..a58c8ef979
--- /dev/null
+++ b/scripts/qmp/qom-fuse
@@ -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.qom_fuse import QOMFuse
+
+
+if __name__ == '__main__':
+ sys.exit(QOMFuse.entry_point())
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 19/72] python/qmp: add fuse command to 'qom' tools
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (17 preceding siblings ...)
2021-06-18 23:04 ` [PULL 18/72] scripts/qom-fuse: add redirection shim to python/qemu/qmp/qom-fuse.py John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 20/72] scripts/qemu-ga-client: apply isort rules John Snow
` (53 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Eduardo Habkost, John Snow, Markus Armbruster,
Cleber Rosa, Philippe Mathieu-Daudé
The 'fuse' command will be unavailable if 'fusepy' is not installed. It
will simply not load and subsequently be unavailable as a subcommand.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-id: 20210603003719.1321369-20-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/qmp/qom.py | 14 ++++++++++++--
python/setup.cfg | 1 +
2 files changed, 13 insertions(+), 2 deletions(-)
diff --git a/python/qemu/qmp/qom.py b/python/qemu/qmp/qom.py
index 7fe1448b5d..7ec7843d57 100644
--- a/python/qemu/qmp/qom.py
+++ b/python/qemu/qmp/qom.py
@@ -1,7 +1,7 @@
"""
QEMU Object Model testing tools.
-usage: qom [-h] {set,get,list,tree} ...
+usage: qom [-h] {set,get,list,tree,fuse} ...
Query and manipulate QOM data
@@ -9,11 +9,12 @@
-h, --help show this help message and exit
QOM commands:
- {set,get,list,tree}
+ {set,get,list,tree,fuse}
set Set a QOM property value
get Get a QOM property value
list List QOM properties at a given path
tree Show QOM tree from a given path
+ fuse Mount a QOM tree as a FUSE filesystem
"""
##
# Copyright John Snow 2020, for Red Hat, Inc.
@@ -35,6 +36,15 @@
from .qom_common import QOMCommand
+try:
+ from .qom_fuse import QOMFuse
+except ModuleNotFoundError as err:
+ if err.name != 'fuse':
+ raise
+else:
+ assert issubclass(QOMFuse, QOMCommand)
+
+
class QOMSet(QOMCommand):
"""
QOM Command - Set a property to a given value.
diff --git a/python/setup.cfg b/python/setup.cfg
index aca6f31185..6b6be8b03c 100644
--- a/python/setup.cfg
+++ b/python/setup.cfg
@@ -49,6 +49,7 @@ console_scripts =
qom-get = qemu.qmp.qom:QOMGet.entry_point
qom-list = qemu.qmp.qom:QOMList.entry_point
qom-tree = qemu.qmp.qom:QOMTree.entry_point
+ qom-fuse = qemu.qmp.qom_fuse:QOMFuse.entry_point [fuse]
[flake8]
extend-ignore = E722 # Prefer pylint's bare-except checks to flake8's
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 20/72] scripts/qemu-ga-client: apply isort rules
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (18 preceding siblings ...)
2021-06-18 23:04 ` [PULL 19/72] python/qmp: add fuse command to 'qom' tools John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 21/72] scripts/qemu-ga-client: apply (most) flake8 rules John Snow
` (52 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Hint:
> ln -s scripts/qmp/qemu-ga-client python/qemu/qmp/qemu_ga_client.py
> cd python
> isort qemu
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210604155532.1499282-2-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qemu-ga-client | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/scripts/qmp/qemu-ga-client b/scripts/qmp/qemu-ga-client
index 348d85864c..97f4047a62 100755
--- a/scripts/qmp/qemu-ga-client
+++ b/scripts/qmp/qemu-ga-client
@@ -36,10 +36,11 @@
# See also: https://wiki.qemu.org/Features/QAPI/GuestAgent
#
-import os
-import sys
import base64
+import os
import random
+import sys
+
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
from qemu import qmp
@@ -279,9 +280,9 @@ def main(address, cmd, args):
if __name__ == '__main__':
- import sys
- import os
import optparse
+ import os
+ import sys
address = os.environ['QGA_CLIENT_ADDRESS'] if 'QGA_CLIENT_ADDRESS' in os.environ else None
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 21/72] scripts/qemu-ga-client: apply (most) flake8 rules
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (19 preceding siblings ...)
2021-06-18 23:04 ` [PULL 20/72] scripts/qemu-ga-client: apply isort rules John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 22/72] scripts/qemu-ga-client: Fix exception handling John Snow
` (51 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
- Line length should be < 80
- You shouldn't perform unscoped imports except at the top of the module
Notably, the sys.path hack creates problems with the import rule. This
will be fixed later.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210604155532.1499282-3-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qemu-ga-client | 28 ++++++++++++++++------------
1 file changed, 16 insertions(+), 12 deletions(-)
diff --git a/scripts/qmp/qemu-ga-client b/scripts/qmp/qemu-ga-client
index 97f4047a62..566bddc89d 100755
--- a/scripts/qmp/qemu-ga-client
+++ b/scripts/qmp/qemu-ga-client
@@ -12,7 +12,8 @@
# Start QEMU with:
#
# # qemu [...] -chardev socket,path=/tmp/qga.sock,server=on,wait=off,id=qga0 \
-# -device virtio-serial -device virtserialport,chardev=qga0,name=org.qemu.guest_agent.0
+# -device virtio-serial \
+# -device virtserialport,chardev=qga0,name=org.qemu.guest_agent.0
#
# Run the script:
#
@@ -37,6 +38,7 @@
#
import base64
+import optparse
import os
import random
import sys
@@ -94,9 +96,11 @@ class QemuGuestAgentClient:
msgs = []
msgs.append('version: ' + info['version'])
msgs.append('supported_commands:')
- enabled = [c['name'] for c in info['supported_commands'] if c['enabled']]
+ enabled = [c['name'] for c in info['supported_commands']
+ if c['enabled']]
msgs.append('\tenabled: ' + ', '.join(enabled))
- disabled = [c['name'] for c in info['supported_commands'] if not c['enabled']]
+ disabled = [c['name'] for c in info['supported_commands']
+ if not c['enabled']]
msgs.append('\tdisabled: ' + ', '.join(disabled))
return '\n'.join(msgs)
@@ -119,11 +123,11 @@ class QemuGuestAgentClient:
if ipaddr['ip-address-type'] == 'ipv4':
addr = ipaddr['ip-address']
mask = self.__gen_ipv4_netmask(int(ipaddr['prefix']))
- msgs.append("\tinet %s netmask %s" % (addr, mask))
+ msgs.append(f"\tinet {addr} netmask {mask}")
elif ipaddr['ip-address-type'] == 'ipv6':
addr = ipaddr['ip-address']
prefix = ipaddr['prefix']
- msgs.append("\tinet6 %s prefixlen %s" % (addr, prefix))
+ msgs.append(f"\tinet6 {addr} prefixlen {prefix}")
if nif['hardware-address'] != '00:00:00:00:00:00':
msgs.append("\tether " + nif['hardware-address'])
@@ -237,6 +241,8 @@ def _cmd_suspend(client, args):
def _cmd_shutdown(client, args):
client.shutdown()
+
+
_cmd_powerdown = _cmd_shutdown
@@ -280,17 +286,15 @@ def main(address, cmd, args):
if __name__ == '__main__':
- import optparse
- import os
- import sys
+ address = os.environ.get('QGA_CLIENT_ADDRESS')
- address = os.environ['QGA_CLIENT_ADDRESS'] if 'QGA_CLIENT_ADDRESS' in os.environ else None
-
- usage = "%prog [--address=<unix_path>|<ipv4_address>] <command> [args...]\n"
+ usage = ("%prog [--address=<unix_path>|<ipv4_address>]"
+ " <command> [args...]\n")
usage += '<command>: ' + ', '.join(commands)
parser = optparse.OptionParser(usage=usage)
parser.add_option('--address', action='store', type='string',
- default=address, help='Specify a ip:port pair or a unix socket path')
+ default=address,
+ help='Specify a ip:port pair or a unix socket path')
options, args = parser.parse_args()
address = options.address
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 22/72] scripts/qemu-ga-client: Fix exception handling
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (20 preceding siblings ...)
2021-06-18 23:04 ` [PULL 21/72] scripts/qemu-ga-client: apply (most) flake8 rules John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 23/72] scripts/qemu-ga-client: replace deprecated optparse with argparse John Snow
` (50 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Fixes: 50d189c
These error classes aren't available anymore. Fix the bitrot.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210604155532.1499282-4-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qemu-ga-client | 10 ++++------
1 file changed, 4 insertions(+), 6 deletions(-)
diff --git a/scripts/qmp/qemu-ga-client b/scripts/qmp/qemu-ga-client
index 566bddc89d..7aba09f0fe 100755
--- a/scripts/qmp/qemu-ga-client
+++ b/scripts/qmp/qemu-ga-client
@@ -56,8 +56,6 @@ class QemuGuestAgent(qmp.QEMUMonitorProtocol):
class QemuGuestAgentClient:
- error = QemuGuestAgent.error
-
def __init__(self, address):
self.qga = QemuGuestAgent(address)
self.qga.connect(negotiate=False)
@@ -137,7 +135,7 @@ class QemuGuestAgentClient:
self.qga.settimeout(timeout)
try:
self.qga.ping()
- except self.qga.timeout:
+ except TimeoutError:
return False
return True
@@ -269,11 +267,11 @@ def main(address, cmd, args):
try:
client = QemuGuestAgentClient(address)
- except QemuGuestAgent.error as e:
+ except OSError as err:
import errno
- print(e)
- if e.errno == errno.ECONNREFUSED:
+ print(err)
+ if err.errno == errno.ECONNREFUSED:
print('Hint: qemu is not running?')
sys.exit(1)
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 23/72] scripts/qemu-ga-client: replace deprecated optparse with argparse
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (21 preceding siblings ...)
2021-06-18 23:04 ` [PULL 22/72] scripts/qemu-ga-client: Fix exception handling John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 24/72] scripts/qemu-ga-client: add module docstring John Snow
` (49 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
optparse isn't supported anymore, it's from the python2 days. Replace it
with the mostly similar argparse.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210604155532.1499282-5-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qemu-ga-client | 32 +++++++++++++++-----------------
1 file changed, 15 insertions(+), 17 deletions(-)
diff --git a/scripts/qmp/qemu-ga-client b/scripts/qmp/qemu-ga-client
index 7aba09f0fe..8eb4015e61 100755
--- a/scripts/qmp/qemu-ga-client
+++ b/scripts/qmp/qemu-ga-client
@@ -37,8 +37,8 @@
# See also: https://wiki.qemu.org/Features/QAPI/GuestAgent
#
+import argparse
import base64
-import optparse
import os
import random
import sys
@@ -255,7 +255,7 @@ def _cmd_reboot(client, args):
commands = [m.replace('_cmd_', '') for m in dir() if '_cmd_' in m]
-def main(address, cmd, args):
+def send_command(address, cmd, args):
if not os.path.exists(address):
print('%s not found' % address)
sys.exit(1)
@@ -283,25 +283,23 @@ def main(address, cmd, args):
globals()['_cmd_' + cmd](client, args)
-if __name__ == '__main__':
+def main():
address = os.environ.get('QGA_CLIENT_ADDRESS')
- usage = ("%prog [--address=<unix_path>|<ipv4_address>]"
- " <command> [args...]\n")
- usage += '<command>: ' + ', '.join(commands)
- parser = optparse.OptionParser(usage=usage)
- parser.add_option('--address', action='store', type='string',
- default=address,
- help='Specify a ip:port pair or a unix socket path')
- options, args = parser.parse_args()
+ parser = argparse.ArgumentParser()
+ parser.add_argument('--address', action='store',
+ default=address,
+ help='Specify a ip:port pair or a unix socket path')
+ parser.add_argument('command', choices=commands)
+ parser.add_argument('args', nargs='*')
- address = options.address
- if address is None:
+ args = parser.parse_args()
+ if args.address is None:
parser.error('address is not specified')
sys.exit(1)
- if len(args) == 0:
- parser.error('Less argument')
- sys.exit(1)
+ send_command(args.address, args.command, args.args)
- main(address, args[0], args[1:])
+
+if __name__ == '__main__':
+ main()
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 24/72] scripts/qemu-ga-client: add module docstring
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (22 preceding siblings ...)
2021-06-18 23:04 ` [PULL 23/72] scripts/qemu-ga-client: replace deprecated optparse with argparse John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 25/72] scripts/qemu-ga-client: apply (most) pylint rules John Snow
` (48 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Turn that nice usage comment into a docstring.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210604155532.1499282-6-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qemu-ga-client | 65 +++++++++++++++++++-------------------
1 file changed, 33 insertions(+), 32 deletions(-)
diff --git a/scripts/qmp/qemu-ga-client b/scripts/qmp/qemu-ga-client
index 8eb4015e61..e81937e0ea 100755
--- a/scripts/qmp/qemu-ga-client
+++ b/scripts/qmp/qemu-ga-client
@@ -1,41 +1,42 @@
#!/usr/bin/env python3
-# QEMU Guest Agent Client
-#
+"""
+QEMU Guest Agent Client
+
+Usage:
+
+Start QEMU with:
+
+# qemu [...] -chardev socket,path=/tmp/qga.sock,server,wait=off,id=qga0 \
+ -device virtio-serial \
+ -device virtserialport,chardev=qga0,name=org.qemu.guest_agent.0
+
+Run the script:
+
+$ qemu-ga-client --address=/tmp/qga.sock <command> [args...]
+
+or
+
+$ export QGA_CLIENT_ADDRESS=/tmp/qga.sock
+$ qemu-ga-client <command> [args...]
+
+For example:
+
+$ qemu-ga-client cat /etc/resolv.conf
+# Generated by NetworkManager
+nameserver 10.0.2.3
+$ qemu-ga-client fsfreeze status
+thawed
+$ qemu-ga-client fsfreeze freeze
+2 filesystems frozen
+
+See also: https://wiki.qemu.org/Features/QAPI/GuestAgent
+"""
+
# Copyright (C) 2012 Ryota Ozaki <ozaki.ryota@gmail.com>
#
# This work is licensed under the terms of the GNU GPL, version 2. See
# the COPYING file in the top-level directory.
-#
-# Usage:
-#
-# Start QEMU with:
-#
-# # qemu [...] -chardev socket,path=/tmp/qga.sock,server=on,wait=off,id=qga0 \
-# -device virtio-serial \
-# -device virtserialport,chardev=qga0,name=org.qemu.guest_agent.0
-#
-# Run the script:
-#
-# $ qemu-ga-client --address=/tmp/qga.sock <command> [args...]
-#
-# or
-#
-# $ export QGA_CLIENT_ADDRESS=/tmp/qga.sock
-# $ qemu-ga-client <command> [args...]
-#
-# For example:
-#
-# $ qemu-ga-client cat /etc/resolv.conf
-# # Generated by NetworkManager
-# nameserver 10.0.2.3
-# $ qemu-ga-client fsfreeze status
-# thawed
-# $ qemu-ga-client fsfreeze freeze
-# 2 filesystems frozen
-#
-# See also: https://wiki.qemu.org/Features/QAPI/GuestAgent
-#
import argparse
import base64
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 25/72] scripts/qemu-ga-client: apply (most) pylint rules
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (23 preceding siblings ...)
2021-06-18 23:04 ` [PULL 24/72] scripts/qemu-ga-client: add module docstring John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 26/72] python/qmp: Correct type of QMPReturnValue John Snow
` (47 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
I'm only doing a very quick best-effort to preserve this script, to help
keep it from breaking further. I think there are pending ideas swirling
on the right way to implement better SDKs and better clients, and this
script might be a handy reference for those discussions. It presents
some interesting design problems, like static type safety when using a
dynamic RPC mechanism.
I believe it's worth preserving the effort and care that went into
making this script by updating it to work with our current
infrastructure. However, I am disabling the requirement for docstrings
in this file.
If you would like to help improve this script, please add docstrings
alongside any refactors or rejuvenations you might apply at that time.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210604155532.1499282-7-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qemu-ga-client | 18 +++++++++++++++---
1 file changed, 15 insertions(+), 3 deletions(-)
diff --git a/scripts/qmp/qemu-ga-client b/scripts/qmp/qemu-ga-client
index e81937e0ea..ece9f74fa8 100755
--- a/scripts/qmp/qemu-ga-client
+++ b/scripts/qmp/qemu-ga-client
@@ -40,6 +40,7 @@ See also: https://wiki.qemu.org/Features/QAPI/GuestAgent
import argparse
import base64
+import errno
import os
import random
import sys
@@ -49,6 +50,13 @@ sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
from qemu import qmp
+# This script has not seen many patches or careful attention in quite
+# some time. If you would like to improve it, please review the design
+# carefully and add docstrings at that point in time. Until then:
+
+# pylint: disable=missing-docstring
+
+
class QemuGuestAgent(qmp.QEMUMonitorProtocol):
def __getattr__(self, name):
def wrapper(**kwds):
@@ -104,7 +112,8 @@ class QemuGuestAgentClient:
return '\n'.join(msgs)
- def __gen_ipv4_netmask(self, prefixlen):
+ @classmethod
+ def __gen_ipv4_netmask(cls, prefixlen):
mask = int('1' * prefixlen + '0' * (32 - prefixlen), 2)
return '.'.join([str(mask >> 24),
str((mask >> 16) & 0xff),
@@ -207,10 +216,12 @@ def _cmd_fstrim(client, args):
def _cmd_ifconfig(client, args):
+ assert not args
print(client.ifconfig())
def _cmd_info(client, args):
+ assert not args
print(client.info())
@@ -239,6 +250,7 @@ def _cmd_suspend(client, args):
def _cmd_shutdown(client, args):
+ assert not args
client.shutdown()
@@ -246,10 +258,12 @@ _cmd_powerdown = _cmd_shutdown
def _cmd_halt(client, args):
+ assert not args
client.shutdown('halt')
def _cmd_reboot(client, args):
+ assert not args
client.shutdown('reboot')
@@ -269,8 +283,6 @@ def send_command(address, cmd, args):
try:
client = QemuGuestAgentClient(address)
except OSError as err:
- import errno
-
print(err)
if err.errno == errno.ECONNREFUSED:
print('Hint: qemu is not running?')
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 26/72] python/qmp: Correct type of QMPReturnValue
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (24 preceding siblings ...)
2021-06-18 23:04 ` [PULL 25/72] scripts/qemu-ga-client: apply (most) pylint rules John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 27/72] scripts/qemu-ga-client: add mypy type hints John Snow
` (46 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
It's only a Dict[str, Any] most of the time. It's not actually
guaranteed to be anything in particular. Fix this type to be
more accurate to the reality we live in.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210604155532.1499282-8-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/qmp/__init__.py | 25 +++++++++++++++----------
1 file changed, 15 insertions(+), 10 deletions(-)
diff --git a/python/qemu/qmp/__init__.py b/python/qemu/qmp/__init__.py
index 822c793c32..a6e1a7b857 100644
--- a/python/qemu/qmp/__init__.py
+++ b/python/qemu/qmp/__init__.py
@@ -35,14 +35,19 @@
)
-# QMPMessage is a QMP Message of any kind.
-# e.g. {'yee': 'haw'}
-#
-# QMPReturnValue is the inner value of return values only.
-# {'return': {}} is the QMPMessage,
-# {} is the QMPReturnValue.
+#: QMPMessage is an entire QMP message of any kind.
QMPMessage = Dict[str, Any]
-QMPReturnValue = Dict[str, Any]
+
+#: QMPReturnValue is the 'return' value of a command.
+QMPReturnValue = 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
@@ -297,8 +302,8 @@ def cmd_obj(self, qmp_cmd: QMPMessage) -> QMPMessage:
return resp
def cmd(self, name: str,
- args: Optional[Dict[str, Any]] = None,
- cmd_id: Optional[Any] = None) -> QMPMessage:
+ args: Optional[Dict[str, object]] = None,
+ cmd_id: Optional[object] = None) -> QMPMessage:
"""
Build a QMP command and send it to the QMP Monitor.
@@ -313,7 +318,7 @@ def cmd(self, name: str,
qmp_cmd['id'] = cmd_id
return self.cmd_obj(qmp_cmd)
- def command(self, cmd: str, **kwds: Any) -> QMPReturnValue:
+ def command(self, cmd: str, **kwds: object) -> QMPReturnValue:
"""
Build and send a QMP command to the monitor, report errors if any
"""
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 27/72] scripts/qemu-ga-client: add mypy type hints
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (25 preceding siblings ...)
2021-06-18 23:04 ` [PULL 26/72] python/qmp: Correct type of QMPReturnValue John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 28/72] scripts/qemu-ga-client: move to python/qemu/qmp/qemu_ga_client.py John Snow
` (45 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
This script is in slightly rough shape, but it still works. A lot of
care went into its initial development. In good faith, I'm updating it
to the latest Python coding standards. If there is in interest in this
script, though, I'll be asking for a contributor to take care of it
further.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210604155532.1499282-9-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qemu-ga-client | 89 +++++++++++++++++++++-----------------
1 file changed, 49 insertions(+), 40 deletions(-)
diff --git a/scripts/qmp/qemu-ga-client b/scripts/qmp/qemu-ga-client
index ece9f74fa8..a7d0ef8347 100755
--- a/scripts/qmp/qemu-ga-client
+++ b/scripts/qmp/qemu-ga-client
@@ -44,10 +44,18 @@ import errno
import os
import random
import sys
+from typing import (
+ Any,
+ Callable,
+ Dict,
+ Optional,
+ Sequence,
+)
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
from qemu import qmp
+from qemu.qmp import SocketAddrT
# This script has not seen many patches or careful attention in quite
@@ -58,18 +66,18 @@ from qemu import qmp
class QemuGuestAgent(qmp.QEMUMonitorProtocol):
- def __getattr__(self, name):
- def wrapper(**kwds):
+ def __getattr__(self, name: str) -> Callable[..., Any]:
+ def wrapper(**kwds: object) -> object:
return self.command('guest-' + name.replace('_', '-'), **kwds)
return wrapper
class QemuGuestAgentClient:
- def __init__(self, address):
+ def __init__(self, address: SocketAddrT):
self.qga = QemuGuestAgent(address)
self.qga.connect(negotiate=False)
- def sync(self, timeout=3):
+ def sync(self, timeout: Optional[float] = 3) -> None:
# Avoid being blocked forever
if not self.ping(timeout):
raise EnvironmentError('Agent seems not alive')
@@ -79,9 +87,9 @@ class QemuGuestAgentClient:
if isinstance(ret, int) and int(ret) == uid:
break
- def __file_read_all(self, handle):
+ def __file_read_all(self, handle: int) -> bytes:
eof = False
- data = ''
+ data = b''
while not eof:
ret = self.qga.file_read(handle=handle, count=1024)
_data = base64.b64decode(ret['buf-b64'])
@@ -89,7 +97,7 @@ class QemuGuestAgentClient:
eof = ret['eof']
return data
- def read(self, path):
+ def read(self, path: str) -> bytes:
handle = self.qga.file_open(path=path)
try:
data = self.__file_read_all(handle)
@@ -97,7 +105,7 @@ class QemuGuestAgentClient:
self.qga.file_close(handle=handle)
return data
- def info(self):
+ def info(self) -> str:
info = self.qga.info()
msgs = []
@@ -113,14 +121,14 @@ class QemuGuestAgentClient:
return '\n'.join(msgs)
@classmethod
- def __gen_ipv4_netmask(cls, prefixlen):
+ def __gen_ipv4_netmask(cls, prefixlen: int) -> str:
mask = int('1' * prefixlen + '0' * (32 - prefixlen), 2)
return '.'.join([str(mask >> 24),
str((mask >> 16) & 0xff),
str((mask >> 8) & 0xff),
str(mask & 0xff)])
- def ifconfig(self):
+ def ifconfig(self) -> str:
nifs = self.qga.network_get_interfaces()
msgs = []
@@ -141,7 +149,7 @@ class QemuGuestAgentClient:
return '\n'.join(msgs)
- def ping(self, timeout):
+ def ping(self, timeout: Optional[float]) -> bool:
self.qga.settimeout(timeout)
try:
self.qga.ping()
@@ -149,37 +157,40 @@ class QemuGuestAgentClient:
return False
return True
- def fsfreeze(self, cmd):
+ def fsfreeze(self, cmd: str) -> object:
if cmd not in ['status', 'freeze', 'thaw']:
raise Exception('Invalid command: ' + cmd)
-
+ # Can be int (freeze, thaw) or GuestFsfreezeStatus (status)
return getattr(self.qga, 'fsfreeze' + '_' + cmd)()
- def fstrim(self, minimum=0):
- return getattr(self.qga, 'fstrim')(minimum=minimum)
+ def fstrim(self, minimum: int) -> Dict[str, object]:
+ # returns GuestFilesystemTrimResponse
+ ret = getattr(self.qga, 'fstrim')(minimum=minimum)
+ assert isinstance(ret, dict)
+ return ret
- def suspend(self, mode):
+ def suspend(self, mode: str) -> None:
if mode not in ['disk', 'ram', 'hybrid']:
raise Exception('Invalid mode: ' + mode)
try:
getattr(self.qga, 'suspend' + '_' + mode)()
# On error exception will raise
- except self.qga.timeout:
+ except TimeoutError:
# On success command will timed out
return
- def shutdown(self, mode='powerdown'):
+ def shutdown(self, mode: str = 'powerdown') -> None:
if mode not in ['powerdown', 'halt', 'reboot']:
raise Exception('Invalid mode: ' + mode)
try:
self.qga.shutdown(mode=mode)
- except self.qga.timeout:
- return
+ except TimeoutError:
+ pass
-def _cmd_cat(client, args):
+def _cmd_cat(client: QemuGuestAgentClient, args: Sequence[str]) -> None:
if len(args) != 1:
print('Invalid argument')
print('Usage: cat <file>')
@@ -187,7 +198,7 @@ def _cmd_cat(client, args):
print(client.read(args[0]))
-def _cmd_fsfreeze(client, args):
+def _cmd_fsfreeze(client: QemuGuestAgentClient, args: Sequence[str]) -> None:
usage = 'Usage: fsfreeze status|freeze|thaw'
if len(args) != 1:
print('Invalid argument')
@@ -201,13 +212,14 @@ def _cmd_fsfreeze(client, args):
ret = client.fsfreeze(cmd)
if cmd == 'status':
print(ret)
- elif cmd == 'freeze':
- print("%d filesystems frozen" % ret)
- else:
- print("%d filesystems thawed" % ret)
+ return
+ assert isinstance(ret, int)
+ verb = 'frozen' if cmd == 'freeze' else 'thawed'
+ print(f"{ret:d} filesystems {verb}")
-def _cmd_fstrim(client, args):
+
+def _cmd_fstrim(client: QemuGuestAgentClient, args: Sequence[str]) -> None:
if len(args) == 0:
minimum = 0
else:
@@ -215,28 +227,25 @@ def _cmd_fstrim(client, args):
print(client.fstrim(minimum))
-def _cmd_ifconfig(client, args):
+def _cmd_ifconfig(client: QemuGuestAgentClient, args: Sequence[str]) -> None:
assert not args
print(client.ifconfig())
-def _cmd_info(client, args):
+def _cmd_info(client: QemuGuestAgentClient, args: Sequence[str]) -> None:
assert not args
print(client.info())
-def _cmd_ping(client, args):
- if len(args) == 0:
- timeout = 3
- else:
- timeout = float(args[0])
+def _cmd_ping(client: QemuGuestAgentClient, args: Sequence[str]) -> None:
+ timeout = 3.0 if len(args) == 0 else float(args[0])
alive = client.ping(timeout)
if not alive:
print("Not responded in %s sec" % args[0])
sys.exit(1)
-def _cmd_suspend(client, args):
+def _cmd_suspend(client: QemuGuestAgentClient, args: Sequence[str]) -> None:
usage = 'Usage: suspend disk|ram|hybrid'
if len(args) != 1:
print('Less argument')
@@ -249,7 +258,7 @@ def _cmd_suspend(client, args):
client.suspend(args[0])
-def _cmd_shutdown(client, args):
+def _cmd_shutdown(client: QemuGuestAgentClient, args: Sequence[str]) -> None:
assert not args
client.shutdown()
@@ -257,12 +266,12 @@ def _cmd_shutdown(client, args):
_cmd_powerdown = _cmd_shutdown
-def _cmd_halt(client, args):
+def _cmd_halt(client: QemuGuestAgentClient, args: Sequence[str]) -> None:
assert not args
client.shutdown('halt')
-def _cmd_reboot(client, args):
+def _cmd_reboot(client: QemuGuestAgentClient, args: Sequence[str]) -> None:
assert not args
client.shutdown('reboot')
@@ -270,7 +279,7 @@ def _cmd_reboot(client, args):
commands = [m.replace('_cmd_', '') for m in dir() if '_cmd_' in m]
-def send_command(address, cmd, args):
+def send_command(address: str, cmd: str, args: Sequence[str]) -> None:
if not os.path.exists(address):
print('%s not found' % address)
sys.exit(1)
@@ -296,7 +305,7 @@ def send_command(address, cmd, args):
globals()['_cmd_' + cmd](client, args)
-def main():
+def main() -> None:
address = os.environ.get('QGA_CLIENT_ADDRESS')
parser = argparse.ArgumentParser()
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 28/72] scripts/qemu-ga-client: move to python/qemu/qmp/qemu_ga_client.py
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (26 preceding siblings ...)
2021-06-18 23:04 ` [PULL 27/72] scripts/qemu-ga-client: add mypy type hints John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 29/72] python/qemu-ga-client: add entry point John Snow
` (44 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
The script itself will be unavailable for a few commits before being
restored, with no way to run it right after this commit. This helps move
git history into the new file. To prevent linter regressions, though, we
do need to immediately touch up the filename to remove dashes (to make
the module importable), and remove the executable bit.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210604155532.1499282-10-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qemu-ga-client => python/qemu/qmp/qemu_ga_client.py | 2 --
1 file changed, 2 deletions(-)
rename scripts/qmp/qemu-ga-client => python/qemu/qmp/qemu_ga_client.py (99%)
diff --git a/scripts/qmp/qemu-ga-client b/python/qemu/qmp/qemu_ga_client.py
similarity index 99%
rename from scripts/qmp/qemu-ga-client
rename to python/qemu/qmp/qemu_ga_client.py
index a7d0ef8347..d2938ad47c 100755
--- a/scripts/qmp/qemu-ga-client
+++ b/python/qemu/qmp/qemu_ga_client.py
@@ -52,8 +52,6 @@
Sequence,
)
-
-sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
from qemu import qmp
from qemu.qmp import SocketAddrT
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 29/72] python/qemu-ga-client: add entry point
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (27 preceding siblings ...)
2021-06-18 23:04 ` [PULL 28/72] scripts/qemu-ga-client: move to python/qemu/qmp/qemu_ga_client.py John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 30/72] scripts/qemu-ga-client: Add forwarder shim John Snow
` (43 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Remove the shebang, and add a package-defined entry point instead. Now,
it can be accessed using 'qemu-ga-client' from the command line after
installing the package.
The next commit adds a forwarder shim that allows the running of this
script without needing to install the package again.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210604155532.1499282-11-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/qmp/qemu_ga_client.py | 2 --
python/setup.cfg | 1 +
2 files changed, 1 insertion(+), 2 deletions(-)
mode change 100755 => 100644 python/qemu/qmp/qemu_ga_client.py
diff --git a/python/qemu/qmp/qemu_ga_client.py b/python/qemu/qmp/qemu_ga_client.py
old mode 100755
new mode 100644
index d2938ad47c..67ac0b4211
--- a/python/qemu/qmp/qemu_ga_client.py
+++ b/python/qemu/qmp/qemu_ga_client.py
@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
"""
QEMU Guest Agent Client
diff --git a/python/setup.cfg b/python/setup.cfg
index 6b6be8b03c..7f3c59d74e 100644
--- a/python/setup.cfg
+++ b/python/setup.cfg
@@ -50,6 +50,7 @@ console_scripts =
qom-list = qemu.qmp.qom:QOMList.entry_point
qom-tree = qemu.qmp.qom:QOMTree.entry_point
qom-fuse = qemu.qmp.qom_fuse:QOMFuse.entry_point [fuse]
+ qemu-ga-client = qemu.qmp.qemu_ga_client:main
[flake8]
extend-ignore = E722 # Prefer pylint's bare-except checks to flake8's
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 30/72] scripts/qemu-ga-client: Add forwarder shim
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (28 preceding siblings ...)
2021-06-18 23:04 ` [PULL 29/72] python/qemu-ga-client: add entry point John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 31/72] scripts/qmp-shell: apply isort rules John Snow
` (42 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Add a little forwarder shim until we are sure that everyone is
comfortable with how to use the tools in their new packaged location.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210604155532.1499282-12-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qemu-ga-client | 11 +++++++++++
1 file changed, 11 insertions(+)
create mode 100755 scripts/qmp/qemu-ga-client
diff --git a/scripts/qmp/qemu-ga-client b/scripts/qmp/qemu-ga-client
new file mode 100755
index 0000000000..102fd2cad9
--- /dev/null
+++ b/scripts/qmp/qemu-ga-client
@@ -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 qemu_ga_client
+
+
+if __name__ == '__main__':
+ sys.exit(qemu_ga_client.main())
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 31/72] scripts/qmp-shell: apply isort rules
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (29 preceding siblings ...)
2021-06-18 23:04 ` [PULL 30/72] scripts/qemu-ga-client: Add forwarder shim John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 32/72] scripts/qmp-shell: Apply flake8 rules John Snow
` (41 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-2-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index d5ae8a9b21..a00efe6fea 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -65,18 +65,20 @@
# which will echo back the properly formatted JSON-compliant QMP that is being
# sent to QEMU, which is useful for debugging and documentation generation.
-import json
import ast
-import readline
-import sys
-import os
-import errno
import atexit
+import errno
+import json
+import os
import re
+import readline
+import sys
+
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
from qemu import qmp
+
class QMPCompleter(list):
def complete(self, text, state):
for cmd in self:
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 32/72] scripts/qmp-shell: Apply flake8 rules
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (30 preceding siblings ...)
2021-06-18 23:04 ` [PULL 31/72] scripts/qmp-shell: apply isort rules John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 33/72] scripts/qmp-shell: fix show_banner signature John Snow
` (40 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
A lot of fiddling around to get us below 80 columns.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-3-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 64 +++++++++++++++++++++++++++++--------------
1 file changed, 43 insertions(+), 21 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index a00efe6fea..62a6377e06 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -88,6 +88,7 @@ class QMPCompleter(list):
else:
state -= 1
+
class QMPShellError(Exception):
pass
@@ -105,6 +106,7 @@ class FuzzyJSON(ast.NodeTransformer):
node.id = 'None'
return node
+
# TODO: QMPShell's interface is a bit ugly (eg. _fill_completion() and
# _execute_cmd()). Let's design a better one.
class QMPShell(qmp.QEMUMonitorProtocol):
@@ -131,8 +133,8 @@ class QMPShell(qmp.QEMUMonitorProtocol):
readline.set_history_length(1024)
readline.set_completer(self._completer.complete)
readline.parse_and_bind("tab: complete")
- # XXX: default delimiters conflict with some command names (eg. query-),
- # clearing everything as it doesn't seem to matter
+ # NB: default delimiters conflict with some command names
+ # (eg. query-), clearing everything as it doesn't seem to matter
readline.set_completer_delims('')
try:
readline.read_history_file(self._histfile)
@@ -180,7 +182,9 @@ class QMPShell(qmp.QEMUMonitorProtocol):
for arg in tokens:
(key, sep, val) = arg.partition('=')
if sep != '=':
- raise QMPShellError("Expected a key=value pair, got '%s'" % arg)
+ raise QMPShellError(
+ f"Expected a key=value pair, got '{arg!s}'"
+ )
value = self.__parse_value(val)
optpath = key.split('.')
@@ -189,14 +193,16 @@ class QMPShell(qmp.QEMUMonitorProtocol):
curpath.append(p)
d = parent.get(p, {})
if type(d) is not dict:
- raise QMPShellError('Cannot use "%s" as both leaf and non-leaf key' % '.'.join(curpath))
+ msg = 'Cannot use "{:s}" as both leaf and non-leaf key'
+ raise QMPShellError(msg.format('.'.join(curpath)))
parent[p] = d
parent = d
if optpath[-1] in parent:
if type(parent[optpath[-1]]) is dict:
- raise QMPShellError('Cannot use "%s" as both leaf and non-leaf key' % '.'.join(curpath))
+ msg = 'Cannot use "{:s}" as both leaf and non-leaf key'
+ raise QMPShellError(msg.format('.'.join(curpath)))
else:
- raise QMPShellError('Cannot set "%s" multiple times' % key)
+ raise QMPShellError(f'Cannot set "{key}" multiple times')
parent[optpath[-1]] = value
def __build_cmd(self, cmdline):
@@ -206,7 +212,8 @@ class QMPShell(qmp.QEMUMonitorProtocol):
< command-name > [ arg-name1=arg1 ] ... [ arg-nameN=argN ]
"""
- cmdargs = re.findall(r'''(?:[^\s"']|"(?:\\.|[^"])*"|'(?:\\.|[^'])*')+''', cmdline)
+ argument_regex = r'''(?:[^\s"']|"(?:\\.|[^"])*"|'(?:\\.|[^'])*')+'''
+ cmdargs = re.findall(argument_regex, cmdline)
# Transactional CLI entry/exit:
if cmdargs[0] == 'transaction(':
@@ -215,9 +222,12 @@ class QMPShell(qmp.QEMUMonitorProtocol):
elif cmdargs[0] == ')' and self._transmode:
self._transmode = False
if len(cmdargs) > 1:
- raise QMPShellError("Unexpected input after close of Transaction sub-shell")
- qmpcmd = { 'execute': 'transaction',
- 'arguments': { 'actions': self._actions } }
+ msg = 'Unexpected input after close of Transaction sub-shell'
+ raise QMPShellError(msg)
+ qmpcmd = {
+ 'execute': 'transaction',
+ 'arguments': {'actions': self._actions}
+ }
self._actions = list()
return qmpcmd
@@ -228,7 +238,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
# Parse and then cache this Transactional Action
if self._transmode:
finalize = False
- action = { 'type': cmdargs[0], 'data': {} }
+ action = {'type': cmdargs[0], 'data': {}}
if cmdargs[-1] == ')':
cmdargs.pop(-1)
finalize = True
@@ -237,7 +247,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
return self.__build_cmd(')') if finalize else None
# Standard command: parse and return it to be executed.
- qmpcmd = { 'execute': cmdargs[0], 'arguments': {} }
+ qmpcmd = {'execute': cmdargs[0], 'arguments': {}}
self.__cli_expr(cmdargs[1:], qmpcmd['arguments'])
return qmpcmd
@@ -278,7 +288,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
print('Connected')
return
version = self._greeting['QMP']['version']['qemu']
- print('Connected to QEMU %d.%d.%d\n' % (version['major'],version['minor'],version['micro']))
+ print("Connected to QEMU {major}.{minor}.{micro}\n".format(**version))
def get_prompt(self):
if self._transmode:
@@ -307,6 +317,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
def set_verbosity(self, verbose):
self._verbose = verbose
+
class HMPShell(QMPShell):
def __init__(self, address):
QMPShell.__init__(self, address)
@@ -315,7 +326,7 @@ class HMPShell(QMPShell):
def __cmd_completion(self):
for cmd in self.__cmd_passthrough('help')['return'].split('\r\n'):
if cmd and cmd[0] != '[' and cmd[0] != '\t':
- name = cmd.split()[0] # drop help text
+ name = cmd.split()[0] # drop help text
if name == 'info':
continue
if name.find('|') != -1:
@@ -327,7 +338,7 @@ class HMPShell(QMPShell):
else:
name = opt[0]
self._completer.append(name)
- self._completer.append('help ' + name) # help completion
+ self._completer.append('help ' + name) # help completion
def __info_completion(self):
for cmd in self.__cmd_passthrough('info')['return'].split('\r\n'):
@@ -343,17 +354,21 @@ class HMPShell(QMPShell):
self.__info_completion()
self.__other_completion()
- def __cmd_passthrough(self, cmdline, cpu_index = 0):
- return self.cmd_obj({ 'execute': 'human-monitor-command', 'arguments':
- { 'command-line': cmdline,
- 'cpu-index': cpu_index } })
+ def __cmd_passthrough(self, cmdline, cpu_index=0):
+ return self.cmd_obj({
+ 'execute': 'human-monitor-command',
+ 'arguments': {
+ 'command-line': cmdline,
+ 'cpu-index': cpu_index
+ }
+ })
def _execute_cmd(self, cmdline):
if cmdline.split()[0] == "cpu":
# trap the cpu command, it requires special setting
try:
idx = int(cmdline.split()[1])
- if not 'return' in self.__cmd_passthrough('info version', idx):
+ if 'return' not in self.__cmd_passthrough('info version', idx):
print('bad CPU index')
return True
self.__cpu_index = idx
@@ -377,20 +392,26 @@ class HMPShell(QMPShell):
def show_banner(self):
QMPShell.show_banner(self, msg='Welcome to the HMP shell!')
+
def die(msg):
sys.stderr.write('ERROR: %s\n' % msg)
sys.exit(1)
+
def fail_cmdline(option=None):
if option:
sys.stderr.write('ERROR: bad command-line option \'%s\'\n' % option)
- sys.stderr.write('qmp-shell [ -v ] [ -p ] [ -H ] [ -N ] < UNIX socket path> | < TCP address:port >\n')
+ sys.stderr.write(
+ 'qmp-shell [ -v ] [ -p ] [ -H ] [ -N ] '
+ '< UNIX socket path> | < TCP address:port >\n'
+ )
sys.stderr.write(' -v Verbose (echo command sent and received)\n')
sys.stderr.write(' -p Pretty-print JSON\n')
sys.stderr.write(' -H Use HMP interface\n')
sys.stderr.write(' -N Skip negotiate (for qemu-ga)\n')
sys.exit(1)
+
def main():
addr = ''
qemu = None
@@ -440,5 +461,6 @@ def main():
pass
qemu.close()
+
if __name__ == '__main__':
main()
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 33/72] scripts/qmp-shell: fix show_banner signature
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (31 preceding siblings ...)
2021-06-18 23:04 ` [PULL 32/72] scripts/qmp-shell: Apply flake8 rules John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 34/72] scripts/qmp-shell: fix exception handling John Snow
` (39 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
The signatures need to match.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-4-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 62a6377e06..18bf49bb26 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -389,8 +389,8 @@ class HMPShell(QMPShell):
print('%s: %s' % (resp['error']['class'], resp['error']['desc']))
return True
- def show_banner(self):
- QMPShell.show_banner(self, msg='Welcome to the HMP shell!')
+ def show_banner(self, msg='Welcome to the HMP shell!'):
+ QMPShell.show_banner(self, msg)
def die(msg):
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 34/72] scripts/qmp-shell: fix exception handling
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (32 preceding siblings ...)
2021-06-18 23:04 ` [PULL 33/72] scripts/qmp-shell: fix show_banner signature John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 35/72] scripts/qmp-shell: fix connect method signature John Snow
` (38 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Fixes: 50d189c
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-5-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 18bf49bb26..413dd4d2de 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -452,7 +452,7 @@ def main():
die('Didn\'t get QMP greeting message')
except qmp.QMPCapabilitiesError:
die('Could not negotiate capabilities')
- except qemu.error:
+ except OSError:
die('Could not connect to %s' % addr)
qemu.show_banner()
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 35/72] scripts/qmp-shell: fix connect method signature
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (33 preceding siblings ...)
2021-06-18 23:04 ` [PULL 34/72] scripts/qmp-shell: fix exception handling John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 36/72] scripts/qmp-shell: remove shadowed variable from _print() John Snow
` (37 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
It needs to match the parent's signature -- the negotiate parameter must
be optional.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-6-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 413dd4d2de..04ca6a25ae 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -278,7 +278,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
self._print(resp)
return True
- def connect(self, negotiate):
+ def connect(self, negotiate: bool = True):
self._greeting = super(QMPShell, self).connect(negotiate)
self.__completer_setup()
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 36/72] scripts/qmp-shell: remove shadowed variable from _print()
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (34 preceding siblings ...)
2021-06-18 23:04 ` [PULL 35/72] scripts/qmp-shell: fix connect method signature John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 37/72] scripts/qmp-shell: use @classmethod where appropriate John Snow
` (36 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Don't use 'qmp' here, which shadows the qmp module.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-7-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 04ca6a25ae..ae3f04534a 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -251,11 +251,11 @@ class QMPShell(qmp.QEMUMonitorProtocol):
self.__cli_expr(cmdargs[1:], qmpcmd['arguments'])
return qmpcmd
- def _print(self, qmp):
+ def _print(self, qmp_message):
indent = None
if self._pretty:
indent = 4
- jsobj = json.dumps(qmp, indent=indent, sort_keys=self._pretty)
+ jsobj = json.dumps(qmp_message, indent=indent, sort_keys=self._pretty)
print(str(jsobj))
def _execute_cmd(self, cmdline):
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 37/72] scripts/qmp-shell: use @classmethod where appropriate
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (35 preceding siblings ...)
2021-06-18 23:04 ` [PULL 36/72] scripts/qmp-shell: remove shadowed variable from _print() John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 38/72] scripts/qmp-shell: Use python3-style super() John Snow
` (35 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Methods with no self-use should belong to the class.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-8-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index ae3f04534a..f354549bf2 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -97,7 +97,8 @@ class FuzzyJSON(ast.NodeTransformer):
'''This extension of ast.NodeTransformer filters literal "true/false/null"
values in an AST and replaces them by proper "True/False/None" values that
Python can properly evaluate.'''
- def visit_Name(self, node):
+ @classmethod
+ def visit_Name(cls, node):
if node.id == 'true':
node.id = 'True'
if node.id == 'false':
@@ -152,7 +153,8 @@ class QMPShell(qmp.QEMUMonitorProtocol):
except Exception as e:
print("Failed to save history file '%s'; %s" % (self._histfile, e))
- def __parse_value(self, val):
+ @classmethod
+ def __parse_value(cls, val):
try:
return int(val)
except ValueError:
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 38/72] scripts/qmp-shell: Use python3-style super()
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (36 preceding siblings ...)
2021-06-18 23:04 ` [PULL 37/72] scripts/qmp-shell: use @classmethod where appropriate John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 39/72] scripts/qmp-shell: declare verbose in __init__ John Snow
` (34 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-9-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index f354549bf2..3066e37ae5 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -112,7 +112,7 @@ class FuzzyJSON(ast.NodeTransformer):
# _execute_cmd()). Let's design a better one.
class QMPShell(qmp.QEMUMonitorProtocol):
def __init__(self, address, pretty=False):
- super(QMPShell, self).__init__(self.parse_address(address))
+ super().__init__(self.parse_address(address))
self._greeting = None
self._completer = None
self._pretty = pretty
@@ -281,7 +281,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
return True
def connect(self, negotiate: bool = True):
- self._greeting = super(QMPShell, self).connect(negotiate)
+ self._greeting = super().connect(negotiate)
self.__completer_setup()
def show_banner(self, msg='Welcome to the QMP low-level shell!'):
@@ -322,7 +322,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
class HMPShell(QMPShell):
def __init__(self, address):
- QMPShell.__init__(self, address)
+ super().__init__(address)
self.__cpu_index = 0
def __cmd_completion(self):
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 39/72] scripts/qmp-shell: declare verbose in __init__
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (37 preceding siblings ...)
2021-06-18 23:04 ` [PULL 38/72] scripts/qmp-shell: Use python3-style super() John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 40/72] scripts/qmp-shell: use triple-double-quote docstring style John Snow
` (33 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Linters get angry when we don't define state at init time.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-10-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 1 +
1 file changed, 1 insertion(+)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 3066e37ae5..4027454324 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -120,6 +120,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
self._actions = list()
self._histfile = os.path.join(os.path.expanduser('~'),
'.qmp-shell_history')
+ self._verbose = False
def _fill_completion(self):
cmds = self.cmd('query-commands')
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 40/72] scripts/qmp-shell: use triple-double-quote docstring style
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (38 preceding siblings ...)
2021-06-18 23:04 ` [PULL 39/72] scripts/qmp-shell: declare verbose in __init__ John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 41/72] scripts/qmp-shell: ignore visit_Name name John Snow
` (32 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
(2014 me had never written python before.)
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-11-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 4027454324..c46f4f516b 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -94,9 +94,12 @@ class QMPShellError(Exception):
class FuzzyJSON(ast.NodeTransformer):
- '''This extension of ast.NodeTransformer filters literal "true/false/null"
+ """
+ This extension of ast.NodeTransformer filters literal "true/false/null"
values in an AST and replaces them by proper "True/False/None" values that
- Python can properly evaluate.'''
+ Python can properly evaluate.
+ """
+
@classmethod
def visit_Name(cls, node):
if node.id == 'true':
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 41/72] scripts/qmp-shell: ignore visit_Name name
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (39 preceding siblings ...)
2021-06-18 23:04 ` [PULL 40/72] scripts/qmp-shell: use triple-double-quote docstring style John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 42/72] scripts/qmp-shell: make QMPCompleter returns explicit John Snow
` (31 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Not something I control, sorry, pylint.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-12-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index c46f4f516b..ea6a87e0b3 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -101,7 +101,7 @@ class FuzzyJSON(ast.NodeTransformer):
"""
@classmethod
- def visit_Name(cls, node):
+ def visit_Name(cls, node): # pylint: disable=invalid-name
if node.id == 'true':
node.id = 'True'
if node.id == 'false':
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 42/72] scripts/qmp-shell: make QMPCompleter returns explicit
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (40 preceding siblings ...)
2021-06-18 23:04 ` [PULL 41/72] scripts/qmp-shell: ignore visit_Name name John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 43/72] scripts/qmp-shell: rename one and two-letter variables John Snow
` (30 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
This function returns None when it doesn't find a match; do that
explicitly.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-13-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index ea6a87e0b3..8d84467b53 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -83,10 +83,10 @@ class QMPCompleter(list):
def complete(self, text, state):
for cmd in self:
if cmd.startswith(text):
- if not state:
+ if state == 0:
return cmd
- else:
- state -= 1
+ state -= 1
+ return None
class QMPShellError(Exception):
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 43/72] scripts/qmp-shell: rename one and two-letter variables
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (41 preceding siblings ...)
2021-06-18 23:04 ` [PULL 42/72] scripts/qmp-shell: make QMPCompleter returns explicit John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 44/72] scripts/qmp-shell: fix shell history exception handling John Snow
` (29 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
A bit of churn and housekeeping for pylint, flake8 et al.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-14-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 8d84467b53..afb4b0c544 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -176,8 +176,8 @@ class QMPShell(qmp.QEMUMonitorProtocol):
pass
# Try once again as FuzzyJSON:
try:
- st = ast.parse(val, mode='eval')
- return ast.literal_eval(FuzzyJSON().visit(st))
+ tree = ast.parse(val, mode='eval')
+ return ast.literal_eval(FuzzyJSON().visit(tree))
except SyntaxError:
pass
except ValueError:
@@ -195,14 +195,14 @@ class QMPShell(qmp.QEMUMonitorProtocol):
value = self.__parse_value(val)
optpath = key.split('.')
curpath = []
- for p in optpath[:-1]:
- curpath.append(p)
- d = parent.get(p, {})
- if type(d) is not dict:
+ for path in optpath[:-1]:
+ curpath.append(path)
+ obj = parent.get(path, {})
+ if type(obj) is not dict:
msg = 'Cannot use "{:s}" as both leaf and non-leaf key'
raise QMPShellError(msg.format('.'.join(curpath)))
- parent[p] = d
- parent = d
+ parent[path] = obj
+ parent = obj
if optpath[-1] in parent:
if type(parent[optpath[-1]]) is dict:
msg = 'Cannot use "{:s}" as both leaf and non-leaf key'
@@ -267,8 +267,8 @@ class QMPShell(qmp.QEMUMonitorProtocol):
def _execute_cmd(self, cmdline):
try:
qmpcmd = self.__build_cmd(cmdline)
- except Exception as e:
- print('Error while parsing command line: %s' % e)
+ except Exception as err:
+ print('Error while parsing command line: %s' % err)
print('command format: <command-name> ', end=' ')
print('[arg-name1=arg1] ... [arg-nameN=argN]')
return True
@@ -313,8 +313,8 @@ class QMPShell(qmp.QEMUMonitorProtocol):
print()
return False
if cmdline == '':
- for ev in self.get_events():
- print(ev)
+ for event in self.get_events():
+ print(event)
self.clear_events()
return True
else:
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 44/72] scripts/qmp-shell: fix shell history exception handling
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (42 preceding siblings ...)
2021-06-18 23:04 ` [PULL 43/72] scripts/qmp-shell: rename one and two-letter variables John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 45/72] scripts/qmp-shell: remove if-raise-else patterns John Snow
` (28 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
We want to remove exceptions that are too broad here; we only want to
catch IOErrors that get raised as a direct result of the open call.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-15-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 15 ++++++---------
1 file changed, 6 insertions(+), 9 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index afb4b0c544..80cd432607 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -67,7 +67,6 @@
import ast
import atexit
-import errno
import json
import os
import re
@@ -143,19 +142,17 @@ class QMPShell(qmp.QEMUMonitorProtocol):
readline.set_completer_delims('')
try:
readline.read_history_file(self._histfile)
- except Exception as e:
- if isinstance(e, IOError) and e.errno == errno.ENOENT:
- # File not found. No problem.
- pass
- else:
- print("Failed to read history '%s'; %s" % (self._histfile, e))
+ except FileNotFoundError:
+ pass
+ except IOError as err:
+ print(f"Failed to read history '{self._histfile}': {err!s}")
atexit.register(self.__save_history)
def __save_history(self):
try:
readline.write_history_file(self._histfile)
- except Exception as e:
- print("Failed to save history file '%s'; %s" % (self._histfile, e))
+ except IOError as err:
+ print(f"Failed to save history file '{self._histfile}': {err!s}")
@classmethod
def __parse_value(cls, val):
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 45/72] scripts/qmp-shell: remove if-raise-else patterns
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (43 preceding siblings ...)
2021-06-18 23:04 ` [PULL 44/72] scripts/qmp-shell: fix shell history exception handling John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 46/72] scripts/qmp-shell: use isinstance() instead of type() John Snow
` (27 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Shushes pylint. I don't always mind these patterns personally, but I'm
not as sure that I want to remove the warning from pylint's repertoire
entirely. Oh well.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-16-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 80cd432607..bf7a49dfc1 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -204,8 +204,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
if type(parent[optpath[-1]]) is dict:
msg = 'Cannot use "{:s}" as both leaf and non-leaf key'
raise QMPShellError(msg.format('.'.join(curpath)))
- else:
- raise QMPShellError(f'Cannot set "{key}" multiple times')
+ raise QMPShellError(f'Cannot set "{key}" multiple times')
parent[optpath[-1]] = value
def __build_cmd(self, cmdline):
@@ -309,13 +308,14 @@ class QMPShell(qmp.QEMUMonitorProtocol):
except EOFError:
print()
return False
+
if cmdline == '':
for event in self.get_events():
print(event)
self.clear_events()
return True
- else:
- return self._execute_cmd(cmdline)
+
+ return self._execute_cmd(cmdline)
def set_verbosity(self, verbose):
self._verbose = verbose
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 46/72] scripts/qmp-shell: use isinstance() instead of type()
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (44 preceding siblings ...)
2021-06-18 23:04 ` [PULL 45/72] scripts/qmp-shell: remove if-raise-else patterns John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 47/72] scripts/qmp-shell: use argparse John Snow
` (26 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
A bit more idiomatic, and quiets some linter warnings.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-17-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index bf7a49dfc1..970f43dd00 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -195,13 +195,13 @@ class QMPShell(qmp.QEMUMonitorProtocol):
for path in optpath[:-1]:
curpath.append(path)
obj = parent.get(path, {})
- if type(obj) is not dict:
+ if not isinstance(obj, dict):
msg = 'Cannot use "{:s}" as both leaf and non-leaf key'
raise QMPShellError(msg.format('.'.join(curpath)))
parent[path] = obj
parent = obj
if optpath[-1] in parent:
- if type(parent[optpath[-1]]) is dict:
+ if isinstance(parent[optpath[-1]], dict):
msg = 'Cannot use "{:s}" as both leaf and non-leaf key'
raise QMPShellError(msg.format('.'.join(curpath)))
raise QMPShellError(f'Cannot set "{key}" multiple times')
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 47/72] scripts/qmp-shell: use argparse
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (45 preceding siblings ...)
2021-06-18 23:04 ` [PULL 46/72] scripts/qmp-shell: use isinstance() instead of type() John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 48/72] scripts/qmp-shell: Add pretty attribute to HMP shell John Snow
` (25 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Use argparse instead of an open-coded CLI parser, for consistency with
everything else.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-18-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 82 +++++++++++++++++--------------------------
1 file changed, 32 insertions(+), 50 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 970f43dd00..5317dcd516 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -64,7 +64,7 @@
# Use the -v and -p options to activate the verbose and pretty-print options,
# which will echo back the properly formatted JSON-compliant QMP that is being
# sent to QEMU, which is useful for debugging and documentation generation.
-
+import argparse
import ast
import atexit
import json
@@ -401,65 +401,47 @@ def die(msg):
sys.exit(1)
-def fail_cmdline(option=None):
- if option:
- sys.stderr.write('ERROR: bad command-line option \'%s\'\n' % option)
- sys.stderr.write(
- 'qmp-shell [ -v ] [ -p ] [ -H ] [ -N ] '
- '< UNIX socket path> | < TCP address:port >\n'
- )
- sys.stderr.write(' -v Verbose (echo command sent and received)\n')
- sys.stderr.write(' -p Pretty-print JSON\n')
- sys.stderr.write(' -H Use HMP interface\n')
- sys.stderr.write(' -N Skip negotiate (for qemu-ga)\n')
- sys.exit(1)
-
-
def main():
- addr = ''
- qemu = None
- hmp = False
- pretty = False
- verbose = False
- negotiate = True
+ parser = argparse.ArgumentParser()
+ parser.add_argument('-H', '--hmp', action='store_true',
+ help='Use HMP interface')
+ parser.add_argument('-N', '--skip-negotiation', action='store_true',
+ help='Skip negotiate (for qemu-ga)')
+ 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')
+ default_server = os.environ.get('QMP_SOCKET')
+ parser.add_argument('qmp_server', action='store',
+ default=default_server,
+ help='< UNIX socket path | TCP address:port >')
+
+ args = parser.parse_args()
+ if args.qmp_server is None:
+ parser.error("QMP socket or TCP address must be specified")
+
+ qemu: QMPShell
try:
- for arg in sys.argv[1:]:
- if arg == "-H":
- if qemu is not None:
- fail_cmdline(arg)
- hmp = True
- elif arg == "-p":
- pretty = True
- elif arg == "-N":
- negotiate = False
- elif arg == "-v":
- verbose = True
- else:
- if qemu is not None:
- fail_cmdline(arg)
- if hmp:
- qemu = HMPShell(arg)
- else:
- qemu = QMPShell(arg, pretty)
- addr = arg
-
- if qemu is None:
- fail_cmdline()
+ if args.hmp:
+ qemu = HMPShell(args.qmp_server)
+ else:
+ qemu = QMPShell(args.qmp_server, args.pretty)
except qmp.QMPBadPortError:
- die('bad port number in command-line')
+ parser.error(f"Bad port number: {args.qmp_server}")
+ return # pycharm doesn't know error() is noreturn
try:
- qemu.connect(negotiate)
+ qemu.connect(negotiate=not args.skip_negotiation)
except qmp.QMPConnectError:
- die('Didn\'t get QMP greeting message')
+ die("Didn't get QMP greeting message")
except qmp.QMPCapabilitiesError:
- die('Could not negotiate capabilities')
- except OSError:
- die('Could not connect to %s' % addr)
+ die("Couldn't negotiate capabilities")
+ except OSError as err:
+ die(f"Couldn't connect to {args.qmp_server}: {err!s}")
qemu.show_banner()
- qemu.set_verbosity(verbose)
+ qemu.set_verbosity(args.verbose)
while qemu.read_exec_command(qemu.get_prompt()):
pass
qemu.close()
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 48/72] scripts/qmp-shell: Add pretty attribute to HMP shell
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (46 preceding siblings ...)
2021-06-18 23:04 ` [PULL 47/72] scripts/qmp-shell: use argparse John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 49/72] scripts/qmp-shell: Make verbose a public attribute John Snow
` (24 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
It's less useful, but it makes the initialization methods LSP
consistent, which quiets a mypy complaint.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-19-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 11 ++++-------
1 file changed, 4 insertions(+), 7 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 5317dcd516..de5fa189f0 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -322,8 +322,8 @@ class QMPShell(qmp.QEMUMonitorProtocol):
class HMPShell(QMPShell):
- def __init__(self, address):
- super().__init__(address)
+ def __init__(self, address, pretty=False):
+ super().__init__(address, pretty)
self.__cpu_index = 0
def __cmd_completion(self):
@@ -421,12 +421,9 @@ def main():
if args.qmp_server is None:
parser.error("QMP socket or TCP address must be specified")
- qemu: QMPShell
+ shell_class = HMPShell if args.hmp else QMPShell
try:
- if args.hmp:
- qemu = HMPShell(args.qmp_server)
- else:
- qemu = QMPShell(args.qmp_server, args.pretty)
+ qemu = shell_class(args.qmp_server, args.pretty)
except qmp.QMPBadPortError:
parser.error(f"Bad port number: {args.qmp_server}")
return # pycharm doesn't know error() is noreturn
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 49/72] scripts/qmp-shell: Make verbose a public attribute
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (47 preceding siblings ...)
2021-06-18 23:04 ` [PULL 48/72] scripts/qmp-shell: Add pretty attribute to HMP shell John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 50/72] scripts/qmp-shell: move get_prompt() to prompt property John Snow
` (23 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
No real reason to hide this behind an underscore; make it part of the
initializer and make it a regular RW attribute.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-20-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 16 ++++++----------
1 file changed, 6 insertions(+), 10 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index de5fa189f0..cfcefb95f9 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -113,7 +113,7 @@ class FuzzyJSON(ast.NodeTransformer):
# TODO: QMPShell's interface is a bit ugly (eg. _fill_completion() and
# _execute_cmd()). Let's design a better one.
class QMPShell(qmp.QEMUMonitorProtocol):
- def __init__(self, address, pretty=False):
+ def __init__(self, address, pretty=False, verbose=False):
super().__init__(self.parse_address(address))
self._greeting = None
self._completer = None
@@ -122,7 +122,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
self._actions = list()
self._histfile = os.path.join(os.path.expanduser('~'),
'.qmp-shell_history')
- self._verbose = False
+ self.verbose = verbose
def _fill_completion(self):
cmds = self.cmd('query-commands')
@@ -271,7 +271,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
# For transaction mode, we may have just cached the action:
if qmpcmd is None:
return True
- if self._verbose:
+ if self.verbose:
self._print(qmpcmd)
resp = self.cmd_obj(qmpcmd)
if resp is None:
@@ -317,13 +317,10 @@ class QMPShell(qmp.QEMUMonitorProtocol):
return self._execute_cmd(cmdline)
- def set_verbosity(self, verbose):
- self._verbose = verbose
-
class HMPShell(QMPShell):
- def __init__(self, address, pretty=False):
- super().__init__(address, pretty)
+ def __init__(self, address, pretty=False, verbose=False):
+ super().__init__(address, pretty, verbose)
self.__cpu_index = 0
def __cmd_completion(self):
@@ -423,7 +420,7 @@ def main():
shell_class = HMPShell if args.hmp else QMPShell
try:
- qemu = shell_class(args.qmp_server, args.pretty)
+ qemu = shell_class(args.qmp_server, args.pretty, args.verbose)
except qmp.QMPBadPortError:
parser.error(f"Bad port number: {args.qmp_server}")
return # pycharm doesn't know error() is noreturn
@@ -438,7 +435,6 @@ def main():
die(f"Couldn't connect to {args.qmp_server}: {err!s}")
qemu.show_banner()
- qemu.set_verbosity(args.verbose)
while qemu.read_exec_command(qemu.get_prompt()):
pass
qemu.close()
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 50/72] scripts/qmp-shell: move get_prompt() to prompt property
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (48 preceding siblings ...)
2021-06-18 23:04 ` [PULL 49/72] scripts/qmp-shell: Make verbose a public attribute John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 51/72] scripts/qmp-shell: remove prompt argument from read_exec_command John Snow
` (22 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Small tidying; treat "prompt" like an immutable property instead of
function/method/routine.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-21-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index cfcefb95f9..3b86ef7d88 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -292,10 +292,11 @@ class QMPShell(qmp.QEMUMonitorProtocol):
version = self._greeting['QMP']['version']['qemu']
print("Connected to QEMU {major}.{minor}.{micro}\n".format(**version))
- def get_prompt(self):
+ @property
+ def prompt(self):
if self._transmode:
- return "TRANS> "
- return "(QEMU) "
+ return 'TRANS> '
+ return '(QEMU) '
def read_exec_command(self, prompt):
"""
@@ -435,7 +436,7 @@ def main():
die(f"Couldn't connect to {args.qmp_server}: {err!s}")
qemu.show_banner()
- while qemu.read_exec_command(qemu.get_prompt()):
+ while qemu.read_exec_command(qemu.prompt):
pass
qemu.close()
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 51/72] scripts/qmp-shell: remove prompt argument from read_exec_command
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (49 preceding siblings ...)
2021-06-18 23:04 ` [PULL 50/72] scripts/qmp-shell: move get_prompt() to prompt property John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 52/72] scripts/qmp-shell: move the REPL functionality into QMPShell John Snow
` (21 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
It's only ever used by one caller, we can just absorb that logic.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-22-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 3b86ef7d88..31269859c4 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -298,14 +298,14 @@ class QMPShell(qmp.QEMUMonitorProtocol):
return 'TRANS> '
return '(QEMU) '
- def read_exec_command(self, prompt):
+ def read_exec_command(self):
"""
Read and execute a command.
@return True if execution was ok, return False if disconnected.
"""
try:
- cmdline = input(prompt)
+ cmdline = input(self.prompt)
except EOFError:
print()
return False
@@ -436,7 +436,7 @@ def main():
die(f"Couldn't connect to {args.qmp_server}: {err!s}")
qemu.show_banner()
- while qemu.read_exec_command(qemu.prompt):
+ while qemu.read_exec_command():
pass
qemu.close()
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 52/72] scripts/qmp-shell: move the REPL functionality into QMPShell
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (50 preceding siblings ...)
2021-06-18 23:04 ` [PULL 51/72] scripts/qmp-shell: remove prompt argument from read_exec_command John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 53/72] scripts/qmp-shell: Fix "FuzzyJSON" parser John Snow
` (20 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Instead of doing this in main, move it into the class itself. (This
makes it easier to put into the qemu.qmp package later by removing as
much as we can from the main() function.)
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-23-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 31269859c4..aa148517a8 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -318,6 +318,12 @@ class QMPShell(qmp.QEMUMonitorProtocol):
return self._execute_cmd(cmdline)
+ def repl(self):
+ self.show_banner()
+ while self.read_exec_command():
+ yield
+ self.close()
+
class HMPShell(QMPShell):
def __init__(self, address, pretty=False, verbose=False):
@@ -435,10 +441,8 @@ def main():
except OSError as err:
die(f"Couldn't connect to {args.qmp_server}: {err!s}")
- qemu.show_banner()
- while qemu.read_exec_command():
+ for _ in qemu.repl():
pass
- qemu.close()
if __name__ == '__main__':
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 53/72] scripts/qmp-shell: Fix "FuzzyJSON" parser
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (51 preceding siblings ...)
2021-06-18 23:04 ` [PULL 52/72] scripts/qmp-shell: move the REPL functionality into QMPShell John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 54/72] scripts/qmp-shell: refactor QMPCompleter John Snow
` (19 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
I'm not sure when this regressed (Or maybe if it was ever working right
to begin with?), but the Python AST requires you to change "Names" to
"Constants" in order to truly convert `false` to `False`.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-24-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index aa148517a8..847d34890f 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -95,18 +95,19 @@ class QMPShellError(Exception):
class FuzzyJSON(ast.NodeTransformer):
"""
This extension of ast.NodeTransformer filters literal "true/false/null"
- values in an AST and replaces them by proper "True/False/None" values that
- Python can properly evaluate.
+ values in a Python AST and replaces them by proper "True/False/None" values
+ that Python can properly evaluate.
"""
@classmethod
- def visit_Name(cls, node): # pylint: disable=invalid-name
+ def visit_Name(cls, # pylint: disable=invalid-name
+ node: ast.Name) -> ast.AST:
if node.id == 'true':
- node.id = 'True'
+ return ast.Constant(value=True)
if node.id == 'false':
- node.id = 'False'
+ return ast.Constant(value=False)
if node.id == 'null':
- node.id = 'None'
+ return ast.Constant(value=None)
return node
@@ -174,10 +175,9 @@ class QMPShell(qmp.QEMUMonitorProtocol):
# Try once again as FuzzyJSON:
try:
tree = ast.parse(val, mode='eval')
- return ast.literal_eval(FuzzyJSON().visit(tree))
- except SyntaxError:
- pass
- except ValueError:
+ transformed = FuzzyJSON().visit(tree)
+ return ast.literal_eval(transformed)
+ except (SyntaxError, ValueError):
pass
return val
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 54/72] scripts/qmp-shell: refactor QMPCompleter
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (52 preceding siblings ...)
2021-06-18 23:04 ` [PULL 53/72] scripts/qmp-shell: Fix "FuzzyJSON" parser John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 55/72] scripts/qmp-shell: initialize completer early John Snow
` (18 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
list is a generic type, but we expect to use strings directly. We could
subclass list[str], but pylint does not presently understand that
invocation.
Change this class to envelop a list instead of *being* a list, for
simpler mypy typing.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-25-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 14 +++++++++++---
1 file changed, 11 insertions(+), 3 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 847d34890f..73694035b2 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -78,9 +78,17 @@ sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
from qemu import qmp
-class QMPCompleter(list):
- def complete(self, text, state):
- for cmd in self:
+class QMPCompleter:
+ # NB: Python 3.9+ will probably allow us to subclass list[str] directly,
+ # but pylint as of today does not know that List[str] is simply 'list'.
+ def __init__(self) -> None:
+ self._matches: List[str] = []
+
+ def append(self, value: str) -> None:
+ return self._matches.append(value)
+
+ def complete(self, text: str, state: int) -> Optional[str]:
+ for cmd in self._matches:
if cmd.startswith(text):
if state == 0:
return cmd
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 55/72] scripts/qmp-shell: initialize completer early
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (53 preceding siblings ...)
2021-06-18 23:04 ` [PULL 54/72] scripts/qmp-shell: refactor QMPCompleter John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 56/72] python/qmp: add QMPObject type alias John Snow
` (17 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Add an empty completer as a more type-safe placeholder instead of
'None'.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-26-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 73694035b2..670361322c 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -125,7 +125,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
def __init__(self, address, pretty=False, verbose=False):
super().__init__(self.parse_address(address))
self._greeting = None
- self._completer = None
+ self._completer = QMPCompleter()
self._pretty = pretty
self._transmode = False
self._actions = list()
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 56/72] python/qmp: add QMPObject type alias
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (54 preceding siblings ...)
2021-06-18 23:04 ` [PULL 55/72] scripts/qmp-shell: initialize completer early John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 57/72] scripts/qmp-shell: add mypy types John Snow
` (16 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
This is meant to represent any generic object seen in a QMPMessage, not
just the root object itself.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-27-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/qmp/__init__.py | 3 +++
1 file changed, 3 insertions(+)
diff --git a/python/qemu/qmp/__init__.py b/python/qemu/qmp/__init__.py
index a6e1a7b857..ba0d2281d6 100644
--- a/python/qemu/qmp/__init__.py
+++ b/python/qemu/qmp/__init__.py
@@ -41,6 +41,9 @@
#: 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.
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 57/72] scripts/qmp-shell: add mypy types
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (55 preceding siblings ...)
2021-06-18 23:04 ` [PULL 56/72] python/qmp: add QMPObject type alias John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 58/72] scripts/qmp-shell: Accept SocketAddrT instead of string John Snow
` (15 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
As per my usual, this patch is annotations only. Any changes with side
effects are done elsewhere.
Note: pylint does not understand the subscripts for Collection in Python 3.6,
so use the stronger Sequence type as a workaround.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-28-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 67 ++++++++++++++++++++++++++-----------------
1 file changed, 41 insertions(+), 26 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 670361322c..2d0e85b5f7 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -72,10 +72,18 @@ import os
import re
import readline
import sys
+from typing import (
+ Iterator,
+ List,
+ NoReturn,
+ Optional,
+ Sequence,
+)
sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
from qemu import qmp
+from qemu.qmp import QMPMessage
class QMPCompleter:
@@ -122,25 +130,26 @@ class FuzzyJSON(ast.NodeTransformer):
# TODO: QMPShell's interface is a bit ugly (eg. _fill_completion() and
# _execute_cmd()). Let's design a better one.
class QMPShell(qmp.QEMUMonitorProtocol):
- def __init__(self, address, pretty=False, verbose=False):
+ def __init__(self, address: str, pretty: bool = False,
+ verbose: bool = False):
super().__init__(self.parse_address(address))
- self._greeting = None
+ self._greeting: Optional[QMPMessage] = None
self._completer = QMPCompleter()
self._pretty = pretty
self._transmode = False
- self._actions = list()
+ self._actions: List[QMPMessage] = []
self._histfile = os.path.join(os.path.expanduser('~'),
'.qmp-shell_history')
self.verbose = verbose
- def _fill_completion(self):
+ def _fill_completion(self) -> None:
cmds = self.cmd('query-commands')
if 'error' in cmds:
return
for cmd in cmds['return']:
self._completer.append(cmd['name'])
- def __completer_setup(self):
+ def __completer_setup(self) -> None:
self._completer = QMPCompleter()
self._fill_completion()
readline.set_history_length(1024)
@@ -157,14 +166,14 @@ class QMPShell(qmp.QEMUMonitorProtocol):
print(f"Failed to read history '{self._histfile}': {err!s}")
atexit.register(self.__save_history)
- def __save_history(self):
+ def __save_history(self) -> None:
try:
readline.write_history_file(self._histfile)
except IOError as err:
print(f"Failed to save history file '{self._histfile}': {err!s}")
@classmethod
- def __parse_value(cls, val):
+ def __parse_value(cls, val: str) -> object:
try:
return int(val)
except ValueError:
@@ -189,7 +198,9 @@ class QMPShell(qmp.QEMUMonitorProtocol):
pass
return val
- def __cli_expr(self, tokens, parent):
+ def __cli_expr(self,
+ tokens: Sequence[str],
+ parent: qmp.QMPObject) -> None:
for arg in tokens:
(key, sep, val) = arg.partition('=')
if sep != '=':
@@ -215,7 +226,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
raise QMPShellError(f'Cannot set "{key}" multiple times')
parent[optpath[-1]] = value
- def __build_cmd(self, cmdline):
+ def __build_cmd(self, cmdline: str) -> Optional[QMPMessage]:
"""
Build a QMP input object from a user provided command-line in the
following format:
@@ -224,6 +235,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
"""
argument_regex = r'''(?:[^\s"']|"(?:\\.|[^"])*"|'(?:\\.|[^'])*')+'''
cmdargs = re.findall(argument_regex, cmdline)
+ qmpcmd: QMPMessage
# Transactional CLI entry/exit:
if cmdargs[0] == 'transaction(':
@@ -261,14 +273,14 @@ class QMPShell(qmp.QEMUMonitorProtocol):
self.__cli_expr(cmdargs[1:], qmpcmd['arguments'])
return qmpcmd
- def _print(self, qmp_message):
+ def _print(self, qmp_message: object) -> None:
indent = None
if self._pretty:
indent = 4
jsobj = json.dumps(qmp_message, indent=indent, sort_keys=self._pretty)
print(str(jsobj))
- def _execute_cmd(self, cmdline):
+ def _execute_cmd(self, cmdline: str) -> bool:
try:
qmpcmd = self.__build_cmd(cmdline)
except Exception as err:
@@ -288,11 +300,12 @@ class QMPShell(qmp.QEMUMonitorProtocol):
self._print(resp)
return True
- def connect(self, negotiate: bool = True):
+ def connect(self, negotiate: bool = True) -> None:
self._greeting = super().connect(negotiate)
self.__completer_setup()
- def show_banner(self, msg='Welcome to the QMP low-level shell!'):
+ def show_banner(self,
+ msg: str = 'Welcome to the QMP low-level shell!') -> None:
print(msg)
if not self._greeting:
print('Connected')
@@ -301,12 +314,12 @@ class QMPShell(qmp.QEMUMonitorProtocol):
print("Connected to QEMU {major}.{minor}.{micro}\n".format(**version))
@property
- def prompt(self):
+ def prompt(self) -> str:
if self._transmode:
return 'TRANS> '
return '(QEMU) '
- def read_exec_command(self):
+ def read_exec_command(self) -> bool:
"""
Read and execute a command.
@@ -326,7 +339,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
return self._execute_cmd(cmdline)
- def repl(self):
+ def repl(self) -> Iterator[None]:
self.show_banner()
while self.read_exec_command():
yield
@@ -334,11 +347,12 @@ class QMPShell(qmp.QEMUMonitorProtocol):
class HMPShell(QMPShell):
- def __init__(self, address, pretty=False, verbose=False):
+ def __init__(self, address: str,
+ pretty: bool = False, verbose: bool = False):
super().__init__(address, pretty, verbose)
self.__cpu_index = 0
- def __cmd_completion(self):
+ def __cmd_completion(self) -> None:
for cmd in self.__cmd_passthrough('help')['return'].split('\r\n'):
if cmd and cmd[0] != '[' and cmd[0] != '\t':
name = cmd.split()[0] # drop help text
@@ -355,21 +369,22 @@ class HMPShell(QMPShell):
self._completer.append(name)
self._completer.append('help ' + name) # help completion
- def __info_completion(self):
+ def __info_completion(self) -> None:
for cmd in self.__cmd_passthrough('info')['return'].split('\r\n'):
if cmd:
self._completer.append('info ' + cmd.split()[1])
- def __other_completion(self):
+ def __other_completion(self) -> None:
# special cases
self._completer.append('help info')
- def _fill_completion(self):
+ def _fill_completion(self) -> None:
self.__cmd_completion()
self.__info_completion()
self.__other_completion()
- def __cmd_passthrough(self, cmdline, cpu_index=0):
+ def __cmd_passthrough(self, cmdline: str,
+ cpu_index: int = 0) -> QMPMessage:
return self.cmd_obj({
'execute': 'human-monitor-command',
'arguments': {
@@ -378,7 +393,7 @@ class HMPShell(QMPShell):
}
})
- def _execute_cmd(self, cmdline):
+ def _execute_cmd(self, cmdline: str) -> bool:
if cmdline.split()[0] == "cpu":
# trap the cpu command, it requires special setting
try:
@@ -404,16 +419,16 @@ class HMPShell(QMPShell):
print('%s: %s' % (resp['error']['class'], resp['error']['desc']))
return True
- def show_banner(self, msg='Welcome to the HMP shell!'):
+ def show_banner(self, msg: str = 'Welcome to the HMP shell!') -> None:
QMPShell.show_banner(self, msg)
-def die(msg):
+def die(msg: str) -> NoReturn:
sys.stderr.write('ERROR: %s\n' % msg)
sys.exit(1)
-def main():
+def main() -> None:
parser = argparse.ArgumentParser()
parser.add_argument('-H', '--hmp', action='store_true',
help='Use HMP interface')
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 58/72] scripts/qmp-shell: Accept SocketAddrT instead of string
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (56 preceding siblings ...)
2021-06-18 23:04 ` [PULL 57/72] scripts/qmp-shell: add mypy types John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 59/72] scripts/qmp-shell: unprivatize 'pretty' property John Snow
` (14 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Don't "extend" QEMUMonitorProtocol by changing the argument types. Move
the string parsing just outside of the class instead.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-29-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 2d0e85b5f7..b465c7f9e2 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -130,9 +130,9 @@ class FuzzyJSON(ast.NodeTransformer):
# TODO: QMPShell's interface is a bit ugly (eg. _fill_completion() and
# _execute_cmd()). Let's design a better one.
class QMPShell(qmp.QEMUMonitorProtocol):
- def __init__(self, address: str, pretty: bool = False,
- verbose: bool = False):
- super().__init__(self.parse_address(address))
+ def __init__(self, address: qmp.SocketAddrT,
+ pretty: bool = False, verbose: bool = False):
+ super().__init__(address)
self._greeting: Optional[QMPMessage] = None
self._completer = QMPCompleter()
self._pretty = pretty
@@ -347,7 +347,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
class HMPShell(QMPShell):
- def __init__(self, address: str,
+ def __init__(self, address: qmp.SocketAddrT,
pretty: bool = False, verbose: bool = False):
super().__init__(address, pretty, verbose)
self.__cpu_index = 0
@@ -450,11 +450,13 @@ def main() -> None:
shell_class = HMPShell if args.hmp else QMPShell
try:
- qemu = shell_class(args.qmp_server, args.pretty, args.verbose)
+ address = shell_class.parse_address(args.qmp_server)
except qmp.QMPBadPortError:
parser.error(f"Bad port number: {args.qmp_server}")
return # pycharm doesn't know error() is noreturn
+ qemu = shell_class(address, args.pretty, args.verbose)
+
try:
qemu.connect(negotiate=not args.skip_negotiation)
except qmp.QMPConnectError:
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 59/72] scripts/qmp-shell: unprivatize 'pretty' property
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (57 preceding siblings ...)
2021-06-18 23:04 ` [PULL 58/72] scripts/qmp-shell: Accept SocketAddrT instead of string John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 60/72] python/qmp: return generic type from context manager John Snow
` (13 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Similar to verbose, there's no reason this needs to be hidden.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-30-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index b465c7f9e2..f14fe211cc 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -135,11 +135,11 @@ class QMPShell(qmp.QEMUMonitorProtocol):
super().__init__(address)
self._greeting: Optional[QMPMessage] = None
self._completer = QMPCompleter()
- self._pretty = pretty
self._transmode = False
self._actions: List[QMPMessage] = []
self._histfile = os.path.join(os.path.expanduser('~'),
'.qmp-shell_history')
+ self.pretty = pretty
self.verbose = verbose
def _fill_completion(self) -> None:
@@ -274,10 +274,9 @@ class QMPShell(qmp.QEMUMonitorProtocol):
return qmpcmd
def _print(self, qmp_message: object) -> None:
- indent = None
- if self._pretty:
- indent = 4
- jsobj = json.dumps(qmp_message, indent=indent, sort_keys=self._pretty)
+ jsobj = json.dumps(qmp_message,
+ indent=4 if self.pretty else None,
+ sort_keys=self.pretty)
print(str(jsobj))
def _execute_cmd(self, cmdline: str) -> bool:
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 60/72] python/qmp: return generic type from context manager
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (58 preceding siblings ...)
2021-06-18 23:04 ` [PULL 59/72] scripts/qmp-shell: unprivatize 'pretty' property John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 61/72] scripts/qmp-shell: Use context manager instead of atexit John Snow
` (12 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
__enter__ can be invoked from a subclass, so it needs a more flexible
type.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-31-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/qmp/__init__.py | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/python/qemu/qmp/__init__.py b/python/qemu/qmp/__init__.py
index ba0d2281d6..376954cb6d 100644
--- a/python/qemu/qmp/__init__.py
+++ b/python/qemu/qmp/__init__.py
@@ -30,6 +30,7 @@
TextIO,
Tuple,
Type,
+ TypeVar,
Union,
cast,
)
@@ -220,7 +221,9 @@ def __get_events(self, wait: Union[bool, float] = False) -> None:
if ret is None:
raise QMPConnectError("Error while reading from socket")
- def __enter__(self) -> 'QEMUMonitorProtocol':
+ T = TypeVar('T')
+
+ def __enter__(self: T) -> T:
# Implement context manager enter function.
return self
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 61/72] scripts/qmp-shell: Use context manager instead of atexit
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (59 preceding siblings ...)
2021-06-18 23:04 ` [PULL 60/72] python/qmp: return generic type from context manager John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 62/72] scripts/qmp-shell: use logging to show warnings John Snow
` (11 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
We can invoke the shell history writing when we leave the QMPShell scope
instead of relying on atexit. Doing so may be preferable to avoid global
state being registered from within a class instead of from the
application logic directly.
Use QMP's context manager to hook this history saving at close time,
which gets invoked when we leave the context block.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-32-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 33 ++++++++++++++++++---------------
1 file changed, 18 insertions(+), 15 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index f14fe211cc..ec028d662e 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -66,7 +66,6 @@
# sent to QEMU, which is useful for debugging and documentation generation.
import argparse
import ast
-import atexit
import json
import os
import re
@@ -142,6 +141,11 @@ class QMPShell(qmp.QEMUMonitorProtocol):
self.pretty = pretty
self.verbose = verbose
+ def close(self) -> None:
+ # Hook into context manager of parent to save shell history.
+ self._save_history()
+ super().close()
+
def _fill_completion(self) -> None:
cmds = self.cmd('query-commands')
if 'error' in cmds:
@@ -164,9 +168,8 @@ class QMPShell(qmp.QEMUMonitorProtocol):
pass
except IOError as err:
print(f"Failed to read history '{self._histfile}': {err!s}")
- atexit.register(self.__save_history)
- def __save_history(self) -> None:
+ def _save_history(self) -> None:
try:
readline.write_history_file(self._histfile)
except IOError as err:
@@ -448,25 +451,25 @@ def main() -> None:
parser.error("QMP socket or TCP address must be specified")
shell_class = HMPShell if args.hmp else QMPShell
+
try:
address = shell_class.parse_address(args.qmp_server)
except qmp.QMPBadPortError:
parser.error(f"Bad port number: {args.qmp_server}")
return # pycharm doesn't know error() is noreturn
- qemu = shell_class(address, args.pretty, args.verbose)
+ with shell_class(address, args.pretty, args.verbose) as qemu:
+ try:
+ qemu.connect(negotiate=not args.skip_negotiation)
+ except qmp.QMPConnectError:
+ die("Didn't get QMP greeting message")
+ except qmp.QMPCapabilitiesError:
+ die("Couldn't negotiate capabilities")
+ except OSError as err:
+ die(f"Couldn't connect to {args.qmp_server}: {err!s}")
- try:
- qemu.connect(negotiate=not args.skip_negotiation)
- except qmp.QMPConnectError:
- die("Didn't get QMP greeting message")
- except qmp.QMPCapabilitiesError:
- die("Couldn't negotiate capabilities")
- except OSError as err:
- die(f"Couldn't connect to {args.qmp_server}: {err!s}")
-
- for _ in qemu.repl():
- pass
+ for _ in qemu.repl():
+ pass
if __name__ == '__main__':
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 62/72] scripts/qmp-shell: use logging to show warnings
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (60 preceding siblings ...)
2021-06-18 23:04 ` [PULL 61/72] scripts/qmp-shell: Use context manager instead of atexit John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 63/72] scripts/qmp-shell: remove TODO John Snow
` (10 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
A perfect candidate is non-fatal shell history messages.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-33-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index ec028d662e..0199a13a34 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -67,6 +67,7 @@
import argparse
import ast
import json
+import logging
import os
import re
import readline
@@ -85,6 +86,9 @@ from qemu import qmp
from qemu.qmp import QMPMessage
+LOG = logging.getLogger(__name__)
+
+
class QMPCompleter:
# NB: Python 3.9+ will probably allow us to subclass list[str] directly,
# but pylint as of today does not know that List[str] is simply 'list'.
@@ -167,13 +171,15 @@ class QMPShell(qmp.QEMUMonitorProtocol):
except FileNotFoundError:
pass
except IOError as err:
- print(f"Failed to read history '{self._histfile}': {err!s}")
+ msg = f"Failed to read history '{self._histfile}': {err!s}"
+ LOG.warning(msg)
def _save_history(self) -> None:
try:
readline.write_history_file(self._histfile)
except IOError as err:
- print(f"Failed to save history file '{self._histfile}': {err!s}")
+ msg = f"Failed to save history file '{self._histfile}': {err!s}"
+ LOG.warning(msg)
@classmethod
def __parse_value(cls, val: str) -> object:
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 63/72] scripts/qmp-shell: remove TODO
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (61 preceding siblings ...)
2021-06-18 23:04 ` [PULL 62/72] scripts/qmp-shell: use logging to show warnings John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 64/72] scripts/qmp-shell: Fix empty-transaction invocation John Snow
` (9 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
We still want to revamp qmp-shell again, but there's much more to the
idea than the comment now intuits. Remove it.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-34-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 2 --
1 file changed, 2 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 0199a13a34..3c32b576a3 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -130,8 +130,6 @@ class FuzzyJSON(ast.NodeTransformer):
return node
-# TODO: QMPShell's interface is a bit ugly (eg. _fill_completion() and
-# _execute_cmd()). Let's design a better one.
class QMPShell(qmp.QEMUMonitorProtocol):
def __init__(self, address: qmp.SocketAddrT,
pretty: bool = False, verbose: bool = False):
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 64/72] scripts/qmp-shell: Fix empty-transaction invocation
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (62 preceding siblings ...)
2021-06-18 23:04 ` [PULL 63/72] scripts/qmp-shell: remove TODO John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 65/72] scripts/qmp-shell: Remove too-broad-exception John Snow
` (8 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
calling "transaction( )" is pointless, but valid. Rework the parser to
allow this kind of invocation. This helps clean up exception handling
later by removing accidental breakages of the parser that aren't
explicitly forbidden.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-35-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 3c32b576a3..78e4eae007 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -244,11 +244,14 @@ class QMPShell(qmp.QEMUMonitorProtocol):
cmdargs = re.findall(argument_regex, cmdline)
qmpcmd: QMPMessage
- # Transactional CLI entry/exit:
- if cmdargs[0] == 'transaction(':
+ # Transactional CLI entry:
+ if cmdargs and cmdargs[0] == 'transaction(':
self._transmode = True
+ self._actions = []
cmdargs.pop(0)
- elif cmdargs[0] == ')' and self._transmode:
+
+ # Transactional CLI exit:
+ if cmdargs and cmdargs[0] == ')' and self._transmode:
self._transmode = False
if len(cmdargs) > 1:
msg = 'Unexpected input after close of Transaction sub-shell'
@@ -257,15 +260,14 @@ class QMPShell(qmp.QEMUMonitorProtocol):
'execute': 'transaction',
'arguments': {'actions': self._actions}
}
- self._actions = list()
return qmpcmd
- # Nothing to process?
+ # No args, or no args remaining
if not cmdargs:
return None
- # Parse and then cache this Transactional Action
if self._transmode:
+ # Parse and cache this Transactional Action
finalize = False
action = {'type': cmdargs[0], 'data': {}}
if cmdargs[-1] == ')':
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 65/72] scripts/qmp-shell: Remove too-broad-exception
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (63 preceding siblings ...)
2021-06-18 23:04 ` [PULL 64/72] scripts/qmp-shell: Fix empty-transaction invocation John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 66/72] scripts/qmp-shell: convert usage comment to docstring John Snow
` (7 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
We are only anticipating QMPShellErrors here, for syntax we weren't able
to understand. Other errors, if any, should be allowed to percolate
upwards.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-36-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 78e4eae007..8d5845ab48 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -291,10 +291,13 @@ class QMPShell(qmp.QEMUMonitorProtocol):
def _execute_cmd(self, cmdline: str) -> bool:
try:
qmpcmd = self.__build_cmd(cmdline)
- except Exception as err:
- print('Error while parsing command line: %s' % err)
- print('command format: <command-name> ', end=' ')
- print('[arg-name1=arg1] ... [arg-nameN=argN]')
+ except QMPShellError as err:
+ print(
+ f"Error while parsing command line: {err!s}\n"
+ "command format: <command-name> "
+ "[arg-name1=arg1] ... [arg-nameN=argN",
+ file=sys.stderr
+ )
return True
# For transaction mode, we may have just cached the action:
if qmpcmd is None:
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 66/72] scripts/qmp-shell: convert usage comment to docstring
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (64 preceding siblings ...)
2021-06-18 23:04 ` [PULL 65/72] scripts/qmp-shell: Remove too-broad-exception John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 67/72] scripts/qmp-shell: remove double-underscores John Snow
` (6 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
The nice usage comment should be a docstring instead of a comment, so
that it's visible from other python tooling.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-37-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 128 ++++++++++++++++++++++++------------------
1 file changed, 72 insertions(+), 56 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 8d5845ab48..82fe16cff8 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -1,7 +1,5 @@
#!/usr/bin/env python3
#
-# Low-level QEMU shell on top of QMP.
-#
# Copyright (C) 2009, 2010 Red Hat Inc.
#
# Authors:
@@ -10,60 +8,78 @@
# This work is licensed under the terms of the GNU GPL, version 2. See
# the COPYING file in the top-level directory.
#
-# Usage:
-#
-# Start QEMU with:
-#
-# # qemu [...] -qmp unix:./qmp-sock,server
-#
-# Run the shell:
-#
-# $ qmp-shell ./qmp-sock
-#
-# Commands have the following format:
-#
-# < command-name > [ arg-name1=arg1 ] ... [ arg-nameN=argN ]
-#
-# For example:
-#
-# (QEMU) device_add driver=e1000 id=net1
-# {u'return': {}}
-# (QEMU)
-#
-# key=value pairs also support Python or JSON object literal subset notations,
-# without spaces. Dictionaries/objects {} are supported as are arrays [].
-#
-# example-command arg-name1={'key':'value','obj'={'prop':"value"}}
-#
-# Both JSON and Python formatting should work, including both styles of
-# string literal quotes. Both paradigms of literal values should work,
-# including null/true/false for JSON and None/True/False for Python.
-#
-#
-# Transactions have the following multi-line format:
-#
-# transaction(
-# action-name1 [ arg-name1=arg1 ] ... [arg-nameN=argN ]
-# ...
-# action-nameN [ arg-name1=arg1 ] ... [arg-nameN=argN ]
-# )
-#
-# One line transactions are also supported:
-#
-# transaction( action-name1 ... )
-#
-# For example:
-#
-# (QEMU) transaction(
-# TRANS> block-dirty-bitmap-add node=drive0 name=bitmap1
-# TRANS> block-dirty-bitmap-clear node=drive0 name=bitmap0
-# TRANS> )
-# {"return": {}}
-# (QEMU)
-#
-# Use the -v and -p options to activate the verbose and pretty-print options,
-# which will echo back the properly formatted JSON-compliant QMP that is being
-# sent to QEMU, which is useful for debugging and documentation generation.
+
+"""
+Low-level QEMU shell on top of QMP.
+
+usage: qmp-shell [-h] [-H] [-N] [-v] [-p] qmp_server
+
+positional arguments:
+ qmp_server < UNIX socket path | TCP address:port >
+
+optional arguments:
+ -h, --help show this help message and exit
+ -H, --hmp Use HMP interface
+ -N, --skip-negotiation
+ Skip negotiate (for qemu-ga)
+ -v, --verbose Verbose (echo commands sent and received)
+ -p, --pretty Pretty-print JSON
+
+
+Start QEMU with:
+
+# qemu [...] -qmp unix:./qmp-sock,server
+
+Run the shell:
+
+$ qmp-shell ./qmp-sock
+
+Commands have the following format:
+
+ < command-name > [ arg-name1=arg1 ] ... [ arg-nameN=argN ]
+
+For example:
+
+(QEMU) device_add driver=e1000 id=net1
+{'return': {}}
+(QEMU)
+
+key=value pairs also support Python or JSON object literal subset notations,
+without spaces. Dictionaries/objects {} are supported as are arrays [].
+
+ example-command arg-name1={'key':'value','obj'={'prop':"value"}}
+
+Both JSON and Python formatting should work, including both styles of
+string literal quotes. Both paradigms of literal values should work,
+including null/true/false for JSON and None/True/False for Python.
+
+
+Transactions have the following multi-line format:
+
+ transaction(
+ action-name1 [ arg-name1=arg1 ] ... [arg-nameN=argN ]
+ ...
+ action-nameN [ arg-name1=arg1 ] ... [arg-nameN=argN ]
+ )
+
+One line transactions are also supported:
+
+ transaction( action-name1 ... )
+
+For example:
+
+ (QEMU) transaction(
+ TRANS> block-dirty-bitmap-add node=drive0 name=bitmap1
+ TRANS> block-dirty-bitmap-clear node=drive0 name=bitmap0
+ TRANS> )
+ {"return": {}}
+ (QEMU)
+
+Use the -v and -p options to activate the verbose and pretty-print options,
+which will echo back the properly formatted JSON-compliant QMP that is being
+sent to QEMU, which is useful for debugging and documentation generation.
+"""
+
import argparse
import ast
import json
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 67/72] scripts/qmp-shell: remove double-underscores
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (65 preceding siblings ...)
2021-06-18 23:04 ` [PULL 66/72] scripts/qmp-shell: convert usage comment to docstring John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 68/72] scripts/qmp-shell: make QMPShellError inherit QMPError John Snow
` (5 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
They're not needed; single underscore is enough to express intent that
these methods are "internal". double underscore is used as a weak name
mangling, but that isn't beneficial for us here.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-38-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 52 +++++++++++++++++++++----------------------
1 file changed, 26 insertions(+), 26 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 82fe16cff8..40ff9e0a82 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -171,7 +171,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
for cmd in cmds['return']:
self._completer.append(cmd['name'])
- def __completer_setup(self) -> None:
+ def _completer_setup(self) -> None:
self._completer = QMPCompleter()
self._fill_completion()
readline.set_history_length(1024)
@@ -196,7 +196,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
LOG.warning(msg)
@classmethod
- def __parse_value(cls, val: str) -> object:
+ def _parse_value(cls, val: str) -> object:
try:
return int(val)
except ValueError:
@@ -221,9 +221,9 @@ class QMPShell(qmp.QEMUMonitorProtocol):
pass
return val
- def __cli_expr(self,
- tokens: Sequence[str],
- parent: qmp.QMPObject) -> None:
+ def _cli_expr(self,
+ tokens: Sequence[str],
+ parent: qmp.QMPObject) -> None:
for arg in tokens:
(key, sep, val) = arg.partition('=')
if sep != '=':
@@ -231,7 +231,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
f"Expected a key=value pair, got '{arg!s}'"
)
- value = self.__parse_value(val)
+ value = self._parse_value(val)
optpath = key.split('.')
curpath = []
for path in optpath[:-1]:
@@ -249,7 +249,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
raise QMPShellError(f'Cannot set "{key}" multiple times')
parent[optpath[-1]] = value
- def __build_cmd(self, cmdline: str) -> Optional[QMPMessage]:
+ def _build_cmd(self, cmdline: str) -> Optional[QMPMessage]:
"""
Build a QMP input object from a user provided command-line in the
following format:
@@ -289,13 +289,13 @@ class QMPShell(qmp.QEMUMonitorProtocol):
if cmdargs[-1] == ')':
cmdargs.pop(-1)
finalize = True
- self.__cli_expr(cmdargs[1:], action['data'])
+ self._cli_expr(cmdargs[1:], action['data'])
self._actions.append(action)
- return self.__build_cmd(')') if finalize else None
+ return self._build_cmd(')') if finalize else None
# Standard command: parse and return it to be executed.
qmpcmd = {'execute': cmdargs[0], 'arguments': {}}
- self.__cli_expr(cmdargs[1:], qmpcmd['arguments'])
+ self._cli_expr(cmdargs[1:], qmpcmd['arguments'])
return qmpcmd
def _print(self, qmp_message: object) -> None:
@@ -306,7 +306,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
def _execute_cmd(self, cmdline: str) -> bool:
try:
- qmpcmd = self.__build_cmd(cmdline)
+ qmpcmd = self._build_cmd(cmdline)
except QMPShellError as err:
print(
f"Error while parsing command line: {err!s}\n"
@@ -329,7 +329,7 @@ class QMPShell(qmp.QEMUMonitorProtocol):
def connect(self, negotiate: bool = True) -> None:
self._greeting = super().connect(negotiate)
- self.__completer_setup()
+ self._completer_setup()
def show_banner(self,
msg: str = 'Welcome to the QMP low-level shell!') -> None:
@@ -377,10 +377,10 @@ class HMPShell(QMPShell):
def __init__(self, address: qmp.SocketAddrT,
pretty: bool = False, verbose: bool = False):
super().__init__(address, pretty, verbose)
- self.__cpu_index = 0
+ self._cpu_index = 0
- def __cmd_completion(self) -> None:
- for cmd in self.__cmd_passthrough('help')['return'].split('\r\n'):
+ def _cmd_completion(self) -> None:
+ for cmd in self._cmd_passthrough('help')['return'].split('\r\n'):
if cmd and cmd[0] != '[' and cmd[0] != '\t':
name = cmd.split()[0] # drop help text
if name == 'info':
@@ -396,22 +396,22 @@ class HMPShell(QMPShell):
self._completer.append(name)
self._completer.append('help ' + name) # help completion
- def __info_completion(self) -> None:
- for cmd in self.__cmd_passthrough('info')['return'].split('\r\n'):
+ def _info_completion(self) -> None:
+ for cmd in self._cmd_passthrough('info')['return'].split('\r\n'):
if cmd:
self._completer.append('info ' + cmd.split()[1])
- def __other_completion(self) -> None:
+ def _other_completion(self) -> None:
# special cases
self._completer.append('help info')
def _fill_completion(self) -> None:
- self.__cmd_completion()
- self.__info_completion()
- self.__other_completion()
+ self._cmd_completion()
+ self._info_completion()
+ self._other_completion()
- def __cmd_passthrough(self, cmdline: str,
- cpu_index: int = 0) -> QMPMessage:
+ def _cmd_passthrough(self, cmdline: str,
+ cpu_index: int = 0) -> QMPMessage:
return self.cmd_obj({
'execute': 'human-monitor-command',
'arguments': {
@@ -425,14 +425,14 @@ class HMPShell(QMPShell):
# trap the cpu command, it requires special setting
try:
idx = int(cmdline.split()[1])
- if 'return' not in self.__cmd_passthrough('info version', idx):
+ if 'return' not in self._cmd_passthrough('info version', idx):
print('bad CPU index')
return True
- self.__cpu_index = idx
+ self._cpu_index = idx
except ValueError:
print('cpu command takes an integer argument')
return True
- resp = self.__cmd_passthrough(cmdline, self.__cpu_index)
+ resp = self._cmd_passthrough(cmdline, self._cpu_index)
if resp is None:
print('Disconnected')
return False
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 68/72] scripts/qmp-shell: make QMPShellError inherit QMPError
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (66 preceding siblings ...)
2021-06-18 23:04 ` [PULL 67/72] scripts/qmp-shell: remove double-underscores John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 69/72] scripts/qmp-shell: add docstrings John Snow
` (4 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
In preparation for moving qmp-shell into the qemu.qmp package, make
QMPShellError inherit from QMPError so that all custom errors in this
package all derive from QMPError.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-39-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 40ff9e0a82..1a8a4ba18a 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -123,7 +123,7 @@ class QMPCompleter:
return None
-class QMPShellError(Exception):
+class QMPShellError(qmp.QMPError):
pass
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 69/72] scripts/qmp-shell: add docstrings
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (67 preceding siblings ...)
2021-06-18 23:04 ` [PULL 68/72] scripts/qmp-shell: make QMPShellError inherit QMPError John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 70/72] scripts/qmp-shell: move to python/qemu/qmp/qmp_shell.py John Snow
` (3 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-40-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 39 ++++++++++++++++++++++++++++++++++++++-
1 file changed, 38 insertions(+), 1 deletion(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 1a8a4ba18a..15aedb80c2 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -106,15 +106,20 @@ LOG = logging.getLogger(__name__)
class QMPCompleter:
+ """
+ QMPCompleter provides a readline library tab-complete behavior.
+ """
# NB: Python 3.9+ will probably allow us to subclass list[str] directly,
# but pylint as of today does not know that List[str] is simply 'list'.
def __init__(self) -> None:
self._matches: List[str] = []
def append(self, value: str) -> None:
+ """Append a new valid completion to the list of possibilities."""
return self._matches.append(value)
def complete(self, text: str, state: int) -> Optional[str]:
+ """readline.set_completer() callback implementation."""
for cmd in self._matches:
if cmd.startswith(text):
if state == 0:
@@ -124,7 +129,9 @@ class QMPCompleter:
class QMPShellError(qmp.QMPError):
- pass
+ """
+ QMP Shell Base error class.
+ """
class FuzzyJSON(ast.NodeTransformer):
@@ -137,6 +144,9 @@ class FuzzyJSON(ast.NodeTransformer):
@classmethod
def visit_Name(cls, # pylint: disable=invalid-name
node: ast.Name) -> ast.AST:
+ """
+ Transform Name nodes with certain values into Constant (keyword) nodes.
+ """
if node.id == 'true':
return ast.Constant(value=True)
if node.id == 'false':
@@ -147,6 +157,13 @@ class FuzzyJSON(ast.NodeTransformer):
class QMPShell(qmp.QEMUMonitorProtocol):
+ """
+ QMPShell provides a basic readline-based QMP shell.
+
+ :param address: Address of the QMP server.
+ :param pretty: Pretty-print QMP messages.
+ :param verbose: Echo outgoing QMP messages to console.
+ """
def __init__(self, address: qmp.SocketAddrT,
pretty: bool = False, verbose: bool = False):
super().__init__(address)
@@ -333,6 +350,9 @@ class QMPShell(qmp.QEMUMonitorProtocol):
def show_banner(self,
msg: str = 'Welcome to the QMP low-level shell!') -> None:
+ """
+ Print to stdio a greeting, and the QEMU version if available.
+ """
print(msg)
if not self._greeting:
print('Connected')
@@ -342,6 +362,9 @@ class QMPShell(qmp.QEMUMonitorProtocol):
@property
def prompt(self) -> str:
+ """
+ Return the current shell prompt, including a trailing space.
+ """
if self._transmode:
return 'TRANS> '
return '(QEMU) '
@@ -367,6 +390,9 @@ class QMPShell(qmp.QEMUMonitorProtocol):
return self._execute_cmd(cmdline)
def repl(self) -> Iterator[None]:
+ """
+ Return an iterator that implements the REPL.
+ """
self.show_banner()
while self.read_exec_command():
yield
@@ -374,6 +400,13 @@ class QMPShell(qmp.QEMUMonitorProtocol):
class HMPShell(QMPShell):
+ """
+ HMPShell provides a basic readline-based HMP shell, tunnelled via QMP.
+
+ :param address: Address of the QMP server.
+ :param pretty: Pretty-print QMP messages.
+ :param verbose: Echo outgoing QMP messages to console.
+ """
def __init__(self, address: qmp.SocketAddrT,
pretty: bool = False, verbose: bool = False):
super().__init__(address, pretty, verbose)
@@ -451,11 +484,15 @@ class HMPShell(QMPShell):
def die(msg: str) -> NoReturn:
+ """Write an error to stderr, then exit with a return code of 1."""
sys.stderr.write('ERROR: %s\n' % msg)
sys.exit(1)
def main() -> None:
+ """
+ qmp-shell 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')
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 70/72] scripts/qmp-shell: move to python/qemu/qmp/qmp_shell.py
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (68 preceding siblings ...)
2021-06-18 23:04 ` [PULL 69/72] scripts/qmp-shell: add docstrings John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 71/72] python: add qmp-shell entry point John Snow
` (2 subsequent siblings)
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
The script will be unavailable for a commit or two, which will help
preserve development history attached to the new file. A forwarder will
be added shortly afterwards.
With qmp_shell in the python qemu.qmp package, now it is fully type
checked, linted, etc. via the Python CI. It will be quite a bit harder
to accidentally break it again in the future.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-41-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell => python/qemu/qmp/qmp_shell.py | 3 ---
1 file changed, 3 deletions(-)
rename scripts/qmp/qmp-shell => python/qemu/qmp/qmp_shell.py (99%)
mode change 100755 => 100644
diff --git a/scripts/qmp/qmp-shell b/python/qemu/qmp/qmp_shell.py
old mode 100755
new mode 100644
similarity index 99%
rename from scripts/qmp/qmp-shell
rename to python/qemu/qmp/qmp_shell.py
index 15aedb80c2..337acfce2d
--- a/scripts/qmp/qmp-shell
+++ b/python/qemu/qmp/qmp_shell.py
@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
#
# Copyright (C) 2009, 2010 Red Hat Inc.
#
@@ -96,8 +95,6 @@
Sequence,
)
-
-sys.path.append(os.path.join(os.path.dirname(__file__), '..', '..', 'python'))
from qemu import qmp
from qemu.qmp import QMPMessage
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 71/72] python: add qmp-shell entry point
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (69 preceding siblings ...)
2021-06-18 23:04 ` [PULL 70/72] scripts/qmp-shell: move to python/qemu/qmp/qmp_shell.py John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-18 23:04 ` [PULL 72/72] scripts/qmp-shell: add redirection shim John Snow
2021-06-21 19:42 ` [PULL 00/72] Python patches Peter Maydell
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
now 'qmp-shell' should be available from the command line when
installing the python package.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-42-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/setup.cfg | 1 +
1 file changed, 1 insertion(+)
diff --git a/python/setup.cfg b/python/setup.cfg
index 7f3c59d74e..85cecbb41b 100644
--- a/python/setup.cfg
+++ b/python/setup.cfg
@@ -51,6 +51,7 @@ console_scripts =
qom-tree = qemu.qmp.qom:QOMTree.entry_point
qom-fuse = qemu.qmp.qom_fuse:QOMFuse.entry_point [fuse]
qemu-ga-client = qemu.qmp.qemu_ga_client:main
+ qmp-shell = qemu.qmp.qmp_shell:main
[flake8]
extend-ignore = E722 # Prefer pylint's bare-except checks to flake8's
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* [PULL 72/72] scripts/qmp-shell: add redirection shim
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (70 preceding siblings ...)
2021-06-18 23:04 ` [PULL 71/72] python: add qmp-shell entry point John Snow
@ 2021-06-18 23:04 ` John Snow
2021-06-21 19:42 ` [PULL 00/72] Python patches Peter Maydell
72 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-18 23:04 UTC (permalink / raw)
To: qemu-devel
Cc: Peter Maydell, Markus Armbruster, John Snow, Eduardo Habkost,
Cleber Rosa
qmp-shell has a new home, add a redirect for a little while as the dust
settles.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-id: 20210607200649.1840382-43-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qmp/qmp-shell | 11 +++++++++++
1 file changed, 11 insertions(+)
create mode 100755 scripts/qmp/qmp-shell
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
new file mode 100755
index 0000000000..4a20f97db7
--- /dev/null
+++ b/scripts/qmp/qmp-shell
@@ -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()
--
2.31.1
^ permalink raw reply related [flat|nested] 75+ messages in thread* Re: [PULL 00/72] Python patches
2021-06-18 23:03 [PULL 00/72] Python patches John Snow
` (71 preceding siblings ...)
2021-06-18 23:04 ` [PULL 72/72] scripts/qmp-shell: add redirection shim John Snow
@ 2021-06-21 19:42 ` Peter Maydell
2021-06-22 13:34 ` John Snow
72 siblings, 1 reply; 75+ messages in thread
From: Peter Maydell @ 2021-06-21 19:42 UTC (permalink / raw)
To: John Snow
Cc: Markus Armbruster, Cleber Rosa, QEMU Developers, Eduardo Habkost
On Sat, 19 Jun 2021 at 00:05, John Snow <jsnow@redhat.com> wrote:
>
> The following changes since commit 3ccf6cd0e3e1dfd663814640b3b18b55715d7a75:
>
> Merge remote-tracking branch 'remotes/kraxel/tags/audio-20210617-pull-request' into staging (2021-06-18 09:54:42 +0100)
>
> are available in the Git repository at:
>
> https://gitlab.com/jsnow/qemu.git tags/python-pull-request
>
> for you to fetch changes up to d08caefe6648fc0713af5361e2b88bee53b67ebb:
>
> scripts/qmp-shell: add redirection shim (2021-06-18 16:10:07 -0400)
>
> ----------------------------------------------------------------
> Python Pull request
>
> Moves QMP-related tools not used for build or automatic testing from
> scripts/ to python/qemu/qmp/ where they will be protected from bitrot by
> the check-python-* CI jobs.
>
> stub forwarders are left in the old locations for now.
Applied, thanks.
Please update the changelog at https://wiki.qemu.org/ChangeLog/6.1
for any user-visible changes.
-- PMM
^ permalink raw reply [flat|nested] 75+ messages in thread* Re: [PULL 00/72] Python patches
2021-06-21 19:42 ` [PULL 00/72] Python patches Peter Maydell
@ 2021-06-22 13:34 ` John Snow
0 siblings, 0 replies; 75+ messages in thread
From: John Snow @ 2021-06-22 13:34 UTC (permalink / raw)
To: Peter Maydell
Cc: QEMU Developers, Markus Armbruster, Eduardo Habkost, Cleber Rosa
On 6/21/21 3:42 PM, Peter Maydell wrote:
> On Sat, 19 Jun 2021 at 00:05, John Snow <jsnow@redhat.com> wrote:
>>
>> The following changes since commit 3ccf6cd0e3e1dfd663814640b3b18b55715d7a75:
>>
>> Merge remote-tracking branch 'remotes/kraxel/tags/audio-20210617-pull-request' into staging (2021-06-18 09:54:42 +0100)
>>
>> are available in the Git repository at:
>>
>> https://gitlab.com/jsnow/qemu.git tags/python-pull-request
>>
>> for you to fetch changes up to d08caefe6648fc0713af5361e2b88bee53b67ebb:
>>
>> scripts/qmp-shell: add redirection shim (2021-06-18 16:10:07 -0400)
>>
>> ----------------------------------------------------------------
>> Python Pull request
>>
>> Moves QMP-related tools not used for build or automatic testing from
>> scripts/ to python/qemu/qmp/ where they will be protected from bitrot by
>> the check-python-* CI jobs.
>>
>> stub forwarders are left in the old locations for now.
>
>
> Applied, thanks.
>
> Please update the changelog at https://wiki.qemu.org/ChangeLog/6.1
> for any user-visible changes.
>
> -- PMM
>
Great, thanks. No user-visible changes, but some developer-visible ones
have happened with Python in 6.1. Should I summarize them somewhere?
--js
^ permalink raw reply [flat|nested] 75+ messages in thread