iqm-station-control-client 4.2.0__tar.gz → 6.0.0__tar.gz

{iqm_station_control_client-4.2.0 → iqm_station_control_client-6.0.0}/CHANGELOG.rst

@@ -2,6 +2,23 @@
 Changelog
 =========
 
+Version 6.0.0 (2025-05-30)
+==========================
+
+Features
+--------
+
+- Rename JobStatus entries to be more descriptive. :issue:`SW-1513`
+
+Version 5.0.0 (2025-05-28)
+==========================
+
+Breaking changes
+----------------
+
+- :attr:`.JobData.job_error` now has separate fields for user error message and full error log, instead of only
+  containing the full error log. :issue:`SW-1179`
+
 Version 4.2.0 (2025-05-23)
 ==========================
 

{iqm_station_control_client-4.2.0/src/iqm_station_control_client.egg-info → iqm_station_control_client-6.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-station-control-client
-Version: 4.2.0
+Version: 6.0.0
 Summary: Python client for communicating with Station Control Service
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License

{iqm_station_control_client-4.2.0 → iqm_station_control_client-6.0.0}/src/iqm/station_control/client/iqm_server/iqm_server_client.py

@@ -55,7 +55,7 @@ from iqm.station_control.interface.models import (
     SweepDefinition,
     SweepResults,
 )
-from iqm.station_control.interface.models.jobs import JobData, JobResult
+from iqm.station_control.interface.models.jobs import JobData, JobError, JobResult
 from iqm.station_control.interface.models.sweep import SweepBase
 
 logger = logging.getLogger(__name__)
@@ -169,7 +169,9 @@ class IqmServerClient(StationControlClient, metaclass=IqmServerClientMeta):
                     parallel_sweep_progress=[],
                     interrupted=False,
                 ),
-                job_error=job.error if job.HasField("error") else "",
+                job_error=JobError(full_error_log=job.error, user_error_message=job.error)
+                if job.HasField("error")
+                else None,
                 position=job.queue_position if job.HasField("queue_position") else None,
             )
 
@@ -293,9 +295,9 @@ def payload_to_sweep(job_payload: bytes) -> SweepDefinition:
 def to_job_status(job_status: proto.JobStatus) -> JobStatus:
     match job_status:
         case proto.JobStatus.IN_QUEUE:
-            return JobStatus.PENDING_EXECUTION
+            return JobStatus.EXECUTION_PENDING
         case proto.JobStatus.EXECUTING:
-            return JobStatus.EXECUTION_START
+            return JobStatus.EXECUTION_STARTED
         case proto.JobStatus.FAILED:
             return JobStatus.FAILED
         case proto.JobStatus.COMPLETED:

{iqm_station_control_client-4.2.0 → iqm_station_control_client-6.0.0}/src/iqm/station_control/client/station_control.py

@@ -699,7 +699,7 @@ class StationControlClient:
         max_seen_position = 0
         while True:
             job = self._poll_job(job_id)
-            if job.job_status >= JobStatus.EXECUTION_START:
+            if job.job_status >= JobStatus.EXECUTION_STARTED:
                 if max_seen_position:
                     update_progress_callback([("Progress in queue", max_seen_position, max_seen_position)])
                 return job.job_status

{iqm_station_control_client-4.2.0 → iqm_station_control_client-6.0.0}/src/iqm/station_control/interface/models/jobs.py

@@ -38,13 +38,20 @@ class JobResult(PydanticBase):
     interrupted: bool
 
 
+class JobError(PydanticBase):
+    """Error log for a job."""
+
+    full_error_log: str
+    user_error_message: str
+
+
 class JobData(PydanticBase):
     """Job response data model"""
 
     job_id: UUID
     job_status: JobStatus
     job_result: JobResult
-    job_error: str | None
+    job_error: JobError | None
     position: int | None
 
 
@@ -59,24 +66,29 @@ class JobStatus(Enum):
     RECEIVED = "received"
 
     # Validating the job
-    VALIDATING = "validating"
-    ACCEPTED = "accepted"
 
-    PREPARING_CALIBRATION = "preparing_calibration"
+    VALIDATION_STARTED = "validation_started"
+    VALIDATION_ENDED = "validation_ended"
+
+    FETCH_CALIBRATION_STARTED = "fetch_calibration_started"
+    FETCH_CALIBRATION_ENDED = "fetch_calibration_ended"
 
     # Running PulLA
-    PENDING_COMPILATION = "pending_compilation"
-    COMPILING = "compiling"
-    COMPILED = "compiled"
+    COMPILATION_STARTED = "compilation_started"
+    COMPILATION_ENDED = "compilation_ended"
 
     # Executing sweep
-    STORING_SWEEP_METADATA = "storing_sweep_metadata"
-    METADATA_STORED = "metadata_stored"
-    PENDING_EXECUTION = "pending_execution"
-    EXECUTION_START = "execution_start"
-    EXECUTION_END = "execution_end"
-    PENDING_POST_PROCESSING = "pending_post_processing"
-    POST_PROCESSING = "post_processing"
+    SAVE_SWEEP_METADATA_STARTED = "save_sweep_metadata_started"
+    SAVE_SWEEP_METADATA_ENDED = "save_sweep_metadata_ended"
+    EXECUTION_PENDING = "execution_pending"
+    EXECUTION_STARTED = "execution_started"
+    EXECUTION_ENDED = "execution_ended"
+    EXECUTION_STAGE_COMPLETED = "execution_completed"
+
+    # Extracting artifacts from results
+    POST_PROCESSING_STARTED = "post_processing_started"
+    POST_PROCESSING_ENDED = "post_processing_ended"
+
     READY = "ready"
 
     # Job failed, can happen at any stage
@@ -105,7 +117,7 @@ class JobStatus(Enum):
         """Enable comparison according to definition order.
 
         Examples:
-            >>> JobStatus.ACCEPTED < JobStatus.COMPILED
+            >>> JobStatus.VALIDATION_STARTED < JobStatus.COMPILATION_ENDED
             True
 
         """

{iqm_station_control_client-4.2.0 → iqm_station_control_client-6.0.0/src/iqm_station_control_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-station-control-client
-Version: 4.2.0
+Version: 6.0.0
 Summary: Python client for communicating with Station Control Service
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License

iqm_station_control_client-6.0.0/version.txt

@@ -0,0 +1 @@
+6.0.0

iqm_station_control_client-4.2.0/version.txt

@@ -1 +0,0 @@
-4.2.0