From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: Kevin Wolf <kwolf@redhat.com>,
Peter Maydell <peter.maydell@linaro.org>,
Eduardo Habkost <ehabkost@redhat.com>,
qemu-block@nongnu.org, Max Reitz <mreitz@redhat.com>,
Cleber Rosa <crosa@redhat.com>, John Snow <jsnow@redhat.com>
Subject: [PULL 16/21] python/qemu/console_socket.py: Add type hint annotations
Date: Tue, 20 Oct 2020 13:27:37 -0400 [thread overview]
Message-ID: <20201020172742.1483258-17-jsnow@redhat.com> (raw)
In-Reply-To: <20201020172742.1483258-1-jsnow@redhat.com>
Finish the typing of console_socket.py with annotations and no code
changes.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Message-id: 20201006235817.3280413-16-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
---
python/qemu/console_socket.py | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/python/qemu/console_socket.py b/python/qemu/console_socket.py
index d4669c441d..57e6eee017 100644
--- a/python/qemu/console_socket.py
+++ b/python/qemu/console_socket.py
@@ -17,7 +17,7 @@
import socket
import threading
import time
-from typing import Optional
+from typing import Deque, Optional
class ConsoleSocket(socket.socket):
@@ -30,11 +30,11 @@ class ConsoleSocket(socket.socket):
Optionally a file path can be passed in and we will also
dump the characters to this file for debugging purposes.
"""
- def __init__(self, address, file=None, drain=False):
- self._recv_timeout_sec = 300
+ def __init__(self, address: str, file: Optional[str] = None,
+ drain: bool = False):
self._recv_timeout_sec = 300.0
self._sleep_time = 0.5
- self._buffer = deque()
+ self._buffer: Deque[str] = deque()
socket.socket.__init__(self, socket.AF_UNIX, socket.SOCK_STREAM)
self.connect(address)
self._logfile = None
@@ -45,7 +45,7 @@ def __init__(self, address, file=None, drain=False):
if drain:
self._drain_thread = self._thread_start()
- def _drain_fn(self):
+ def _drain_fn(self) -> None:
"""Drains the socket and runs while the socket is open."""
while self._open:
try:
@@ -56,7 +56,7 @@ def _drain_fn(self):
# self._open is set to False.
time.sleep(self._sleep_time)
- def _thread_start(self):
+ def _thread_start(self) -> threading.Thread:
"""Kick off a thread to drain the socket."""
# Configure socket to not block and timeout.
# This allows our drain thread to not block
@@ -68,7 +68,7 @@ def _thread_start(self):
drain_thread.start()
return drain_thread
- def close(self):
+ def close(self) -> None:
"""Close the base object and wait for the thread to terminate"""
if self._open:
self._open = False
@@ -80,7 +80,7 @@ def close(self):
self._logfile.close()
self._logfile = None
- def _drain_socket(self):
+ def _drain_socket(self) -> None:
"""process arriving characters into in memory _buffer"""
data = socket.socket.recv(self, 1)
# latin1 is needed since there are some chars
@@ -114,7 +114,7 @@ def recv(self, bufsize: int = 1, flags: int = 0) -> bytes:
# socket w/o our intervention.
return chars.encode("latin1")
- def setblocking(self, value):
+ def setblocking(self, value: bool) -> None:
"""When not draining we pass thru to the socket,
since when draining we control socket blocking.
"""
--
2.26.2
next prev parent reply other threads:[~2020-10-20 17:54 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-20 17:27 [PULL 00/21] Python patches John Snow
2020-10-20 17:27 ` [PULL 01/21] MAINTAINERS: Add Python library stanza John Snow
2020-10-20 17:27 ` [PULL 02/21] python/qemu: use isort to lay out imports John Snow
2020-10-20 17:27 ` [PULL 03/21] python/machine.py: Fix monitor address typing John Snow
2020-10-20 17:27 ` [PULL 04/21] python/machine.py: reorder __init__ John Snow
2020-10-20 17:27 ` [PULL 05/21] python/machine.py: Don't modify state in _base_args() John Snow
2020-10-20 17:27 ` [PULL 06/21] python/machine.py: Handle None events in events_wait John Snow
2020-10-20 17:27 ` [PULL 07/21] python/machine.py: use qmp.command John Snow
2020-10-20 17:27 ` [PULL 08/21] python/machine.py: Add _qmp access shim John Snow
2020-10-20 17:27 ` [PULL 09/21] python/machine.py: fix _popen access John Snow
2020-10-20 17:27 ` [PULL 10/21] python/qemu: make 'args' style arguments immutable John Snow
2020-10-20 17:27 ` [PULL 11/21] iotests.py: Adjust HMP kwargs typing John Snow
2020-10-20 17:27 ` [PULL 12/21] python/qemu: Add mypy type annotations John Snow
2020-10-20 17:27 ` [PULL 13/21] python/qemu/console_socket.py: Correct type of recv() John Snow
2020-10-20 17:27 ` [PULL 14/21] python/qemu/console_socket.py: fix typing of settimeout John Snow
2020-10-20 17:27 ` [PULL 15/21] python/qemu/console_socket.py: Clarify type of drain_thread John Snow
2020-10-20 17:27 ` John Snow [this message]
2020-10-20 17:27 ` [PULL 17/21] python/qemu/console_socket.py: avoid encoding to/from string John Snow
2020-10-20 17:27 ` [PULL 18/21] python/qemu/qmp.py: Preserve error context on re-raise John Snow
2020-10-20 17:27 ` [PULL 19/21] python: add mypy config John Snow
2020-10-20 17:27 ` [PULL 20/21] python/qemu/qmp.py: re-raise OSError when encountered John Snow
2020-10-20 18:15 ` Nir Soffer
2020-10-20 19:06 ` John Snow
2020-10-20 17:27 ` [PULL 21/21] python/qemu/qmp.py: Fix settimeout operation 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=20201020172742.1483258-17-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=crosa@redhat.com \
--cc=ehabkost@redhat.com \
--cc=kwolf@redhat.com \
--cc=mreitz@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-block@nongnu.org \
--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).