* [Qemu-devel] [PATCH v2] qmp-shell: fix pretty printing of JSON responses
@ 2016-02-23 10:51 Daniel P. Berrange
2016-02-23 11:39 ` Kashyap Chamarthy
2016-02-23 22:53 ` John Snow
0 siblings, 2 replies; 4+ messages in thread
From: Daniel P. Berrange @ 2016-02-23 10:51 UTC (permalink / raw)
To: qemu-devel; +Cc: Markus Armbruster, Luiz Capitulino
Pretty printing of JSON responses is important to be able to understand
large responses from query commands in particular. Unfortunately this
was broken during the addition of the verbose flag in
commit 1ceca07e48ead0dd2e41576c81d40e6a91cafefd
Author: John Snow <jsnow@redhat.com>
Date: Wed Apr 29 15:14:04 2015 -0400
scripts: qmp-shell: Add verbose flag
This is because that change turned the python data structure into a
formatted JSON string before the pretty print was given it. So we're
just pretty printing a string, which is a no-op.
The original pretty printer would output python objects.
(QEMU) query-chardev
{ u'return': [ { u'filename': u'vc',
u'frontend-open': False,
u'label': u'parallel0'},
{ u'filename': u'vc',
u'frontend-open': True,
u'label': u'serial0'},
{ u'filename': u'unix:/tmp/qemp,server',
u'frontend-open': True,
u'label': u'compat_monitor0'}]}
This fixes the problem by switching to outputting pretty formatted JSON
text instead. This has the added benefit that the pretty printed output
is now valid JSON text. Due to the way the verbose flag was handled, the
pretty printing now applies to the command sent, as well as its response:
(QEMU) query-chardev
{
"execute": "query-chardev",
"arguments": {}
}
{
"return": [
{
"frontend-open": false,
"label": "parallel0",
"filename": "vc"
},
{
"frontend-open": true,
"label": "serial0",
"filename": "vc"
},
{
"frontend-open": true,
"label": "compat_monitor0",
"filename": "unix:/tmp/qmp,server"
}
]
}
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
---
scripts/qmp/qmp-shell | 23 ++++++++++-------------
1 file changed, 10 insertions(+), 13 deletions(-)
diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 7a402ed..0373b24 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -70,7 +70,6 @@ import json
import ast
import readline
import sys
-import pprint
class QMPCompleter(list):
def complete(self, text, state):
@@ -103,11 +102,11 @@ 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, pp=None):
+ def __init__(self, address, pretty=False):
qmp.QEMUMonitorProtocol.__init__(self, self.__get_address(address))
self._greeting = None
self._completer = None
- self._pp = pp
+ self._pretty = pretty
self._transmode = False
self._actions = list()
@@ -231,11 +230,11 @@ class QMPShell(qmp.QEMUMonitorProtocol):
return qmpcmd
def _print(self, qmp):
- jsobj = json.dumps(qmp)
- if self._pp is not None:
- self._pp.pprint(jsobj)
- else:
- print str(jsobj)
+ indent = None
+ if self._pretty:
+ indent = 4
+ jsobj = json.dumps(qmp, indent=indent)
+ print str(jsobj)
def _execute_cmd(self, cmdline):
try:
@@ -377,7 +376,7 @@ def main():
addr = ''
qemu = None
hmp = False
- pp = None
+ pretty = False
verbose = False
try:
@@ -387,9 +386,7 @@ def main():
fail_cmdline(arg)
hmp = True
elif arg == "-p":
- if pp is not None:
- fail_cmdline(arg)
- pp = pprint.PrettyPrinter(indent=4)
+ pretty = True
elif arg == "-v":
verbose = True
else:
@@ -398,7 +395,7 @@ def main():
if hmp:
qemu = HMPShell(arg)
else:
- qemu = QMPShell(arg, pp)
+ qemu = QMPShell(arg, pretty)
addr = arg
if qemu is None:
--
2.5.0
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [Qemu-devel] [PATCH v2] qmp-shell: fix pretty printing of JSON responses
2016-02-23 10:51 [Qemu-devel] [PATCH v2] qmp-shell: fix pretty printing of JSON responses Daniel P. Berrange
@ 2016-02-23 11:39 ` Kashyap Chamarthy
2016-02-23 22:53 ` John Snow
1 sibling, 0 replies; 4+ messages in thread
From: Kashyap Chamarthy @ 2016-02-23 11:39 UTC (permalink / raw)
To: Daniel P. Berrange; +Cc: Luiz Capitulino, qemu-devel, Markus Armbruster
On Tue, Feb 23, 2016 at 10:51:46AM +0000, Daniel P. Berrange wrote:
> Pretty printing of JSON responses is important to be able to understand
> large responses from query commands in particular. Unfortunately this
> was broken during the addition of the verbose flag in
>
> commit 1ceca07e48ead0dd2e41576c81d40e6a91cafefd
> Author: John Snow <jsnow@redhat.com>
> Date: Wed Apr 29 15:14:04 2015 -0400
>
> scripts: qmp-shell: Add verbose flag
>
> This is because that change turned the python data structure into a
> formatted JSON string before the pretty print was given it. So we're
> just pretty printing a string, which is a no-op.
>
> The original pretty printer would output python objects.
>
> (QEMU) query-chardev
> { u'return': [ { u'filename': u'vc',
> u'frontend-open': False,
> u'label': u'parallel0'},
> { u'filename': u'vc',
> u'frontend-open': True,
> u'label': u'serial0'},
> { u'filename': u'unix:/tmp/qemp,server',
> u'frontend-open': True,
> u'label': u'compat_monitor0'}]}
For me, without your patch (I was testing from 'v2.5.0-1307-g80b5d6b')
the output doesn't even look like the above -- when `qmp-shell -p
/path/to/socket` is invoked, and I type in any of the query commands,
what I see is long unterminated JSON output.
> This fixes the problem by switching to outputting pretty formatted JSON
> text instead. This has the added benefit that the pretty printed output
> is now valid JSON text. Due to the way the verbose flag was handled, the
> pretty printing now applies to the command sent, as well as its response:
>
> (QEMU) query-chardev
> {
> "execute": "query-chardev",
> "arguments": {}
> }
> {
> "return": [
> {
> "frontend-open": false,
> "label": "parallel0",
> "filename": "vc"
> },
> {
> "frontend-open": true,
> "label": "serial0",
> "filename": "vc"
> },
> {
> "frontend-open": true,
> "label": "compat_monitor0",
> "filename": "unix:/tmp/qmp,server"
> }
> ]
> }
Works nice here. I ran for a bunch fo query-commands:
$ git describe
pull-io-next-2016-02-16-1-221-ga043f9c
[Fire up QEMU with '-qmp unix:./qmp-sock,server'
$ ./qmp-shell -p /var/tmp/qmp-sock
[...]
(QEMU) query-named-block-nodes
{
"return": [
{
"bps_rd": 0,
"ro": false,
"backing_file_depth": 1,
"encrypted": false,
"image": {
"cluster-size": 65536,
"backing-image": {
"cluster-size": 65536,
"format": "qcow2",
"filename": "/export/tests//cirros-0.3.3.img",
"virtual-size": 41126400,
"dirty-flag": false,
"format-specific": {
"data": {
"compat": "0.10",
"refcount-bits": 16
},
"type": "qcow2"
},
"actual-size": 14446592
},
"format": "qcow2",
"full-backing-filename": "/export/tests//cirros-0.3.3.img",
"backing-filename-format": "qcow2",
"filename": "./ext-snap1.qcow2",
"dirty-flag": false,
"virtual-size": 41126400,
"backing-filename": "/export/tests//cirros-0.3.3.img",
"format-specific": {
"data": {
"compat": "1.1",
"refcount-bits": 16,
"corrupt": false,
"lazy-refcounts": false
},
"type": "qcow2"
},
"actual-size": 200704
},
[...]
> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
> ---
> scripts/qmp/qmp-shell | 23 ++++++++++-------------
> 1 file changed, 10 insertions(+), 13 deletions(-)
FWIW:
Tested-by: Kashyap Chamarthy <kchamart@redhat.com>
[...]
--
/kashyap
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [Qemu-devel] [PATCH v2] qmp-shell: fix pretty printing of JSON responses
2016-02-23 10:51 [Qemu-devel] [PATCH v2] qmp-shell: fix pretty printing of JSON responses Daniel P. Berrange
2016-02-23 11:39 ` Kashyap Chamarthy
@ 2016-02-23 22:53 ` John Snow
2016-02-24 10:28 ` Markus Armbruster
1 sibling, 1 reply; 4+ messages in thread
From: John Snow @ 2016-02-23 22:53 UTC (permalink / raw)
To: Daniel P. Berrange, qemu-devel; +Cc: Markus Armbruster, Luiz Capitulino
On 02/23/2016 05:51 AM, Daniel P. Berrange wrote:
> Pretty printing of JSON responses is important to be able to understand
> large responses from query commands in particular. Unfortunately this
> was broken during the addition of the verbose flag in
>
> commit 1ceca07e48ead0dd2e41576c81d40e6a91cafefd
> Author: John Snow <jsnow@redhat.com>
> Date: Wed Apr 29 15:14:04 2015 -0400
>
> scripts: qmp-shell: Add verbose flag
>
> This is because that change turned the python data structure into a
> formatted JSON string before the pretty print was given it. So we're
> just pretty printing a string, which is a no-op.
>
Mea Culpa.
> The original pretty printer would output python objects.
>
> (QEMU) query-chardev
> { u'return': [ { u'filename': u'vc',
> u'frontend-open': False,
> u'label': u'parallel0'},
> { u'filename': u'vc',
> u'frontend-open': True,
> u'label': u'serial0'},
> { u'filename': u'unix:/tmp/qemp,server',
> u'frontend-open': True,
> u'label': u'compat_monitor0'}]}
>
> This fixes the problem by switching to outputting pretty formatted JSON
> text instead. This has the added benefit that the pretty printed output
> is now valid JSON text. Due to the way the verbose flag was handled, the
> pretty printing now applies to the command sent, as well as its response:
>
> (QEMU) query-chardev
> {
> "execute": "query-chardev",
> "arguments": {}
> }
> {
> "return": [
> {
> "frontend-open": false,
> "label": "parallel0",
> "filename": "vc"
> },
> {
> "frontend-open": true,
> "label": "serial0",
> "filename": "vc"
> },
> {
> "frontend-open": true,
> "label": "compat_monitor0",
> "filename": "unix:/tmp/qmp,server"
> }
> ]
> }
>
That's good news as far as I am concerned.
> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
> ---
> scripts/qmp/qmp-shell | 23 ++++++++++-------------
> 1 file changed, 10 insertions(+), 13 deletions(-)
>
> diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
> index 7a402ed..0373b24 100755
> --- a/scripts/qmp/qmp-shell
> +++ b/scripts/qmp/qmp-shell
> @@ -70,7 +70,6 @@ import json
> import ast
> import readline
> import sys
> -import pprint
>
> class QMPCompleter(list):
> def complete(self, text, state):
> @@ -103,11 +102,11 @@ class FuzzyJSON(ast.NodeTransformer):
> # TODO: QMPShell's interface is a bit ugly (eg. _fill_completion() and
> # _execute_cmd()). Let's design a better one.
^ Heh ^
> class QMPShell(qmp.QEMUMonitorProtocol):
> - def __init__(self, address, pp=None):
> + def __init__(self, address, pretty=False):
> qmp.QEMUMonitorProtocol.__init__(self, self.__get_address(address))
> self._greeting = None
> self._completer = None
> - self._pp = pp
> + self._pretty = pretty
> self._transmode = False
> self._actions = list()
>
> @@ -231,11 +230,11 @@ class QMPShell(qmp.QEMUMonitorProtocol):
> return qmpcmd
>
> def _print(self, qmp):
> - jsobj = json.dumps(qmp)
> - if self._pp is not None:
> - self._pp.pprint(jsobj)
> - else:
> - print str(jsobj)
> + indent = None
> + if self._pretty:
> + indent = 4
> + jsobj = json.dumps(qmp, indent=indent)
> + print str(jsobj)
>
> def _execute_cmd(self, cmdline):
> try:
> @@ -377,7 +376,7 @@ def main():
> addr = ''
> qemu = None
> hmp = False
> - pp = None
> + pretty = False
> verbose = False
>
> try:
> @@ -387,9 +386,7 @@ def main():
> fail_cmdline(arg)
> hmp = True
> elif arg == "-p":
> - if pp is not None:
> - fail_cmdline(arg)
> - pp = pprint.PrettyPrinter(indent=4)
> + pretty = True
We now accept any number of -p arguments. That's probably fine.
> elif arg == "-v":
> verbose = True
> else:
> @@ -398,7 +395,7 @@ def main():
> if hmp:
> qemu = HMPShell(arg)
> else:
> - qemu = QMPShell(arg, pp)
> + qemu = QMPShell(arg, pretty)
> addr = arg
>
> if qemu is None:
>
Reviewed-by: John Snow <jsnow@redhat.com>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [Qemu-devel] [PATCH v2] qmp-shell: fix pretty printing of JSON responses
2016-02-23 22:53 ` John Snow
@ 2016-02-24 10:28 ` Markus Armbruster
0 siblings, 0 replies; 4+ messages in thread
From: Markus Armbruster @ 2016-02-24 10:28 UTC (permalink / raw)
To: John Snow; +Cc: qemu-devel, Luiz Capitulino
John Snow <jsnow@redhat.com> writes:
> On 02/23/2016 05:51 AM, Daniel P. Berrange wrote:
>> Pretty printing of JSON responses is important to be able to understand
>> large responses from query commands in particular. Unfortunately this
>> was broken during the addition of the verbose flag in
>>
>> commit 1ceca07e48ead0dd2e41576c81d40e6a91cafefd
>> Author: John Snow <jsnow@redhat.com>
>> Date: Wed Apr 29 15:14:04 2015 -0400
>>
>> scripts: qmp-shell: Add verbose flag
>>
>> This is because that change turned the python data structure into a
>> formatted JSON string before the pretty print was given it. So we're
>> just pretty printing a string, which is a no-op.
>>
>
> Mea Culpa.
>
>> The original pretty printer would output python objects.
>>
>> (QEMU) query-chardev
>> { u'return': [ { u'filename': u'vc',
>> u'frontend-open': False,
>> u'label': u'parallel0'},
>> { u'filename': u'vc',
>> u'frontend-open': True,
>> u'label': u'serial0'},
>> { u'filename': u'unix:/tmp/qemp,server',
>> u'frontend-open': True,
>> u'label': u'compat_monitor0'}]}
>>
>> This fixes the problem by switching to outputting pretty formatted JSON
>> text instead. This has the added benefit that the pretty printed output
>> is now valid JSON text. Due to the way the verbose flag was handled, the
>> pretty printing now applies to the command sent, as well as its response:
>>
>> (QEMU) query-chardev
>> {
>> "execute": "query-chardev",
>> "arguments": {}
>> }
>> {
>> "return": [
>> {
>> "frontend-open": false,
>> "label": "parallel0",
>> "filename": "vc"
>> },
>> {
>> "frontend-open": true,
>> "label": "serial0",
>> "filename": "vc"
>> },
>> {
>> "frontend-open": true,
>> "label": "compat_monitor0",
>> "filename": "unix:/tmp/qmp,server"
>> }
>> ]
>> }
>>
>
> That's good news as far as I am concerned.
>
>> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
>> ---
>> scripts/qmp/qmp-shell | 23 ++++++++++-------------
>> 1 file changed, 10 insertions(+), 13 deletions(-)
>>
>> diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
>> index 7a402ed..0373b24 100755
>> --- a/scripts/qmp/qmp-shell
>> +++ b/scripts/qmp/qmp-shell
>> @@ -70,7 +70,6 @@ import json
>> import ast
>> import readline
>> import sys
>> -import pprint
>>
>> class QMPCompleter(list):
>> def complete(self, text, state):
>> @@ -103,11 +102,11 @@ class FuzzyJSON(ast.NodeTransformer):
>> # TODO: QMPShell's interface is a bit ugly (eg. _fill_completion() and
>> # _execute_cmd()). Let's design a better one.
>
> ^ Heh ^
>
>> class QMPShell(qmp.QEMUMonitorProtocol):
>> - def __init__(self, address, pp=None):
>> + def __init__(self, address, pretty=False):
>> qmp.QEMUMonitorProtocol.__init__(self, self.__get_address(address))
>> self._greeting = None
>> self._completer = None
>> - self._pp = pp
>> + self._pretty = pretty
>> self._transmode = False
>> self._actions = list()
>>
>> @@ -231,11 +230,11 @@ class QMPShell(qmp.QEMUMonitorProtocol):
>> return qmpcmd
>>
>> def _print(self, qmp):
>> - jsobj = json.dumps(qmp)
>> - if self._pp is not None:
>> - self._pp.pprint(jsobj)
>> - else:
>> - print str(jsobj)
>> + indent = None
>> + if self._pretty:
>> + indent = 4
>> + jsobj = json.dumps(qmp, indent=indent)
>> + print str(jsobj)
>>
>> def _execute_cmd(self, cmdline):
>> try:
>> @@ -377,7 +376,7 @@ def main():
>> addr = ''
>> qemu = None
>> hmp = False
>> - pp = None
>> + pretty = False
>> verbose = False
>>
>> try:
>> @@ -387,9 +386,7 @@ def main():
>> fail_cmdline(arg)
>> hmp = True
>> elif arg == "-p":
>> - if pp is not None:
>> - fail_cmdline(arg)
>> - pp = pprint.PrettyPrinter(indent=4)
>> + pretty = True
>
> We now accept any number of -p arguments. That's probably fine.
I'd call that a bug fix.
>> elif arg == "-v":
>> verbose = True
>> else:
>> @@ -398,7 +395,7 @@ def main():
>> if hmp:
>> qemu = HMPShell(arg)
>> else:
>> - qemu = QMPShell(arg, pp)
>> + qemu = QMPShell(arg, pretty)
>> addr = arg
>>
>> if qemu is None:
>>
>
> Reviewed-by: John Snow <jsnow@redhat.com>
Applied to my qapi-next branch, thanks!
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2016-02-24 10:28 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2016-02-23 10:51 [Qemu-devel] [PATCH v2] qmp-shell: fix pretty printing of JSON responses Daniel P. Berrange
2016-02-23 11:39 ` Kashyap Chamarthy
2016-02-23 22:53 ` John Snow
2016-02-24 10:28 ` Markus Armbruster
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).