Add support for new AQ workspace v2 statuses

Author: xinyi-joffre

azure-quantum/azure/quantum/_client/models/_enums.py

@@ -33,8 +33,18 @@ class JobStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta):
 
     WAITING = "Waiting"
     """The job is waiting in the queue to be executed."""
+    QUEUED = "Queued"
+    """The job is queued for execution."""
     EXECUTING = "Executing"
     """The job is being executed."""
+    FINISHING = "Finishing"
+    """The job is in the process of finishing."""
+    CANCELLATION_REQUESTED = "CancellationRequested"
+    """Cancellation for the job has been requested."""
+    CANCELLING = "Cancelling"
+    """The job is in the process of being cancelled."""
+    COMPLETED = "Completed"
+    """The job has completed execution."""
     SUCCEEDED = "Succeeded"
     """The job completed with success."""
     FAILED = "Failed"

azure-quantum/azure/quantum/_client/models/_models.py

@@ -252,8 +252,8 @@ class JobDetails(ItemDetails, discriminator="Job"):
     :vartype input_data_uri: str
     :ivar input_data_format: The format of the input data.
     :vartype input_data_format: str
-    :ivar status: The status of the job. Known values are: "Waiting", "Executing", "Succeeded",
-     "Failed", and "Cancelled".
+    :ivar status: The status of the job. Known values are: "Waiting", "Queued", "Executing", "Finishing", "Completed",
+     "Succeeded", "Failed", "Cancelling", "CancellationRequested" and "Cancelled".
     :vartype status: str or ~azure.quantum.models.JobStatus
     :ivar metadata: The job metadata. Metadata provides client the ability to store client-specific
      information.
@@ -289,8 +289,8 @@ class JobDetails(ItemDetails, discriminator="Job"):
     input_data_format: Optional[str] = rest_field(name="inputDataFormat", visibility=["read", "create"])
     """The format of the input data."""
     status: Optional[Union[str, "_models.JobStatus"]] = rest_field(visibility=["read"])
