iqm-station-control-client 7.0.0__tar.gz → 8.0.0__tar.gz

{iqm_station_control_client-7.0.0 → iqm_station_control_client-8.0.0}/CHANGELOG.rst

@@ -2,6 +2,24 @@
 Changelog
 =========
 
+Version 8.0.0 (2025-06-12)
+==========================
+
+Breaking changes
+----------------
+
+- Rename `JobStatus` to `JobExecutorStatus` in order to reduce confusion with CoCos models.
+- Rename some `JobExecutorStatus` statuses to be more descriptive.
+
+Version 7.1.0 (2025-06-10)
+==========================
+
+Features
+--------
+
+- Update dependency on exa-common
+
+
 Version 7.0.0 (2025-06-02)
 ==========================
 

{iqm_station_control_client-7.0.0/src/iqm_station_control_client.egg-info → iqm_station_control_client-8.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-station-control-client
-Version: 7.0.0
+Version: 8.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-7.0.0 → iqm_station_control_client-8.0.0}/src/iqm/station_control/client/iqm_server/iqm_server_client.py

@@ -49,7 +49,7 @@ from iqm.station_control.client.station_control import StationControlClient
 from iqm.station_control.interface.models import (
     DutData,
     DutFieldData,
-    JobStatus,
+    JobExecutorStatus,
     Statuses,
     SweepData,
     SweepDefinition,
@@ -292,20 +292,20 @@ def payload_to_sweep(job_payload: bytes) -> SweepDefinition:
     return sweep
 
 
-def to_job_status(job_status: proto.JobStatus) -> JobStatus:
+def to_job_status(job_status: proto.JobStatus) -> JobExecutorStatus:
     match job_status:
         case proto.JobStatus.IN_QUEUE:
-            return JobStatus.PENDING_EXECUTION
+            return JobExecutorStatus.PENDING_EXECUTION
         case proto.JobStatus.EXECUTING:
-            return JobStatus.EXECUTION_START
+            return JobExecutorStatus.EXECUTION_STARTED
         case proto.JobStatus.FAILED:
-            return JobStatus.FAILED
+            return JobExecutorStatus.FAILED
         case proto.JobStatus.COMPLETED:
-            return JobStatus.READY
+            return JobExecutorStatus.READY
         case proto.JobStatus.INTERRUPTED:
-            return JobStatus.ABORTED
+            return JobExecutorStatus.ABORTED
         case proto.JobStatus.CANCELLED:
-            return JobStatus.ABORTED
+            return JobExecutorStatus.ABORTED
     raise ValueError(f"Unknown job status: '{job_status}'")
 
 

{iqm_station_control_client-7.0.0 → iqm_station_control_client-8.0.0}/src/iqm/station_control/client/serializers/sweep_serializers.py

@@ -28,7 +28,7 @@ from exa.common.sweep.database_serialization import decode_and_validate_sweeps,
 from iqm.station_control.client.serializers.datetime_serializers import deserialize_datetime, serialize_datetime
 from iqm.station_control.client.serializers.playlist_serializers import pack_playlist, unpack_playlist
 from iqm.station_control.interface.models import SweepData, SweepDefinition, SweepResults
-from iqm.station_control.interface.models.jobs import JobStatus
+from iqm.station_control.interface.models.jobs import JobExecutorStatus
 
 
 def serialize_sweep_definition(sweep_definition: SweepDefinition) -> SweepDefinitionProto:
@@ -91,7 +91,7 @@ def deserialize_sweep_data(data: dict) -> SweepData:
         modified_timestamp=deserialize_datetime(data["modified_timestamp"]),
         begin_timestamp=deserialize_datetime(data["begin_timestamp"]),
         end_timestamp=deserialize_datetime(data["end_timestamp"]),
-        job_status=JobStatus(data["job_status"]),
+        job_status=JobExecutorStatus(data["job_status"]),
     )
 
 

{iqm_station_control_client-7.0.0 → iqm_station_control_client-8.0.0}/src/iqm/station_control/client/station_control.py

