From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Niteesh G . S ." <niteesh.gs@gmail.com>,
Cleber Rosa <crosa@redhat.com>, John Snow <jsnow@redhat.com>,
Markus Armbruster <armbru@redhat.com>,
Eduardo Habkost <ehabkost@redhat.com>
Subject: [PATCH 37/42] scripts/qmp-shell: remove double-underscores
Date: Mon, 7 Jun 2021 16:06:44 -0400 [thread overview]
Message-ID: <20210607200649.1840382-38-jsnow@redhat.com> (raw)
In-Reply-To: <20210607200649.1840382-1-jsnow@redhat.com>
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>
---
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
next prev parent reply other threads:[~2021-06-07 20:23 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-07 20:06 [PATCH 00/42] python: move qmp-shell into qemu.qmp package John Snow
2021-06-07 20:06 ` [PATCH 01/42] scripts/qmp-shell: apply isort rules John Snow
2021-06-07 20:06 ` [PATCH 02/42] scripts/qmp-shell: Apply flake8 rules John Snow
2021-06-07 20:06 ` [PATCH 03/42] scripts/qmp-shell: fix show_banner signature John Snow
2021-06-07 20:06 ` [PATCH 04/42] scripts/qmp-shell: fix exception handling John Snow
2021-06-07 20:06 ` [PATCH 05/42] scripts/qmp-shell: fix connect method signature John Snow
2021-06-07 20:06 ` [PATCH 06/42] scripts/qmp-shell: remove shadowed variable from _print() John Snow
2021-06-07 20:06 ` [PATCH 07/42] scripts/qmp-shell: use @classmethod where appropriate John Snow
2021-06-07 20:06 ` [PATCH 08/42] scripts/qmp-shell: Use python3-style super() John Snow
2021-06-07 20:06 ` [PATCH 09/42] scripts/qmp-shell: declare verbose in __init__ John Snow
2021-06-07 20:06 ` [PATCH 10/42] scripts/qmp-shell: use triple-double-quote docstring style John Snow
2021-06-07 20:06 ` [PATCH 11/42] scripts/qmp-shell: ignore visit_Name name John Snow
2021-06-07 20:06 ` [PATCH 12/42] scripts/qmp-shell: make QMPCompleter returns explicit John Snow
2021-06-07 20:06 ` [PATCH 13/42] scripts/qmp-shell: rename one and two-letter variables John Snow
2021-06-07 20:06 ` [PATCH 14/42] scripts/qmp-shell: fix shell history exception handling John Snow
2021-06-07 20:06 ` [PATCH 15/42] scripts/qmp-shell: remove if-raise-else patterns John Snow
2021-06-07 20:06 ` [PATCH 16/42] scripts/qmp-shell: use isinstance() instead of type() John Snow
2021-06-07 20:06 ` [PATCH 17/42] scripts/qmp-shell: use argparse John Snow
2021-06-07 20:06 ` [PATCH 18/42] scripts/qmp-shell: Add pretty attribute to HMP shell John Snow
2021-06-07 20:06 ` [PATCH 19/42] scripts/qmp-shell: Make verbose a public attribute John Snow
2021-06-07 20:06 ` [PATCH 20/42] scripts/qmp-shell: move get_prompt() to prompt property John Snow
2021-06-07 20:06 ` [PATCH 21/42] scripts/qmp-shell: remove prompt argument from read_exec_command John Snow
2021-06-07 20:06 ` [PATCH 22/42] scripts/qmp-shell: move the REPL functionality into QMPShell John Snow
2021-06-07 20:06 ` [PATCH 23/42] scripts/qmp-shell: Fix "FuzzyJSON" parser John Snow
2021-06-07 20:06 ` [PATCH 24/42] scripts/qmp-shell: refactor QMPCompleter John Snow
2021-06-07 20:06 ` [PATCH 25/42] scripts/qmp-shell: initialize completer early John Snow
2021-06-07 20:06 ` [PATCH 26/42] python/qmp: add QMPObject type alias John Snow
2021-06-07 20:06 ` [PATCH 27/42] scripts/qmp-shell: add mypy types John Snow
2021-06-07 20:06 ` [PATCH 28/42] scripts/qmp-shell: Accept SocketAddrT instead of string John Snow
2021-06-07 20:06 ` [PATCH 29/42] scripts/qmp-shell: unprivatize 'pretty' property John Snow
2021-06-07 20:06 ` [PATCH 30/42] python/qmp: return generic type from context manager John Snow
2021-06-07 20:06 ` [PATCH 31/42] scripts/qmp-shell: Use context manager instead of atexit John Snow
2021-06-07 20:06 ` [PATCH 32/42] scripts/qmp-shell: use logging to show warnings John Snow
2021-06-07 20:06 ` [PATCH 33/42] scripts/qmp-shell: remove TODO John Snow
2021-06-07 20:06 ` [PATCH 34/42] scripts/qmp-shell: Fix empty-transaction invocation John Snow
2021-06-07 20:06 ` [PATCH 35/42] scripts/qmp-shell: Remove too-broad-exception John Snow
2021-06-07 20:06 ` [PATCH 36/42] scripts/qmp-shell: convert usage comment to docstring John Snow
2021-06-07 20:06 ` John Snow [this message]
2021-06-07 20:06 ` [PATCH 38/42] scripts/qmp-shell: make QMPShellError inherit QMPError John Snow
2021-06-07 20:06 ` [PATCH 39/42] scripts/qmp-shell: add docstrings John Snow
2021-06-07 20:06 ` [PATCH 40/42] scripts/qmp-shell: move to python/qemu/qmp/qmp_shell.py John Snow
2021-06-07 20:06 ` [PATCH 41/42] python: add qmp-shell entry point John Snow
2021-06-07 20:06 ` [PATCH 42/42] scripts/qmp-shell: add redirection shim John Snow
2021-06-14 18:09 ` [PATCH 00/42] python: move qmp-shell into qemu.qmp package John Snow
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210607200649.1840382-38-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=ehabkost@redhat.com \
--cc=niteesh.gs@gmail.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).