Updated error handling. If the client couldn't connect to Unreal, the response was just "False", which was pretty bad. You now get a proper error string back

Author: nielsvaes

skyhook/client.py

@@ -1,6 +1,7 @@
 import pprint
+from datetime import datetime
 
-from .constants import HostPrograms, Results, Ports, ServerCommands
+from .constants import HostPrograms, Results, Ports, ServerCommands, Errors
 import requests
 
 try:
@@ -91,7 +92,7 @@ def is_host_online(self):
         :return: *bool*
         """
         response = self.execute("is_online", {})
-        return response.get(Results.return_value)
+        return response.get(Results.return_value) is True
 
 
     def execute(self, command, parameters={}, timeout=0):
@@ -127,7 +128,21 @@ def execute(self, command, parameters={}, timeout=0):
 
         url = "http://%s:%s" % (self.host_address, self.port)
         payload = self.__create_payload(command, parameters)
-        response = requests.post(url, json=payload, timeout=timeout).json()
+
+
+        # set the response dictionary to be NO_RESPONSE
+        response = {
+            Results.time: datetime.now().strftime("%H:%M:%S"),
+            Results.success: False,
+            Results.return_value: Errors.NO_RESPONSE,
+            Results.command: command
+        }
+
+        try:
+            # the response
+            response = requests.post(url, json=payload, timeout=timeout).json()
+        except requests.exceptions.ConnectionError as err:
+            response[Results.return_value] = "\n".join([Errors.CANT_REACH_SERVER, str(err)])
 
         if self.echo_payload():
             pprint.pprint(payload)
@@ -235,7 +250,7 @@ def execute(self, command, parameters={}, timeout=0, function=True, property=Fal
         try:
             response = requests.put(url, json=payload, headers=self.__headers, timeout=timeout).json()
         except requests.exceptions.ConnectionError:
-            response = {"ReturnValue": False}
+            response = {Results.return_value: Errors.CANT_REACH_SERVER}
 
         try:
             # UE 4.26: Returning an unreal.Array() that's not empty crashes the editor

skyhook/constants.py

@@ -57,11 +57,13 @@ class Errors:
     """
     Errors when things go wrong
     """
-    CALLING_FUNCTION = "An error occurred when calling the function"
-    IN_FUNCTION      = "An error occurred when executing the function"
-    SERVER_COMMAND   = "An error occurred processing this server command"
-    SERVER_RELOAD    = "An error occurred with reloading a module on the server"
-    TIMEOUT          = "The command timed out"
+    CALLING_FUNCTION  = "ERROR 0x1: An error occurred when calling the function"
+    IN_FUNCTION       = "ERROR 0x2: An error occurred when executing the function"
+    SERVER_COMMAND    = "ERROR 0x3: An error occurred processing this server command"
+    SERVER_RELOAD     = "ERROR 0x4: An error occurred with reloading a module on the server"
+    TIMEOUT           = "ERROR 0x5: The command timed out"
+    CANT_REACH_SERVER = "ERROR 0x6: The client couldn't connect to the server"
+    NO_RESPONSE       = "ERROR 0x7: No response was generated, is the function on the server returning anything?"
 
 
 class UnrealTypes: