diff -r e9e7eca7efee -r bf71ee032bb4 src/eric7/EricNetwork/EricJsonClient.py
--- a/src/eric7/EricNetwork/EricJsonClient.py Wed Jul 13 11:16:20 2022 +0200
+++ b/src/eric7/EricNetwork/EricJsonClient.py Wed Jul 13 14:55:47 2022 +0200
@@ -20,10 +20,11 @@
"""
Class implementing a JSON based client base class.
"""
+
def __init__(self, host, port, idString=""):
"""
Constructor
-
+
@param host IP address the background service is listening
@type str
@param port port of the background service
@@ -34,13 +35,13 @@
"""
self.__connection = socket.create_connection((host, port))
if idString:
- reply = idString + '\n'
- self.__connection.sendall(reply.encode('utf8', 'backslashreplace'))
-
+ reply = idString + "\n"
+ self.__connection.sendall(reply.encode("utf8", "backslashreplace"))
+
def sendJson(self, command, params):
"""
Public method to send a single refactoring command to the server.
-
+
@param command command name to be sent
@type str
@param params dictionary of named parameters for the command
@@ -51,14 +52,14 @@
"method": command,
"params": params,
}
- cmd = json.dumps(commandDict) + '\n'
- self.__connection.sendall(cmd.encode('utf8', 'backslashreplace'))
-
+ cmd = json.dumps(commandDict) + "\n"
+ self.__connection.sendall(cmd.encode("utf8", "backslashreplace"))
+
def __receiveJson(self):
"""
Private method to receive a JSON encode command and data from the
server.
-
+
@return tuple containing the received command and a dictionary
containing the associated data
@rtype tuple of (str, dict)
@@ -69,48 +70,50 @@
if len(length) < 9:
# invalid length string received
return None, None
-
+
length = int(length)
- data = b''
+ data = b""
while len(data) < length:
newData = self.__connection.recv(length - len(data))
if not newData:
return None, None
-
+
data += newData
-
+
# step 2: decode and convert the data
- line = data.decode(
- 'utf8', 'backslashreplace')
+ line = data.decode("utf8", "backslashreplace")
try:
commandDict = json.loads(line.strip())
except (TypeError, ValueError) as err:
- self.sendJson("ClientException", {
- "ExceptionType": "ProtocolError",
- "ExceptionValue": str(err),
- "ProtocolData": line.strip(),
- })
+ self.sendJson(
+ "ClientException",
+ {
+ "ExceptionType": "ProtocolError",
+ "ExceptionValue": str(err),
+ "ProtocolData": line.strip(),
+ },
+ )
return None, None
-
+
method = commandDict["method"]
params = commandDict["params"]
-
+
return method, params
-
+
def handleCall(self, method, params):
"""
Public method to handle a method call from the server.
-
+
Note: This is an empty implementation that must be overridden in
derived classes.
-
+
@param method requested method name
@type str
@param params dictionary with method specific parameters
@type dict
"""
pass
-
+
def run(self):
"""
Public method implementing the main loop of the client.
@@ -119,9 +122,8 @@
selectErrors = 0
while selectErrors <= 10: # selected arbitrarily
try:
- rrdy, wrdy, xrdy = select.select(
- [self.__connection], [], [])
-
+ rrdy, wrdy, xrdy = select.select([self.__connection], [], [])
+
# Just waiting for self.__connection. Therefor no check
# needed.
method, params = self.__receiveJson()
@@ -131,13 +133,13 @@
break
else:
self.handleCall(method, params)
-
+
# reset select errors
selectErrors = 0
-
+
except (select.error, KeyboardInterrupt, socket.error):
selectErrors += 1
-
+
except Exception:
exctype, excval, exctb = sys.exc_info()
tbinfofile = io.StringIO()
@@ -145,21 +147,24 @@
tbinfofile.seek(0)
tbinfo = tbinfofile.read()
del exctb
- self.sendJson("ClientException", {
- "ExceptionType": str(exctype),
- "ExceptionValue": str(excval),
- "Traceback": tbinfo,
- })
+ self.sendJson(
+ "ClientException",
+ {
+ "ExceptionType": str(exctype),
+ "ExceptionValue": str(excval),
+ "Traceback": tbinfo,
+ },
+ )
# Give time to process latest response on server side
with contextlib.suppress(socket.error, OSError):
self.__connection.shutdown(socket.SHUT_RDWR)
self.__connection.close()
-
+
def poll(self, waitMethod=""):
"""
Public method to check and receive one message (if available).
-
+
@param waitMethod name of a method to wait for
@type str
@return dictionary containing the data of the waited for method
@@ -167,12 +172,10 @@
"""
try:
if waitMethod:
- rrdy, wrdy, xrdy = select.select(
- [self.__connection], [], [])
+ rrdy, wrdy, xrdy = select.select([self.__connection], [], [])
else:
- rrdy, wrdy, xrdy = select.select(
- [self.__connection], [], [], 0)
-
+ rrdy, wrdy, xrdy = select.select([self.__connection], [], [], 0)
+
if self.__connection in rrdy:
method, params = self.__receiveJson()
if method is not None:
@@ -182,11 +185,11 @@
return params
else:
self.handleCall(method, params)
-
+
except (select.error, KeyboardInterrupt, socket.error):
# just ignore these
pass
-
+
except Exception:
exctype, excval, exctb = sys.exc_info()
tbinfofile = io.StringIO()
@@ -194,10 +197,13 @@
tbinfofile.seek(0)
tbinfo = tbinfofile.read()
del exctb
- self.sendJson("ClientException", {
- "ExceptionType": str(exctype),
- "ExceptionValue": str(excval),
- "Traceback": tbinfo,
- })
-
+ self.sendJson(
+ "ClientException",
+ {
+ "ExceptionType": str(exctype),
+ "ExceptionValue": str(excval),
+ "Traceback": tbinfo,
+ },
+ )
+
return None
