implement error message in job

client/qiskit_serverless/core/job.py

@@ -50,6 +50,7 @@
     GATEWAY_PROVIDER_VERSION_DEFAULT,
 )
 
+from qiskit_serverless.exception import QiskitServerlessException
 from qiskit_serverless.serializers.program_serializers import (
     QiskitObjectsEncoder,
     QiskitObjectsDecoder,
@@ -125,6 +126,10 @@ def filtered_logs(self, **kwargs) -> str:
         """
         return self._client.filtered_logs(job_id=self.job_id, **kwargs)
 
+    def error_message(self):
+        """Returns the execution error message."""
+        return self._client.result(self.job_id) if self.status() == "ERROR" else ""
+
     def result(self, wait=True, cadence=5, verbose=False, maxwait=0):
         """Return results of the job.
         Args:
@@ -145,6 +150,11 @@ def result(self, wait=True, cadence=5, verbose=False, maxwait=0):
                 if verbose:
                     logging.info(count)
 
+        if self.status() == "ERROR":
+            raise QiskitServerlessException(
+                "Job finished with an error. Use error_message() to get additional information."
+            )
+
         # Retrieve the results. If they're string format, try to decode to a dictionary.
         results = self._client.result(self.job_id)
         if isinstance(results, str):

tests/basic/02_arguments_and_results.py

@@ -31,6 +31,10 @@
 job = my_pattern_function.run(circuit=circuit)
 print(job)
 
-print(job.result())
+try:
+  print(job.result())
+except:
+  print(job.error_message())
+
 print(job.status())
 print(job.logs())

tests/basic/04_distributed_workloads.py

@@ -33,6 +33,10 @@
 job = my_pattern_function.run(circuits=circuits)
 print(job)
 
-print(job.result())
+try:
+  print(job.result())
+except:
+  print(job.error_message())
+
 print(job.status())
 print(job.logs())

tests/experimental/running_programs_using_decorators.py

@@ -31,7 +31,11 @@ def hello_qiskit():
 
 job = hello_qiskit()
 print(job)
-print(job.result())
+try:
+  print(job.result())
+except:
+  print(job.error_message())
+
 print(job.status())
 print(job.logs())
 
@@ -57,7 +61,11 @@ def function_with_distributed_tasks(circuits):
 
 job = function_with_distributed_tasks(circuits=circuits)
 print(job)
-print(job.result())
+try:
+  print(job.result())
+except:
+  print(job.error_message())
+
 print(job.status())
 print(job.logs())
 
@@ -70,6 +78,10 @@ def my_function_with_modules():
 
 job = my_function_with_modules()
 print(job)
-print(job.result())
+try:
+  print(job.result())
+except:
+  print(job.error_message())
+
 print(job.status())
 print(job.logs())