[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v5 14/16] python/qemu: make 'args' style arguments immutable
From: |
John Snow |
Subject: |
[PATCH v5 14/16] python/qemu: make 'args' style arguments immutable |
Date: |
Fri, 10 Jul 2020 01:22:18 -0400 |
These arguments don't need to be mutable and aren't really used as
such. Clarify their types as immutable and adjust code to match where
necessary.
In general, It's probably best not to accept a user-defined mutable
object and store it as internal object state unless there's a strong
justification for doing so. Instead, try to use generic types as input
with empty tuples as the default, and coerce to list where necessary.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
---
python/qemu/machine.py | 30 +++++++++++++++++-------------
python/qemu/qtest.py | 16 ++++++++++++----
2 files changed, 29 insertions(+), 17 deletions(-)
diff --git a/python/qemu/machine.py b/python/qemu/machine.py
index 2ba5e3134e..f7239a249b 100644
--- a/python/qemu/machine.py
+++ b/python/qemu/machine.py
@@ -18,6 +18,7 @@
#
import errno
+from itertools import chain
import logging
import os
import subprocess
@@ -30,6 +31,8 @@
Dict,
List,
Optional,
+ Sequence,
+ Tuple,
Type,
)
from types import TracebackType
@@ -74,8 +77,12 @@ class QEMUMachine:
# vm is guaranteed to be shut down here
"""
- def __init__(self, binary, args=None, wrapper=None, name=None,
- test_dir="/var/tmp",
+ def __init__(self,
+ binary: str,
+ args: Sequence[str] = (),
+ wrapper: Sequence[str] = (),
+ name: Optional[str] = None,
+ test_dir: str = "/var/tmp",
monitor_address: Optional[SocketAddrT] = None,
socket_scm_helper=None, sock_dir=None):
'''
@@ -93,14 +100,7 @@ def __init__(self, binary, args=None, wrapper=None,
name=None,
# Direct user configuration
self._binary = binary
-
- if args is None:
- args = []
- # Copy mutable input: we will be modifying our copy
self._args = list(args)
-
- if wrapper is None:
- wrapper = []
self._wrapper = wrapper
self._name = name or "qemu-%d" % os.getpid()
@@ -125,7 +125,7 @@ def __init__(self, binary, args=None, wrapper=None,
name=None,
self._iolog = None
self._qmp_set = True # Enable QMP monitor by default.
self._qmp_connection: Optional[qmp.QEMUMonitorProtocol] = None
- self._qemu_full_args = None
+ self._qemu_full_args: Tuple[str, ...] = ()
self._temp_dir = None
self._launched = False
self._machine = None
@@ -357,7 +357,7 @@ def launch(self):
raise QEMUMachineError('VM already launched')
self._iolog = None
- self._qemu_full_args = None
+ self._qemu_full_args = ()
try:
self._launch()
self._launched = True
@@ -377,8 +377,12 @@ def _launch(self):
"""
devnull = open(os.path.devnull, 'rb')
self._pre_launch()
- self._qemu_full_args = (self._wrapper + [self._binary] +
- self._base_args + self._args)
+ self._qemu_full_args = tuple(
+ chain(self._wrapper,
+ [self._binary],
+ self._base_args,
+ self._args)
+ )
LOG.debug('VM launch command: %r', ' '.join(self._qemu_full_args))
self._popen = subprocess.Popen(self._qemu_full_args,
stdin=devnull,
diff --git a/python/qemu/qtest.py b/python/qemu/qtest.py
index 05c63a1d58..ae4661d4d3 100644
--- a/python/qemu/qtest.py
+++ b/python/qemu/qtest.py
@@ -22,6 +22,7 @@
from typing import (
List,
Optional,
+ Sequence,
TextIO,
)
@@ -103,8 +104,13 @@ class QEMUQtestMachine(QEMUMachine):
A QEMU VM, with a qtest socket available.
"""
- def __init__(self, binary, args=None, name=None, test_dir="/var/tmp",
- socket_scm_helper=None, sock_dir=None):
+ def __init__(self,
+ binary: str,
+ args: Sequence[str] = (),
+ name: Optional[str] = None,
+ test_dir: str = "/var/tmp",
+ socket_scm_helper: Optional[str] = None,
+ sock_dir: Optional[str] = None):
if name is None:
name = "qemu-%d" % os.getpid()
if sock_dir is None:
@@ -118,8 +124,10 @@ def __init__(self, binary, args=None, name=None,
test_dir="/var/tmp",
@property
def _base_args(self) -> List[str]:
args = super()._base_args
- args.extend(['-qtest', 'unix:path=' + self._qtest_path,
- '-accel', 'qtest'])
+ args.extend([
+ '-qtest', f"unix:path={self._qtest_path}",
+ '-accel', 'qtest'
+ ])
return args
def _pre_launch(self):
--
2.21.3
- [PATCH v5 06/16] python/qmp.py: add QMPProtocolError, (continued)
- [PATCH v5 06/16] python/qmp.py: add QMPProtocolError, John Snow, 2020/07/10
- [PATCH v5 07/16] python/machine.py: Fix monitor address typing, John Snow, 2020/07/10
- [PATCH v5 08/16] python/machine.py: reorder __init__, John Snow, 2020/07/10
- [PATCH v5 10/16] python/machine.py: Handle None events in events_wait, John Snow, 2020/07/10
- [PATCH v5 09/16] python/machine.py: Don't modify state in _base_args(), John Snow, 2020/07/10
- [PATCH v5 12/16] python/machine.py: Add _qmp access shim, John Snow, 2020/07/10
- [PATCH v5 11/16] python/machine.py: use qmp.command, John Snow, 2020/07/10
- [PATCH v5 13/16] python/machine.py: fix _popen access, John Snow, 2020/07/10
- [PATCH v5 14/16] python/qemu: make 'args' style arguments immutable,
John Snow <=
- [PATCH v5 15/16] iotests.py: Adjust HMP kwargs typing, John Snow, 2020/07/10
- [PATCH v5 16/16] python/qemu: Add mypy type annotations, John Snow, 2020/07/10
- Re: [PATCH v5 00/16] python: add mypy support to python/qemu, Philippe Mathieu-Daudé, 2020/07/14