-    """The status of the job. Known values are: \"Waiting\", \"Executing\", \"Succeeded\", \"Failed\",
-     and \"Cancelled\"."""
+    """The status of the job. Known values are: \"Waiting\", \"Queued\", \"Executing\", \"Finishing\", \"Completed\",
+     \"Succeeded\", \"Failed\", \"Cancelling\", \"CancellationRequested\" and \"Cancelled\"."""
     metadata: Optional[Any] = rest_field(visibility=["read", "create", "update"])
     """The job metadata. Metadata provides client the ability to store client-specific information."""
     cancellation_time: Optional[datetime.datetime] = rest_field(

azure-quantum/azure/quantum/cirq/targets/ionq.py

@@ -30,10 +30,15 @@ def __init__(self, workspace: "Workspace"):
     def _to_ionq_status(status: str):
         from azure.quantum._client.models._enums import JobStatus
         _STATUS_DICT = {
+            JobStatus.COMPLETED: 'completed',
             JobStatus.SUCCEEDED: 'completed',
             JobStatus.CANCELLED: 'canceled',
             JobStatus.FAILED: 'failed',
             JobStatus.EXECUTING: 'running',
+            JobStatus.FINISHING: 'running',
+            JobStatus.CANCELLATION_REQUESTED: 'running',
+            JobStatus.CANCELLING: 'running',
+            JobStatus.QUEUED: 'ready',
             JobStatus.WAITING: 'ready'
         }
         return _STATUS_DICT.get(status, 'submitted')

azure-quantum/azure/quantum/job/job.py

@@ -59,7 +59,8 @@ def refresh(self):
     def has_completed(self) -> bool:
         """Check if the job has completed."""
         return (
-            self.details.status == "Succeeded"
+            self.details.status == "Completed"
+            or self.details.status == "Succeeded"
             or self.details.status == "Failed"
             or self.details.status == "Cancelled"
         )
@@ -124,7 +125,7 @@ def get_results(self, timeout_secs: float = DEFAULT_TIMEOUT):
         if not self.has_completed():
             self.wait_until_completed(timeout_secs=timeout_secs)
 
-        if not self.details.status == "Succeeded":
+        if not self.details.status == "Succeeded" or self.details.status == "Completed":
             if self.details.status == "Failed" and self._allow_failure_results():
                 job_blob_properties = self.download_blob_properties(self.details.output_data_uri)
                 if job_blob_properties.size > 0:
@@ -204,7 +205,7 @@ def get_results_histogram(self, timeout_secs: float = DEFAULT_TIMEOUT):
         if not self.has_completed():
             self.wait_until_completed(timeout_secs=timeout_secs)
 
-        if not self.details.status == "Succeeded":
+        if not self.details.status == "Succeeded" or self.details.status == "Completed":
             if self.details.status == "Failed" and self._allow_failure_results():
                 job_blob_properties = self.download_blob_properties(self.details.output_data_uri)
                 if job_blob_properties.size > 0:
@@ -287,7 +288,7 @@ def get_results_shots(self, timeout_secs: float = DEFAULT_TIMEOUT):
         if not self.has_completed():
             self.wait_until_completed(timeout_secs=timeout_secs)
 
-        if not self.details.status == "Succeeded":
+        if not self.details.status == "Succeeded" or self.details.status == "Completed":
             if self.details.status == "Failed" and self._allow_failure_results():
                 job_blob_properties = self.download_blob_properties(self.details.output_data_uri)
                 if job_blob_properties.size > 0:

azure-quantum/azure/quantum/qiskit/job.py

@@ -24,12 +24,16 @@
 logger = logging.getLogger(__name__)
 
 AzureJobStatusMap = {
+    "Completed": JobStatus.DONE,
     "Succeeded": JobStatus.DONE,
+    "Queued": JobStatus.QUEUED,
     "Waiting": JobStatus.QUEUED,
     "Executing": JobStatus.RUNNING,
+    "Finishing": JobStatus.RUNNING,
+    "CancellationRequested": JobStatus.RUNNING,
+    "Cancelling": JobStatus.RUNNING,
     "Failed": JobStatus.ERROR,
-    "Cancelled": JobStatus.CANCELLED,
-    "Finishing": JobStatus.RUNNING
+    "Cancelled": JobStatus.CANCELLED
 }
 
 # Constants for output data format:
@@ -81,7 +85,7 @@ def result(self, timeout=None, sampler_seed=None):
         """Return the results of the job."""
         self._azure_job.wait_until_completed(timeout_secs=timeout)
 
-        success = self._azure_job.details.status == "Succeeded"
+        success = self._azure_job.details.status == "Succeeded" or self._azure_job.details.status == "Completed"
         results = self._format_results(sampler_seed=sampler_seed)
 
         result_dict = {
@@ -128,7 +132,7 @@ def _format_results(self, sampler_seed=None) -> Union[List[Dict[str, Any]], Dict
         if (self._azure_job.details.output_data_format == MICROSOFT_OUTPUT_DATA_FORMAT_V2):
             return self._format_microsoft_v2_results()
 
-        success = self._azure_job.details.status == "Succeeded"
+        success = self._azure_job.details.status == "Succeeded" or self._azure_job.details.status == "Completed"
 
         job_result = {
             "data": {},
@@ -332,7 +336,7 @@ def tryParseJSON(header):
 
 
     def _format_microsoft_v2_results(self) -> List[Dict[str, Any]]:
-        success = self._azure_job.details.status == "Succeeded"
+        success = self._azure_job.details.status == "Succeeded" or self._azure_job.details.status == "Completed"
 
         if not success:
             return [{

azure-quantum/azure/quantum/target/pasqal/result.py

@@ -38,7 +38,7 @@ def __init__(self, job: Job) -> None:
             RuntimeError: if the job has not completed successfully
         """
 
-        if job.details.status != "Succeeded":
+        if job.details.status != "Succeeded" and job.details.status != "Completed":
             raise RuntimeError(
                 "Cannot retrieve results as job execution failed "
                 f"(status: {job.details.status}."

azure-quantum/azure/quantum/target/rigetti/result.py

@@ -43,7 +43,7 @@ def __init__(self, job: Job) -> None:
             RuntimeError: if the job has not completed successfully
         """
 
-        if job.details.status != "Succeeded":
+        if job.details.status != "Succeeded" and job.details.status != "Completed":
             raise RuntimeError(
                 "Cannot retrieve results as job execution failed "
                 f"(status: {job.details.status}."