From 82e6517d9d0a1ce9fdc09919af26775a5127a5ec Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 29 Jun 2021 17:43:11 -0400 Subject: python: Remove global pylint suppressions These suppressions only apply to a small handful of places. Instead of disabling them globally, disable them just in the cases where we need. The design of the machine class grew quite organically with tons of constructor and class instance variables -- there's little chance of meaningfully refactoring it in the near term, so just suppress the warnings for that class. Signed-off-by: John Snow Reviewed-by: Willian Rampazzo Reviewed-by: Wainer dos Santos Moschetta Message-id: 20210629214323.1329806-4-jsnow@redhat.com Signed-off-by: John Snow --- python/qemu/machine/machine.py | 3 +++ 1 file changed, 3 insertions(+) (limited to 'python/qemu/machine/machine.py') diff --git a/python/qemu/machine/machine.py b/python/qemu/machine/machine.py index b62435528e..e3345dfa1b 100644 --- a/python/qemu/machine/machine.py +++ b/python/qemu/machine/machine.py @@ -84,6 +84,7 @@ class QEMUMachine: ... # vm is guaranteed to be shut down here """ + # pylint: disable=too-many-instance-attributes, too-many-public-methods def __init__(self, binary: str, @@ -111,6 +112,8 @@ class QEMUMachine: @param console_log: (optional) path to console log file @note: Qemu process is not started until launch() is used. ''' + # pylint: disable=too-many-arguments + # Direct user configuration self._binary = binary -- cgit 1.4.1 From 5c02c865866fdd2d17e8f5507deb4aa1f74bf59f Mon Sep 17 00:00:00 2001 From: John Snow Date: Tue, 29 Jun 2021 17:43:23 -0400 Subject: python: Fix broken ReST docstrings This patch *doesn't* update all of the docstring standards across the QEMU package directory to make our docstring usage consistent. It *doesn't* fix the formatting to make it look pretty or reasonable in generated output. It *does* fix a few small instances where Sphinx would emit a build warning because of malformed ReST -- If we built our Python docs with Sphinx. Signed-off-by: John Snow Reviewed-by: Willian Rampazzo Reviewed-by: Wainer dos Santos Moschetta Message-id: 20210629214323.1329806-16-jsnow@redhat.com Signed-off-by: John Snow --- python/qemu/machine/__init__.py | 6 +++--- python/qemu/machine/machine.py | 3 ++- python/qemu/qmp/__init__.py | 1 + python/qemu/qmp/qom_common.py | 2 +- python/qemu/utils/accel.py | 2 +- 5 files changed, 8 insertions(+), 6 deletions(-) (limited to 'python/qemu/machine/machine.py') diff --git a/python/qemu/machine/__init__.py b/python/qemu/machine/__init__.py index 728f27adbe..9ccd58ef14 100644 --- a/python/qemu/machine/__init__.py +++ b/python/qemu/machine/__init__.py @@ -4,10 +4,10 @@ QEMU development and testing library. This library provides a few high-level classes for driving QEMU from a test suite, not intended for production use. -- QEMUMachine: Configure and Boot a QEMU VM - - QEMUQtestMachine: VM class, with a qtest socket. + | QEMUQtestProtocol: send/receive qtest messages. + | QEMUMachine: Configure and Boot a QEMU VM + | +-- QEMUQtestMachine: VM class, with a qtest socket. -- QEMUQtestProtocol: Connect to, send/receive qtest messages. """ # Copyright (C) 2020-2021 John Snow for Red Hat Inc. diff --git a/python/qemu/machine/machine.py b/python/qemu/machine/machine.py index e3345dfa1b..d47ab3d896 100644 --- a/python/qemu/machine/machine.py +++ b/python/qemu/machine/machine.py @@ -545,7 +545,8 @@ class QEMUMachine: @param enabled: if False, qmp monitor options will be removed from the base arguments of the resulting QEMU command line. Default is True. - @note: call this function before launch(). + + .. note:: Call this function before launch(). """ self._qmp_set = enabled diff --git a/python/qemu/qmp/__init__.py b/python/qemu/qmp/__init__.py index 376954cb6d..269516a79b 100644 --- a/python/qemu/qmp/__init__.py +++ b/python/qemu/qmp/__init__.py @@ -279,6 +279,7 @@ class QEMUMonitorProtocol: None). The value passed will set the behavior of the underneath QMP socket as described in [1]. Default value is set to 15.0. + @return QMP greeting dict @raise OSError on socket connection errors @raise QMPConnectError if the greeting is not received diff --git a/python/qemu/qmp/qom_common.py b/python/qemu/qmp/qom_common.py index f82b16772d..a59ae1a2a1 100644 --- a/python/qemu/qmp/qom_common.py +++ b/python/qemu/qmp/qom_common.py @@ -156,7 +156,7 @@ class QOMCommand: """ Run a fully-parsed subcommand, with error-handling for the CLI. - :return: The return code from `.run()`. + :return: The return code from `run()`. """ try: cmd = cls(args) diff --git a/python/qemu/utils/accel.py b/python/qemu/utils/accel.py index 297933df2a..386ff640ca 100644 --- a/python/qemu/utils/accel.py +++ b/python/qemu/utils/accel.py @@ -36,7 +36,7 @@ def list_accel(qemu_bin: str) -> List[str]: List accelerators enabled in the QEMU binary. @param qemu_bin (str): path to the QEMU binary. - @raise Exception: if failed to run `qemu -accel help` + @raise Exception: if failed to run ``qemu -accel help`` @return a list of accelerator names. """ if not qemu_bin: -- cgit 1.4.1