@@ -34,10 +34,10 @@ import requests
 from exa.common.data.setting_node import SettingNode
 from exa.common.data.value import ObservationValue
 from exa.common.errors.server_errors import (
-    STATUS_CODE_TO_ERROR_MAPPING,
     InternalServerError,
     NotFoundError,
     StationControlError,
+    map_from_status_code_to_error,
 )
 from exa.common.qcm_data.qcm_data_client import QCMDataClient
 from iqm.station_control.client.list_models import (
@@ -88,7 +88,7 @@ from iqm.station_control.interface.models import (
     SweepDefinition,
     SweepResults,
 )
-from iqm.station_control.interface.models.jobs import JobData, JobStatus
+from iqm.station_control.interface.models.jobs import JobData, JobExecutorStatus
 from iqm.station_control.interface.pydantic_base import PydanticBase
 
 logger = logging.getLogger(__name__)
@@ -684,7 +684,7 @@ class StationControlClient:
         update_progress_callback = update_progress_callback or (lambda status: None)
         try:
             job_status = self._poll_job_status_until_execution_start(job_id, update_progress_callback)
-            if JobStatus(job_status) not in JobStatus.terminal_statuses():
+            if JobExecutorStatus(job_status) not in JobExecutorStatus.terminal_statuses():
                 self._poll_job_status_until_terminal(job_id, update_progress_callback)
         except KeyboardInterrupt as exc:
             logger.info("Caught %s, revoking job %s", exc, job_id)
@@ -694,12 +694,12 @@ class StationControlClient:
 
     def _poll_job_status_until_execution_start(
         self, job_id: str, update_progress_callback: Callable[[Statuses], None]
-    ) -> JobStatus:
+    ) -> JobExecutorStatus:
         # Keep polling job status as long as it's PENDING, and update progress with `update_progress_callback`.
         max_seen_position = 0
         while True:
             job = self._poll_job(job_id)
-            if job.job_status >= JobStatus.EXECUTION_START:
+            if job.job_status >= JobExecutorStatus.EXECUTION_STARTED:
                 if max_seen_position:
                     update_progress_callback([("Progress in queue", max_seen_position, max_seen_position)])
                 return job.job_status
@@ -721,14 +721,14 @@ class StationControlClient:
         while True:
             job = self._poll_job(job_id)
             update_progress_callback(job.job_result.parallel_sweep_progress)
-            if job.job_status in JobStatus.terminal_statuses():
+            if job.job_status in JobExecutorStatus.terminal_statuses():
                 return
             sleep(1)
 
     def _poll_job(self, job_id: str) -> JobData:
         response = self._send_request(requests.get, f"jobs/{job_id}")
         job = JobData.model_validate(response.json())
-        if job.job_status == JobStatus.FAILED:
+        if job.job_status == JobExecutorStatus.FAILED:
             raise InternalServerError(f"Job: {job.job_id}\n{job.job_error}")
         return job
 
@@ -820,7 +820,7 @@ class StationControlClient:
             except json.JSONDecodeError:
                 error_message = response.text
 
-            error_class = STATUS_CODE_TO_ERROR_MAPPING[response.status_code]
+            error_class = map_from_status_code_to_error(response.status_code)
             raise error_class(error_message)
         return response
 

{iqm_station_control_client-7.0.0 → iqm_station_control_client-8.0.0}/src/iqm/station_control/interface/models/__init__.py

