[py] better error handling when pipeline isn't found

abhizer · abhizer · commit bcc8b93b385d · 2024-10-02T17:11:15.000Z
Fixes: #1802 Signed-off-by: Abhinav Gyawali <22275402+abhizer@users.noreply.github.com>
diff --git a/python/feldera/__init__.py b/python/feldera/__init__.py
@@ -7,3 +7,5 @@
 pretty_errors.configure(
     line_number_first=True,
 )
+
+pretty_errors.activate()
diff --git a/python/feldera/rest/errors.py b/python/feldera/rest/errors.py
@@ -25,31 +25,34 @@ def __init__(self, error: str, request: Response) -> None:
         self.message = None
         self.details = None
 
+        err_msg = ""
+
         if request.text:
             try:
                 json_data = json.loads(request.text)
+
+                self.error_code = json_data.get("error_code")
+                if self.error_code:
+                    err_msg += f"\nError Code: {self.error_code}"
                 self.message = json_data.get("message")
+                if self.message:
+                    err_msg += f"\nMessage: {self.message}"
                 self.details = json_data.get("details")
-                self.error_code = json_data.get("error_code")
             except:
                 self.message = request.text
 
-    def __str__(self) -> str:
-        if self.error_code:
-            return f"FelderaAPIError: {self.error}\n Error code: {self.error_code}\n Error message: {self.message}\n Details: {self.details}"
-        else:
-            return f"FelderaAPIError: {self.error}\n {self.message}"
+        super().__init__(err_msg)
 
 
 class FelderaTimeoutError(FelderaError):
     """Error when Feldera operation takes longer than expected"""
 
-    def __str__(self) -> str:
-        return f"FelderaTimeoutError: {self.message}"
+    def __init__(self, err: str) -> None:
+        super().__init__(f"Timeout connecting to Feldera: {err}")
 
 
 class FelderaCommunicationError(FelderaError):
     """Error when connection to Feldera"""
 
-    def __str__(self) -> str:
-        return f"FelderaCommunicationError: {self.message}"
+    def __init__(self, err: str) -> None:
+        super().__init__(f"Cannot connect to Feldera API: {err}")
diff --git a/python/feldera/rest/feldera_client.py b/python/feldera/rest/feldera_client.py
@@ -220,7 +220,6 @@ def pause_pipeline(self, pipeline_name: str):
             if status == "Paused":
                 break
             elif status == "Failed":
-                # TODO: return a more detailed error message
                 raise RuntimeError(f"Failed to pause pipeline")
 
             logging.debug("still pausing %s, waiting for 100 more milliseconds", pipeline_name)
@@ -230,7 +229,7 @@ def shutdown_pipeline(self, pipeline_name: str):
         """
         Shutdown a pipeline
 
-        :param pipeline_name: The name of the pipeline to shutdown
+        :param pipeline_name: The name of the pipeline to shut down
         """
 
         self.http.post(
diff --git a/python/tests/test_pipeline_builder.py b/python/tests/test_pipeline_builder.py
@@ -284,7 +284,6 @@ def test_sql_error(self):
     def test_kafka(self):
         import json
 
-
         in_ci = os.environ.get("IN_CI")
 
         if in_ci == "1":

Original file line number	Diff line number	Diff line change
`@@ -7,3 +7,5 @@`
`7`	`7`	`pretty_errors.configure(`
`8`	`8`	`line_number_first=True,`
`9`	`9`	`)`
	`10`	`+`
	`11`	`+pretty_errors.activate()`