{"id":814425,"url":"http://patchwork.ozlabs.org/api/patches/814425/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20170915233739.26860-2-ehabkost@redhat.com/","project":{"id":14,"url":"http://patchwork.ozlabs.org/api/projects/14/?format=json","name":"QEMU Development","link_name":"qemu-devel","list_id":"qemu-devel.nongnu.org","list_email":"qemu-devel@nongnu.org","web_url":"","scm_url":"","webscm_url":"","list_archive_url":"","list_archive_url_format":"","commit_url_format":""},"msgid":"<20170915233739.26860-2-ehabkost@redhat.com>","list_archive_url":null,"date":"2017-09-15T23:37:25","name":"[PULL,01/15] qemu.py: Pylint/style fixes","commit_ref":null,"pull_url":null,"state":"new","archived":false,"hash":"3a6aa961b8edba948c18c5a0943a27aad2e31098","submitter":{"id":195,"url":"http://patchwork.ozlabs.org/api/people/195/?format=json","name":"Eduardo Habkost","email":"ehabkost@redhat.com"},"delegate":null,"mbox":"http://patchwork.ozlabs.org/project/qemu-devel/patch/20170915233739.26860-2-ehabkost@redhat.com/mbox/","series":[{"id":3400,"url":"http://patchwork.ozlabs.org/api/series/3400/?format=json","web_url":"http://patchwork.ozlabs.org/project/qemu-devel/list/?series=3400","date":"2017-09-15T23:37:24","name":"[PULL,01/15] qemu.py: Pylint/style fixes","version":1,"mbox":"http://patchwork.ozlabs.org/series/3400/mbox/"}],"comments":"http://patchwork.ozlabs.org/api/patches/814425/comments/","check":"pending","checks":"http://patchwork.ozlabs.org/api/patches/814425/checks/","tags":{},"related":[],"headers":{"Return-Path":"<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>","X-Original-To":"incoming@patchwork.ozlabs.org","Delivered-To":"patchwork-incoming@bilbo.ozlabs.org","Authentication-Results":["ozlabs.org;\n\tspf=pass (mailfrom) smtp.mailfrom=nongnu.org\n\t(client-ip=2001:4830:134:3::11; helo=lists.gnu.org;\n\tenvelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org;\n\treceiver=<UNKNOWN>)","ext-mx04.extmail.prod.ext.phx2.redhat.com;\n\tdmarc=none (p=none dis=none) header.from=redhat.com","ext-mx04.extmail.prod.ext.phx2.redhat.com;\n\tspf=fail smtp.mailfrom=ehabkost@redhat.com"],"Received":["from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11])\n\t(using TLSv1 with cipher AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 3xvBg86kPfz9sPk\n\tfor <incoming@patchwork.ozlabs.org>;\n\tSat, 16 Sep 2017 09:38:44 +1000 (AEST)","from localhost ([::1]:55351 helo=lists.gnu.org)\n\tby lists.gnu.org with esmtp (Exim 4.71) (envelope-from\n\t<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>)\n\tid 1dt0C3-0004u0-11\n\tfor incoming@patchwork.ozlabs.org; Fri, 15 Sep 2017 19:38:43 -0400","from eggs.gnu.org ([2001:4830:134:3::10]:56141)\n\tby lists.gnu.org with esmtp (Exim 4.71)\n\t(envelope-from <ehabkost@redhat.com>) id 1dt0BH-0004sL-Ef\n\tfor qemu-devel@nongnu.org; Fri, 15 Sep 2017 19:37:56 -0400","from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)\n\t(envelope-from <ehabkost@redhat.com>) id 1dt0BF-0001BI-Q7\n\tfor qemu-devel@nongnu.org; Fri, 15 Sep 2017 19:37:55 -0400","from mx1.redhat.com ([209.132.183.28]:54020)\n\tby eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)\n\t(Exim 4.71) (envelope-from <ehabkost@redhat.com>) id 1dt0BF-00018W-HG\n\tfor qemu-devel@nongnu.org; Fri, 15 Sep 2017 19:37:53 -0400","from smtp.corp.redhat.com\n\t(int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11])\n\t(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby mx1.redhat.com (Postfix) with ESMTPS id 8F78085540;\n\tFri, 15 Sep 2017 23:37:52 +0000 (UTC)","from localhost (ovpn-116-24.gru2.redhat.com [10.97.116.24])\n\tby smtp.corp.redhat.com (Postfix) with ESMTP id 5BA8960468;\n\tFri, 15 Sep 2017 23:37:47 +0000 (UTC)"],"DMARC-Filter":"OpenDMARC Filter v1.3.2 mx1.redhat.com 8F78085540","From":"Eduardo Habkost <ehabkost@redhat.com>","To":"Peter Maydell <peter.maydell@linaro.org>,\n\tqemu-devel@nongnu.org","Date":"Fri, 15 Sep 2017 20:37:25 -0300","Message-Id":"<20170915233739.26860-2-ehabkost@redhat.com>","In-Reply-To":"<20170915233739.26860-1-ehabkost@redhat.com>","References":"<20170915233739.26860-1-ehabkost@redhat.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=UTF-8","X-Scanned-By":"MIMEDefang 2.79 on 10.5.11.11","X-Greylist":"Sender IP whitelisted, not delayed by milter-greylist-4.5.16\n\t(mx1.redhat.com [10.5.110.28]);\n\tFri, 15 Sep 2017 23:37:52 +0000 (UTC)","Content-Transfer-Encoding":"quoted-printable","X-detected-operating-system":"by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic]\n\t[fuzzy]","X-Received-From":"209.132.183.28","Subject":"[Qemu-devel] [PULL 01/15] qemu.py: Pylint/style fixes","X-BeenThere":"qemu-devel@nongnu.org","X-Mailman-Version":"2.1.21","Precedence":"list","List-Id":"<qemu-devel.nongnu.org>","List-Unsubscribe":"<https://lists.nongnu.org/mailman/options/qemu-devel>,\n\t<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>","List-Archive":"<http://lists.nongnu.org/archive/html/qemu-devel/>","List-Post":"<mailto:qemu-devel@nongnu.org>","List-Help":"<mailto:qemu-devel-request@nongnu.org?subject=help>","List-Subscribe":"<https://lists.nongnu.org/mailman/listinfo/qemu-devel>,\n\t<mailto:qemu-devel-request@nongnu.org?subject=subscribe>","Cc":"=?utf-8?b?THVrw6HFoSBEb2t0b3I=?= <ldoktor@redhat.com>,\n\tAmador Pahim <apahim@redhat.com>, Stefan Hajnoczi <stefanha@redhat.com>","Errors-To":"qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org","Sender":"\"Qemu-devel\"\n\t<qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org>"},"content":"From: Lukáš Doktor <ldoktor@redhat.com>\n\nNo actual code changes, just several pylint/style fixes and docstring\nclarifications.\n\nSigned-off-by: Lukáš Doktor <ldoktor@redhat.com>\nReviewed-by: Stefan Hajnoczi <stefanha@redhat.com>\nMessage-Id: <20170818142613.32394-2-ldoktor@redhat.com>\nReviewed-by: Cleber Rosa <crosa@redhat.com>\nSigned-off-by: Eduardo Habkost <ehabkost@redhat.com>\n---\n scripts/qemu.py | 73 +++++++++++++++++++++++++++++++++++++++++++--------------\n 1 file changed, 55 insertions(+), 18 deletions(-)","diff":"diff --git a/scripts/qemu.py b/scripts/qemu.py\nindex 4d8ee10943..b45e691538 100644\n--- a/scripts/qemu.py\n+++ b/scripts/qemu.py\n@@ -30,8 +30,22 @@ class QEMUMachine(object):\n         # vm is guaranteed to be shut down here\n     '''\n \n-    def __init__(self, binary, args=[], wrapper=[], name=None, test_dir=\"/var/tmp\",\n-                 monitor_address=None, socket_scm_helper=None, debug=False):\n+    def __init__(self, binary, args=[], wrapper=[], name=None,\n+                 test_dir=\"/var/tmp\", monitor_address=None,\n+                 socket_scm_helper=None, debug=False):\n+        '''\n+        Initialize a QEMUMachine\n+\n+        @param binary: path to the qemu binary\n+        @param args: list of extra arguments\n+        @param wrapper: list of arguments used as prefix to qemu binary\n+        @param name: prefix for socket and log file names (default: qemu-PID)\n+        @param test_dir: where to create socket and log file\n+        @param monitor_address: address for QMP monitor\n+        @param socket_scm_helper: helper program, required for send_fd_scm()\"\n+        @param debug: enable debug mode\n+        @note: Qemu process is not started until launch() is used.\n+        '''\n         if name is None:\n             name = \"qemu-%d\" % os.getpid()\n         if monitor_address is None:\n@@ -40,12 +54,13 @@ class QEMUMachine(object):\n         self._qemu_log_path = os.path.join(test_dir, name + \".log\")\n         self._popen = None\n         self._binary = binary\n-        self._args = list(args) # Force copy args in case we modify them\n+        self._args = list(args)     # Force copy args in case we modify them\n         self._wrapper = wrapper\n         self._events = []\n         self._iolog = None\n         self._socket_scm_helper = socket_scm_helper\n         self._debug = debug\n+        self._qmp = None\n \n     def __enter__(self):\n         return self\n@@ -78,16 +93,16 @@ class QEMUMachine(object):\n         if self._socket_scm_helper is None:\n             print >>sys.stderr, \"No path to socket_scm_helper set\"\n             return -1\n-        if os.path.exists(self._socket_scm_helper) == False:\n+        if not os.path.exists(self._socket_scm_helper):\n             print >>sys.stderr, \"%s does not exist\" % self._socket_scm_helper\n             return -1\n         fd_param = [\"%s\" % self._socket_scm_helper,\n                     \"%d\" % self._qmp.get_sock_fd(),\n                     \"%s\" % fd_file_path]\n         devnull = open('/dev/null', 'rb')\n-        p = subprocess.Popen(fd_param, stdin=devnull, stdout=sys.stdout,\n-                             stderr=sys.stderr)\n-        return p.wait()\n+        proc = subprocess.Popen(fd_param, stdin=devnull, stdout=sys.stdout,\n+                                stderr=sys.stderr)\n+        return proc.wait()\n \n     @staticmethod\n     def _remove_if_exists(path):\n@@ -113,8 +128,8 @@ class QEMUMachine(object):\n         return self._popen.pid\n \n     def _load_io_log(self):\n-        with open(self._qemu_log_path, \"r\") as fh:\n-            self._iolog = fh.read()\n+        with open(self._qemu_log_path, \"r\") as iolog:\n+            self._iolog = iolog.read()\n \n     def _base_args(self):\n         if isinstance(self._monitor_address, tuple):\n@@ -128,7 +143,8 @@ class QEMUMachine(object):\n                 '-display', 'none', '-vga', 'none']\n \n     def _pre_launch(self):\n-        self._qmp = qmp.qmp.QEMUMonitorProtocol(self._monitor_address, server=True,\n+        self._qmp = qmp.qmp.QEMUMonitorProtocol(self._monitor_address,\n+                                                server=True,\n                                                 debug=self._debug)\n \n     def _post_launch(self):\n@@ -145,9 +161,11 @@ class QEMUMachine(object):\n         qemulog = open(self._qemu_log_path, 'wb')\n         try:\n             self._pre_launch()\n-            args = self._wrapper + [self._binary] + self._base_args() + self._args\n+            args = (self._wrapper + [self._binary] + self._base_args() +\n+                    self._args)\n             self._popen = subprocess.Popen(args, stdin=devnull, stdout=qemulog,\n-                                           stderr=subprocess.STDOUT, shell=False)\n+                                           stderr=subprocess.STDOUT,\n+                                           shell=False)\n             self._post_launch()\n         except:\n             if self.is_running():\n@@ -168,23 +186,30 @@ class QEMUMachine(object):\n \n             exitcode = self._popen.wait()\n             if exitcode < 0:\n-                sys.stderr.write('qemu received signal %i: %s\\n' % (-exitcode, ' '.join(self._args)))\n+                sys.stderr.write('qemu received signal %i: %s\\n'\n+                                 % (-exitcode, ' '.join(self._args)))\n             self._load_io_log()\n             self._post_shutdown()\n \n     underscore_to_dash = string.maketrans('_', '-')\n+\n     def qmp(self, cmd, conv_keys=True, **args):\n-        '''Invoke a QMP command and return the result dict'''\n+        '''Invoke a QMP command and return the response dict'''\n         qmp_args = dict()\n-        for k in args.keys():\n+        for key in args.keys():\n             if conv_keys:\n-                qmp_args[k.translate(self.underscore_to_dash)] = args[k]\n+                qmp_args[key.translate(self.underscore_to_dash)] = args[key]\n             else:\n-                qmp_args[k] = args[k]\n+                qmp_args[key] = args[key]\n \n         return self._qmp.cmd(cmd, args=qmp_args)\n \n     def command(self, cmd, conv_keys=True, **args):\n+        '''\n+        Invoke a QMP command.\n+        On success return the response dict.\n+        On failure raise an exception.\n+        '''\n         reply = self.qmp(cmd, conv_keys, **args)\n         if reply is None:\n             raise Exception(\"Monitor is closed\")\n@@ -207,7 +232,15 @@ class QEMUMachine(object):\n         return events\n \n     def event_wait(self, name, timeout=60.0, match=None):\n-        # Test if 'match' is a recursive subset of 'event'\n+        '''\n+        Wait for specified timeout on named event in QMP; optionally filter\n+        results by match.\n+\n+        The 'match' is checked to be a recursive subset of the 'event'; skips\n+        branch processing on match's value None\n+           {\"foo\": {\"bar\": 1}} matches {\"foo\": None}\n+           {\"foo\": {\"bar\": 1}} does not matches {\"foo\": {\"baz\": None}}\n+        '''\n         def event_match(event, match=None):\n             if match is None:\n                 return True\n@@ -240,4 +273,8 @@ class QEMUMachine(object):\n         return None\n \n     def get_log(self):\n+        '''\n+        After self.shutdown or failed qemu execution, this returns the output\n+        of the qemu process.\n+        '''\n         return self._iolog\n","prefixes":["PULL","01/15"]}