@@ -15,7 +15,7 @@
 
 from iqm.station_control.interface.models.dut import DutData, DutFieldData
 from iqm.station_control.interface.models.jobs import (
-    JobStatus,
+    JobExecutorStatus,
 )
 from iqm.station_control.interface.models.observation import (
     ObservationData,

{iqm_station_control_client-7.0.0 → iqm_station_control_client-8.0.0}/src/iqm/station_control/interface/models/jobs.py

@@ -26,7 +26,7 @@ from iqm.station_control.interface.pydantic_base import PydanticBase
 class TimelineEntry(PydanticBase):
     """Status and timestamp pair as described in a job timeline."""
 
-    status: JobStatus
+    status: JobExecutorStatus
     timestamp: datetime
 
 
@@ -49,16 +49,16 @@ class JobData(PydanticBase):
     """Job response data model"""
 
     job_id: UUID
-    job_status: JobStatus
+    job_status: JobExecutorStatus
     job_result: JobResult
     job_error: JobError | None
     position: int | None
 
 
 @functools.total_ordering
-class JobStatus(Enum):
+class JobExecutorStatus(Enum):
     """Enumeration of different states a job can be in. The ordering of these statuses is important,
-    and execution logic relies on it. Thus if a new status is added, ensure that it is slotted
+    and execution logic relies on it. Thus, if a new status is added, ensure that it is slotted
     in at the appropriate place. See the __lt__ implementation for further details.
     """
 
@@ -66,24 +66,24 @@ class JobStatus(Enum):
     RECEIVED = "received"
 
     # Validating the job
-    VALIDATING = "validating"
-    ACCEPTED = "accepted"
-
-    PREPARING_CALIBRATION = "preparing_calibration"
+    VALIDATION_STARTED = "validation_started"
+    VALIDATION_ENDED = "validation_ended"
 
     # Running PulLA
-    PENDING_COMPILATION = "pending_compilation"
-    COMPILING = "compiling"
-    COMPILED = "compiled"
+    FETCH_CALIBRATION_STARTED = "fetch_calibration_started"
+    FETCH_CALIBRATION_ENDED = "fetch_calibration_ended"
+    COMPILATION_STARTED = "compilation_started"
+    COMPILATION_ENDED = "compilation_ended"
 
     # Executing sweep
-    STORING_SWEEP_METADATA = "storing_sweep_metadata"
-    METADATA_STORED = "metadata_stored"
+    SAVE_SWEEP_METADATA_STARTED = "save_sweep_metadata_started"
+    SAVE_SWEEP_METADATA_ENDED = "save_sweep_metadata_ended"
     PENDING_EXECUTION = "pending_execution"
-    EXECUTION_START = "execution_start"
-    EXECUTION_END = "execution_end"
-    PENDING_POST_PROCESSING = "pending_post_processing"
-    POST_PROCESSING = "post_processing"
+    EXECUTION_STARTED = "execution_started"
+    EXECUTION_ENDED = "execution_ended"
+    POST_PROCESSING_PENDING = "post_processing_pending"
+    POST_PROCESSING_STARTED = "post_processing_started"
+    POST_PROCESSING_ENDED = "post_processing_ended"
     READY = "ready"
 
     # Job failed, can happen at any stage
@@ -101,10 +101,10 @@ class JobStatus(Enum):
     def __eq__(self, other):
         if isinstance(other, str):
             try:
-                other = JobStatus(other.lower())
+                other = JobExecutorStatus(other.lower())
             except ValueError:
                 return False
-        elif not isinstance(other, JobStatus):
+        elif not isinstance(other, JobExecutorStatus):
             return NotImplemented
         return self.name == other.name
 
@@ -112,21 +112,21 @@ class JobStatus(Enum):
         """Enable comparison according to definition order.
 
         Examples:
-            >>> JobStatus.ACCEPTED < JobStatus.COMPILED
+            >>> JobExecutorStatus.VALIDATION_ENDED < JobExecutorStatus.COMPILATION_ENDED
             True
 
         """
         if isinstance(other, str):
             try:
-                other = JobStatus(other.lower())
+                other = JobExecutorStatus(other.lower())
             except ValueError:
                 return NotImplemented
-        elif not isinstance(other, JobStatus):
+        elif not isinstance(other, JobExecutorStatus):
             return NotImplemented
-        members = list(JobStatus.__members__.values())
+        members = list(JobExecutorStatus.__members__.values())
         return members.index(self) < members.index(other)
 
     @classmethod
-    def terminal_statuses(cls) -> set[JobStatus]:
+    def terminal_statuses(cls) -> set[JobExecutorStatus]:
         """Statuses from which the execution can't continue."""
         return {cls.ABORTED, cls.FAILED, cls.READY}

{iqm_station_control_client-7.0.0 → iqm_station_control_client-8.0.0}/src/iqm/station_control/interface/models/monitor.py

@@ -18,7 +18,7 @@ from __future__ import annotations
 from datetime import datetime
 from uuid import UUID
 
-from iqm.station_control.interface.models import JobStatus
+from iqm.station_control.interface.models import JobExecutorStatus
 from iqm.station_control.interface.pydantic_base import PydanticBase
 
 
@@ -26,7 +26,7 @@ class JobStateTimestamp(PydanticBase):
     """Represents a single timestamped state for a job."""
 
     job_id: UUID
-    status: JobStatus
+    status: JobExecutorStatus
     timestamp: datetime
 
 
@@ -40,6 +40,6 @@ class JobsInQueue(PydanticBase):
 class QueueState(PydanticBase):
     """Describes the state of a single job queue."""
 
-    queue: JobStatus
+    queue: JobExecutorStatus
     jobs_in_queue: int
     completed_jobs: int

{iqm_station_control_client-7.0.0 → iqm_station_control_client-8.0.0}/src/iqm/station_control/interface/models/sweep.py

@@ -21,7 +21,7 @@ from iqm.models.playlist import Playlist
 
 from exa.common.data.setting_node import SettingNode
 from exa.common.sweep.util import NdSweep
-from iqm.station_control.interface.models.jobs import JobStatus
+from iqm.station_control.interface.models.jobs import JobExecutorStatus
 
 
 @dataclass(kw_only=True)
@@ -62,5 +62,5 @@ class SweepData(SweepBase):
     """Time when the sweep began in the station control."""
     end_timestamp: datetime | None
     """Time when the sweep ended in the station control."""
-    job_status: JobStatus
+    job_status: JobExecutorStatus
     """Status of sweep execution."""

{iqm_station_control_client-7.0.0 → iqm_station_control_client-8.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: 7.0.0
+Version: 8.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-8.0.0/version.txt

@@ -0,0 +1 @@
+8.0.0

iqm_station_control_client-7.0.0/version.txt

@@ -1 +0,0 @@
-7.0.0