diff -r e9e7eca7efee -r bf71ee032bb4 src/eric7/Utilities/BackgroundClient.py
--- a/src/eric7/Utilities/BackgroundClient.py Wed Jul 13 11:16:20 2022 +0200
+++ b/src/eric7/Utilities/BackgroundClient.py Wed Jul 13 14:55:47 2022 +0200
@@ -24,10 +24,11 @@
"""
Class implementing the main part of the background client.
"""
+
def __init__(self, host, port, maxProcs):
"""
Constructor
-
+
@param host ip address the background service is listening
@type str
@param port port of the background service
@@ -38,16 +39,16 @@
"""
self.services = {}
self.batchServices = {}
-
+
self.connection = socket.create_connection((host, port))
- ver = b'Python3'
+ ver = b"Python3"
self.connection.sendall(ver)
self.__maxProcs = maxProcs
def __initClientService(self, fn, path, module):
"""
Private method to import the given module and register it as service.
-
+
@param fn service name to register
@type str
@param path contains the path to the module
@@ -62,12 +63,10 @@
importedModule = __import__(module, globals(), locals(), [], 0)
self.services[fn] = importedModule.initService()
with contextlib.suppress(AttributeError):
- self.batchServices["batch_" + fn] = (
- importedModule.initBatchService()
- )
- return 'ok'
+ self.batchServices["batch_" + fn] = importedModule.initBatchService()
+ return "ok"
except ImportError as err:
- return 'Import Error: ' + str(err)
+ return "Import Error: " + str(err)
except Exception as err:
return str(err)
@@ -75,7 +74,7 @@
"""
Private method to send a job response back to the BackgroundService
server.
-
+
@param fx remote function name to execute
@type str
@param fn filename for identification
@@ -83,116 +82,130 @@
@param data return value(s)
@type any basic datatype
"""
- if not isinstance(data, (
- dict, list, tuple, str, int, float, bool, type(None),
- )):
+ if not isinstance(
+ data,
+ (
+ dict,
+ list,
+ tuple,
+ str,
+ int,
+ float,
+ bool,
+ type(None),
+ ),
+ ):
# handle sending of objects of unsupported types
data = str(data)
-
+
packedData = json.dumps([fx, fn, data])
- packedData = bytes(packedData, 'utf-8')
- header = struct.pack(
- b'!II', len(packedData), adler32(packedData) & 0xffffffff)
+ packedData = bytes(packedData, "utf-8")
+ header = struct.pack(b"!II", len(packedData), adler32(packedData) & 0xFFFFFFFF)
self.connection.sendall(header)
self.connection.sendall(packedData)
def __receive(self, length):
"""
Private method to receive the given length of bytes.
-
+
@param length bytes to receive
@type int
@return received bytes or None if connection closed
@rtype bytes
"""
- data = b''
+ data = b""
while len(data) < length:
newData = self.connection.recv(length - len(data))
if not newData:
return None
data += newData
return data
-
+
def __peek(self, length):
"""
Private method to peek the given length of bytes.
-
+
@param length bytes to receive
@type int
@return received bytes
@rtype bytes
"""
- data = b''
+ data = b""
self.connection.setblocking(False)
try:
with contextlib.suppress(OSError):
data = self.connection.recv(length, socket.MSG_PEEK)
finally:
self.connection.setblocking(True)
-
+
return data
-
+
def __cancelled(self):
"""
Private method to check for a job cancellation.
-
+
@return flag indicating a cancellation
@rtype bool
"""
- msg = self.__peek(struct.calcsize(b'!II') + 6)
+ msg = self.__peek(struct.calcsize(b"!II") + 6)
if msg[-6:] == b"CANCEL":
# get rid of the message data
- self.__receive(struct.calcsize(b'!II') + 6)
+ self.__receive(struct.calcsize(b"!II") + 6)
return True
else:
return False
-
+
def run(self):
"""
Public method implementing the main loop of the client.
-
+
@exception RuntimeError raised if hashes don't match
"""
try:
while True:
- header = self.__receive(struct.calcsize(b'!II'))
+ header = self.__receive(struct.calcsize(b"!II"))
# Leave main loop if connection was closed.
if not header:
break
-
- length, datahash = struct.unpack(b'!II', header)
+
+ length, datahash = struct.unpack(b"!II", header)
messageType = self.__receive(6)
packedData = self.__receive(length)
-
+
if messageType != b"JOB ":
continue
-
- if adler32(packedData) & 0xffffffff != datahash:
- raise RuntimeError('Hashes not equal')
-
- packedData = packedData.decode('utf-8')
-
+
+ if adler32(packedData) & 0xFFFFFFFF != datahash:
+ raise RuntimeError("Hashes not equal")
+
+ packedData = packedData.decode("utf-8")
+
fx, fn, data = json.loads(packedData)
- if fx == 'INIT':
+ if fx == "INIT":
ret = self.__initClientService(fn, *data)
elif fx.startswith("batch_"):
callback = self.batchServices.get(fx)
if callback:
- callback(data, self.__send, fx, self.__cancelled,
- maxProcesses=self.__maxProcs)
+ callback(
+ data,
+ self.__send,
+ fx,
+ self.__cancelled,
+ maxProcesses=self.__maxProcs,
+ )
ret = "__DONE__"
else:
- ret = 'Unknown batch service.'
+ ret = "Unknown batch service."
else:
callback = self.services.get(fx)
if callback:
ret = callback(fn, *data)
else:
- ret = 'Unknown service.'
-
+ ret = "Unknown service."
+
if isinstance(ret, Exception):
ret = str(ret)
-
+
self.__send(fx, fn, ret)
except OSError:
pass
@@ -203,9 +216,8 @@
tbinfofile.seek(0)
tbinfo = tbinfofile.read()
del exctb
- self.__send(
- 'EXCEPTION', '?', [str(exctype), str(excval), tbinfo])
-
+ self.__send("EXCEPTION", "?", [str(exctype), str(excval), tbinfo])
+
finally:
# Give time to process latest response on server side
time.sleep(0.5)
@@ -213,18 +225,21 @@
self.connection.shutdown(socket.SHUT_RDWR)
self.connection.close()
-if __name__ == '__main__':
+
+if __name__ == "__main__":
if len(sys.argv) != 5:
- print('Host, port, max. processes and Python library path parameters'
- ' are missing. Aborting...')
+ print(
+ "Host, port, max. processes and Python library path parameters"
+ " are missing. Aborting..."
+ )
sys.exit(1)
-
+
host, port, maxProcs, pyLibraryPath = sys.argv[1:]
-
+
# insert pyLibraryPath into the search path because external stuff might
# be installed in the eric (virtual) environment
sys.path.insert(1, pyLibraryPath)
-
+
backgroundClient = BackgroundClient(host, int(port), int(maxProcs))
# Start the main loop
backgroundClient.run()
