iqm-station-control-client 11.1.0__tar.gz → 11.3.1__tar.gz

{iqm_station_control_client-11.1.0 → iqm_station_control_client-11.3.1}/CHANGELOG.rst

@@ -2,6 +2,31 @@
 Changelog
 =========
 
+Version 11.3.1 (2025-10-27)
+===========================
+
+- Bump version for 4.3.1 release. No functional changes.
+
+Version 11.3.0 (2025-10-23)
+===========================
+
+Bug fixes
+---------
+
+- Fix issue with meth:`.IqmServerClient.get_job` which failed to convert the server status (int) correctly
+  to :class:`.JobExecutorStatus`.
+
+
+Version 11.2.0 (2025-10-06)
+===========================
+
+Features
+--------
+
+- Deprecate "application/octet-stream" for protobuf data, use "application/protobuf" instead.
+- Deprecate "detail" in server errors, use "message" instead to be consistent with IQM Server.
+- Update dependencies.
+
 Version 11.1.0 (2025-10-03)
 ===========================
 

{iqm_station_control_client-11.1.0/src/iqm_station_control_client.egg-info → iqm_station_control_client-11.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-station-control-client
-Version: 11.1.0
+Version: 11.3.1
 Summary: Python client for communicating with Station Control Service
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License
@@ -214,7 +214,7 @@ Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Requires-Dist: iqm-exa-common<28,>=27
-Requires-Dist: iqm-data-definitions<3.0,>=2.13
+Requires-Dist: iqm-data-definitions<3.0,>=2.18
 Requires-Dist: opentelemetry-exporter-otlp<2.0,>=1.25.0
 Requires-Dist: protobuf<5.0,>=4.25.3
 Requires-Dist: types-protobuf

{iqm_station_control_client-11.1.0 → iqm_station_control_client-11.3.1}/requirements/base.in

@@ -1,4 +1,4 @@
-iqm-data-definitions >= 2.13, < 3.0
+iqm-data-definitions >= 2.18, < 3.0
 opentelemetry-exporter-otlp >= 1.25.0, < 2.0
 protobuf >= 4.25.3, < 5.0
 types-protobuf

{iqm_station_control_client-11.1.0 → iqm_station_control_client-11.3.1}/requirements/base.txt

@@ -1,5 +1,5 @@
 iqm-exa-common>=27,<28
-iqm-data-definitions >= 2.13, < 3.0
+iqm-data-definitions >= 2.18, < 3.0
 opentelemetry-exporter-otlp >= 1.25.0, < 2.0
 protobuf >= 4.25.3, < 5.0
 types-protobuf

{iqm_station_control_client-11.1.0 → iqm_station_control_client-11.3.1}/src/iqm/station_control/client/iqm_server/iqm_server_client.py

@@ -174,7 +174,7 @@ class IqmServerClient(_StationControlClientBase):
                 modified_timestamp=to_datetime(job.updated_at),
                 begin_timestamp=to_datetime(job.execution_started_at) if job.HasField("execution_started_at") else None,
                 end_timestamp=to_datetime(job.execution_ended_at) if job.HasField("execution_ended_at") else None,
-                job_status=to_job_status(job.status),
+                job_status=to_job_executor_status(job.status),
                 # Sweep definition is a subclass of SweepBase so we can just copy all SweepBase fields
                 # from the input sweep to the sweep data
                 **{f.name: getattr(sweep, f.name) for f in dataclasses.fields(SweepBase)},
@@ -298,7 +298,7 @@ class IqmServerClient(_StationControlClientBase):
             job: proto.JobV1 = jobs.GetJobV1(proto.JobLookupV1(id=to_proto_uuid(job_id)))
             return JobData(
                 job_id=from_proto_uuid(job.id),
-                job_status=job.status,  # type: ignore[arg-type]
+                job_status=to_job_executor_status(job.status),
                 job_result=JobResult(
                     job_id=from_proto_uuid(job.id),
                     parallel_sweep_progress=[],
@@ -458,7 +458,7 @@ def payload_to_sweep(job_payload: bytes) -> SweepDefinition:
     return sweep
 
 
-def to_job_status(job_status: proto.JobStatus) -> JobExecutorStatus:
+def to_job_executor_status(job_status: proto.JobStatus) -> JobExecutorStatus:
     match job_status:
         case proto.JobStatus.IN_QUEUE:
             return JobExecutorStatus.PENDING_EXECUTION
@@ -475,19 +475,6 @@ def to_job_status(job_status: proto.JobStatus) -> JobExecutorStatus:
     raise ValueError(f"Unknown job status: '{job_status}'")
 
 
-def to_string_job_status(job_status: proto.JobStatus) -> str:
-    match job_status:
-        case proto.JobStatus.IN_QUEUE:
-            return "PENDING"
-        case proto.JobStatus.EXECUTING:
-            return "STARTED"
-        case proto.JobStatus.FAILED | proto.JobStatus.INTERRUPTED | proto.JobStatus.CANCELLED:
-            return "FAILURE"
-        case proto.JobStatus.COMPLETED:
-            return "SUCCESS"
-    raise ValueError(f"Unknown job status: '{job_status}'")
-
-
 def parse_json(data: bytes) -> Any:
     return json.load(BytesIO(data))
 

{iqm_station_control_client-11.1.0 → iqm_station_control_client-11.3.1}/src/iqm/station_control/client/list_models.py

@@ -31,14 +31,20 @@ from iqm.station_control.interface.models import (
     ObservationUpdate,
     RunLite,
     SequenceMetadataData,
+    StaticQuantumArchitecture,
 )
 from iqm.station_control.interface.pydantic_base import PydanticBase
 
 T = TypeVar("T")
 
 
-class ResponseWithMeta(PydanticBase, Generic[T]):
-    """Class used for query endpoints to return metadata in addition to the returned items."""
+class ListWithMetaResponse(PydanticBase, Generic[T]):
+    """Class used for list endpoints to envelope the items to a dict with additional metadata.
+
+    This should be used only in REST API communication (JSON). For Python users,
+    this model should be deserialized to :class:`iqm.pulse.ListWithMeta`:,
+    which behaves like a standard list.
+    """
 
     items: list[T]
     meta: Meta | None = None
@@ -96,5 +102,9 @@ class SequenceMetadataDataList(ListModel):
     root: list[SequenceMetadataData]
 
 
+class StaticQuantumArchitectureList(ListModel):
+    root: list[StaticQuantumArchitecture]
+
+
 class RunLiteList(ListModel):
     root: list[RunLite]

{iqm_station_control_client-11.1.0 → iqm_station_control_client-11.3.1}/src/iqm/station_control/client/station_control.py

@@ -44,12 +44,12 @@ from iqm.station_control.client.list_models import (
     DutFieldDataList,
     DutList,
     ListModel,
+    ListWithMetaResponse,
     ObservationDataList,
     ObservationDefinitionList,
     ObservationLiteList,
     ObservationSetDataList,
     ObservationUpdateList,
-    ResponseWithMeta,
     RunLiteList,
     SequenceMetadataDataList,
 )
@@ -181,7 +181,7 @@ class _StationControlClientBase(StationControlInterface):
         if not response.ok:
             try:
                 response_json = response.json()
-                error_message = response_json.get("message") or response_json["detail"]
+                error_message = response_json.get("message")
             except (json.JSONDecodeError, KeyError):
                 error_message = response.text
 
@@ -215,7 +215,7 @@ class _StationControlClientBase(StationControlInterface):
             headers["Content-Type"] = "application/json; charset=UTF-8"
         elif octets is not None:
             data = octets
-            headers["Content-Type"] = "application/octet-stream"
+            headers["Content-Type"] = "application/protobuf"
 
         if self._enable_opentelemetry:
             parent_span_context = trace.set_span_in_context(trace.get_current_span())
@@ -310,7 +310,7 @@ class StationControlClient(_StationControlClientBase):
 
     @cache
     def get_channel_properties(self) -> dict[str, ChannelProperties]:
-        headers = {"accept": "application/octet-stream"}
+        headers = {"accept": "application/protobuf"}
         response = self._send_request(requests.get, "channel-properties", headers=headers)
         decoded_dict = unpack_channel_properties(response.content)
         return decoded_dict
@@ -620,11 +620,11 @@ class StationControlClient(_StationControlClientBase):
         # This validates the provided data as a JSON string or bytes object.
         # If your incoming data is a JSON payload, this is generally considered faster.
         if list_with_meta:
-            response_with_meta: ResponseWithMeta = ResponseWithMeta.model_validate_json(response.text)
-            meta = response_with_meta.meta or Meta()
+            list_with_meta_response: ListWithMetaResponse = ListWithMetaResponse.model_validate_json(response.text)
+            meta = list_with_meta_response.meta or Meta()
             if meta and meta.errors:
                 logger.warning("Errors in station control response:\n  - %s", "\n  - ".join(meta.errors))
-            return ListWithMeta(model_class.model_validate(response_with_meta.items), meta=meta)
+            return ListWithMeta(model_class.model_validate(list_with_meta_response.items), meta=meta)
         model = model_class.model_validate_json(response.text)
         if isinstance(model, ListModel):
             return model.root

{iqm_station_control_client-11.1.0 → iqm_station_control_client-11.3.1}/src/iqm/station_control/interface/list_with_meta.py

@@ -15,6 +15,7 @@
 
 from collections.abc import Iterable
 from dataclasses import dataclass
+from typing import Generic, TypeVar
 
 
 @dataclass(kw_only=True)
@@ -28,9 +29,14 @@ class Meta:
     errors: list[str] | None = None
 
 
-class ListWithMeta(list):
+T = TypeVar("T")
+
+
+class ListWithMeta(list, Generic[T]):
     """Standard list extension holding optional metadata as well."""
 
-    def __init__(self, items: Iterable, *, meta: Meta):
+    meta: Meta | None
+
+    def __init__(self, items: Iterable[T], *, meta: Meta | None = None):
         super().__init__(items)
         self.meta = meta

{iqm_station_control_client-11.1.0 → iqm_station_control_client-11.3.1}/src/iqm/station_control/interface/models/dut.py

@@ -17,16 +17,6 @@ from iqm.station_control.interface.models.type_aliases import DutType
 from iqm.station_control.interface.pydantic_base import PydanticBase
 
 
-class DutData(PydanticBase):
-    """Represents a Device Under Test, or DUT, for short."""
-
-    label: str
-    """DUT label of the device."""
-    dut_type: DutType
-    """String indicating the DUT type of the device
-    Can be either 'chip' or 'twpa'."""
-
-
 class DutFieldData(PydanticBase):
     """A DUT field or path and its unit."""
 
@@ -34,3 +24,12 @@ class DutFieldData(PydanticBase):
     """DUT field or path."""
     unit: str
     """SI unit of the value. Empty string means the value is dimensionless."""
+
+
+class DutData(PydanticBase):
+    """Represents a Device Under Test, or DUT, for short."""
+
+    label: str
+    """DUT label of the device."""
+    dut_type: DutType
+    """Type of the device."""

{iqm_station_control_client-11.1.0 → iqm_station_control_client-11.3.1}/src/iqm/station_control/interface/models/jobs.py

@@ -89,7 +89,7 @@ class JobExecutorStatus(Enum):
     COMPILATION_STARTED = "compilation_started"
     """The job is being compiled."""
     COMPILATION_ENDED = "compilation_ended"
-    """The job has been succesfully compiled."""
+    """The job has been successfully compiled."""
 
     # Executing sweep
     SAVE_SWEEP_METADATA_STARTED = "save_sweep_metadata_started"

{iqm_station_control_client-11.1.0 → iqm_station_control_client-11.3.1}/src/iqm/station_control/interface/models/static_quantum_architecture.py

@@ -13,7 +13,10 @@
 # limitations under the License.
 """Static quantum architecture (SQA) related interface models."""
 
-from pydantic import Field
+from typing import Any
+import warnings
+
+from pydantic import Field, model_validator
 
 from iqm.station_control.interface.pydantic_base import PydanticBase
 
@@ -24,6 +27,13 @@ class StaticQuantumArchitecture(PydanticBase):
     For example, the names of its components and the connections between them.
     """
 
+    # Optional *for now* since 2025-10-04 (backwards compatible)
+    dut_label: str | None = Field(
+        default=None,
+        json_schema_extra={"x-optional-deprecated": True},
+    )
+    """Identifies the QPU."""
+
     qubits: list[str] = Field(
         examples=[["QB1", "QB2"]],
     )
@@ -38,3 +48,14 @@ class StaticQuantumArchitecture(PydanticBase):
         examples=[[("QB1", "QB2"), ("QB1", "CR1")]],
     )
     """Components (qubits and computational resonators) connected by a coupler on the QPU, sorted."""
+
+    @model_validator(mode="before")
+    @classmethod
+    def _warn_missing_dut_label(cls, data: Any) -> Any:
+        if isinstance(data, dict) and "dut_label" not in data:
+            warnings.warn(
+                "Missing 'dut_label'. This field will become REQUIRED in a future release.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        return data

{iqm_station_control_client-11.1.0 → iqm_station_control_client-11.3.1}/src/iqm/station_control/interface/models/type_aliases.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 """Type hint aliases used in the station control interface."""
 
-from typing import Literal
+from typing import Literal, TypeAlias
 from uuid import UUID
 
 import numpy as np
@@ -23,8 +23,8 @@ import numpy as np
 # and then deserialized back to UUID on the server side.
 StrUUID = str | UUID
 
-DutType = Literal["chip", "twpa"]
-GetObservationsMode = Literal["all_latest", "tags_and", "tags_or", "sequence"]
-SoftwareVersionSet = dict[str, str]
-Statuses = list[tuple[str, int, int]]
-SweepResults = dict[str, list[np.ndarray]]
+DutType: TypeAlias = Literal["chip", "twpa"]
+GetObservationsMode: TypeAlias = Literal["all_latest", "tags_and", "tags_or", "sequence"]
+SoftwareVersionSet: TypeAlias = dict[str, str]
+Statuses: TypeAlias = list[tuple[str, int, int]]
+SweepResults: TypeAlias = dict[str, list[np.ndarray]]

{iqm_station_control_client-11.1.0 → iqm_station_control_client-11.3.1}/src/iqm/station_control/interface/pydantic_base.py

@@ -18,6 +18,7 @@ from pydantic import BaseModel, ConfigDict
 
 class PydanticBase(BaseModel):
     """Pydantic base model to change the behaviour of pydantic globally.
+
     Note that setting model_config in child classes will merge the configs rather than override this one.
     https://docs.pydantic.dev/latest/concepts/config/#change-behaviour-globally
     """

{iqm_station_control_client-11.1.0 → iqm_station_control_client-11.3.1/src/iqm_station_control_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-station-control-client
-Version: 11.1.0
+Version: 11.3.1
 Summary: Python client for communicating with Station Control Service
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License
@@ -214,7 +214,7 @@ Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Requires-Dist: iqm-exa-common<28,>=27
-Requires-Dist: iqm-data-definitions<3.0,>=2.13
+Requires-Dist: iqm-data-definitions<3.0,>=2.18
 Requires-Dist: opentelemetry-exporter-otlp<2.0,>=1.25.0
 Requires-Dist: protobuf<5.0,>=4.25.3
 Requires-Dist: types-protobuf

{iqm_station_control_client-11.1.0 → iqm_station_control_client-11.3.1}/src/iqm_station_control_client.egg-info/requires.txt

@@ -1,5 +1,5 @@
 iqm-exa-common<28,>=27
-iqm-data-definitions<3.0,>=2.13
+iqm-data-definitions<3.0,>=2.18
 opentelemetry-exporter-otlp<2.0,>=1.25.0
 protobuf<5.0,>=4.25.3
 types-protobuf

iqm_station_control_client-11.3.1/version.txt

@@ -0,0 +1 @@
+11.3.1

iqm_station_control_client-11.1.0/version.txt

@@ -1 +0,0 @@
-11.1.0