iqm-station-control-client 11.1.0__py3-none-any.whl → 11.2.0__py3-none-any.whl

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/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/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/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/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/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/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.dist-info → iqm_station_control_client-11.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-station-control-client
-Version: 11.1.0
+Version: 11.2.0
 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.dist-info → iqm_station_control_client-11.2.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
 iqm/station_control/client/__init__.py,sha256=1ND-AkIE9xLGIscH3WN44eyll9nlFhXeyCm-8EDFGQ4,942
-iqm/station_control/client/list_models.py,sha256=jpnmUqFvmzGxhq6fDBrV2crIgGNY5NfYqj5odpyWO-w,2524
+iqm/station_control/client/list_models.py,sha256=oKwa5ukh0OIXJTxLmi0awJV6xTLVKyxxduAs88O8xIA,2856
 iqm/station_control/client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 iqm/station_control/client/qon.py,sha256=9URsapeqVXi2h6xX0BKpl2fYKKkwGicLN-isI_Mmh0s,27768
-iqm/station_control/client/station_control.py,sha256=XbRkDvKiRvNsCQmMZPe1tkBDYR57q9oYLRC2HHsIRKg,29089
+iqm/station_control/client/station_control.py,sha256=z4acuGR1rP2vt2TwohQ_nlqeZWVG2iGblGnQT-jCJwc,29081
 iqm/station_control/client/utils.py,sha256=-6K4KgOgA4iyUCqX-w26JvFxlwlGBehGj4tIWCEbn74,3360
 iqm/station_control/client/iqm_server/__init__.py,sha256=nLsRHN1rnOKXwuzaq_liUpAYV3sis5jkyHccSdacV7U,624
 iqm/station_control/client/iqm_server/error.py,sha256=a8l7UTnzfbD8KDHP-uOve77S6LR1ai9uM_J_xHbLs0Y,1175
@@ -36,12 +36,12 @@ iqm/station_control/client/serializers/struct_serializer.py,sha256=7LSlrGVz0c-yi
 iqm/station_control/client/serializers/sweep_serializers.py,sha256=iFeBb4RFbHpVZifyduUypACSvulhkzdQIyG0gDoXOwM,5807
 iqm/station_control/client/serializers/task_serializers.py,sha256=mj5HWOolXLsqGaky7OYAWCW-BVp1RKN7vPtyiYpMaO8,3700
 iqm/station_control/interface/__init__.py,sha256=bBjhkiUSdwmx-CoNrT8pI4eGStI9RFUcW5CdpIRrd5k,785
-iqm/station_control/interface/list_with_meta.py,sha256=M8BacgBDjbf7yabNK-OHCJWrci5hewXA9vd8MrqrZts,1187
+iqm/station_control/interface/list_with_meta.py,sha256=P8T83qIQvCssY-aWrvf3aT827PAw1f57oEasgZPyXKY,1294
 iqm/station_control/interface/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-iqm/station_control/interface/pydantic_base.py,sha256=pQCa-8SRgBKMSwG-KyXA1HcIxE_qGMJt9g_eOGdZ31g,1303
+iqm/station_control/interface/pydantic_base.py,sha256=IfGW2fErFYRmhC5gjT26ueSwtW2S4eBW5xZDe7lutDg,1304
 iqm/station_control/interface/station_control.py,sha256=5gtDouAQ13KnyXNQUcBrpKG9pZdjIsX6fLJU9bmYJxU,20433
 iqm/station_control/interface/models/__init__.py,sha256=BP9iIwHi0nw8CUzScXOsu8bhxnE_rRulOsRVO5L1hx0,1989
-iqm/station_control/interface/models/dut.py,sha256=Hc_0XllXeIPGWhHsY7PC_jMpi7swpqo3jQQEQVnF3AM,1216
+iqm/station_control/interface/models/dut.py,sha256=Jp8rgi5e6ecDbU0fw9cgxn_9JczeTPkxYb7oIBv31ko,1155
 iqm/station_control/interface/models/dynamic_quantum_architecture.py,sha256=3YlI9e1XxdbkBzlOdxmzYTccJ8AJRnRSIp-JoBf8Yyw,4698
 iqm/station_control/interface/models/jobs.py,sha256=MGo0MOg-mTw3rF7vNCYNGAns6-eyl30ubqiEQWCFJ9c,6876
 iqm/station_control/interface/models/monitor.py,sha256=ItlgxtBup1hHg64uKeMKiFE7MaRRqSYdVRttsFD_XeU,1352
@@ -49,11 +49,11 @@ iqm/station_control/interface/models/observation.py,sha256=IblYdzJN88BNlyxUVR_dI
 iqm/station_control/interface/models/observation_set.py,sha256=y6uqslVF2kO1zREPE6EtrvG9ZVrLo0S2Sk7ZhRL8pks,3993
 iqm/station_control/interface/models/run.py,sha256=uEuAMryG-AjAIBTchftw94GpoSBE5SQK2qmlZZ4tq5k,4097
 iqm/station_control/interface/models/sequence.py,sha256=boWlMfP3woVgVObW3OaNbxsUV_qHYP1DA-oIBWj6XIo,2723
-iqm/station_control/interface/models/static_quantum_architecture.py,sha256=gsfJKlYsfZVEK3dqEKXkBSIHiY14DGwNbhPJdNHMtNM,1435
+iqm/station_control/interface/models/static_quantum_architecture.py,sha256=kt_rCExRd6zyatWVJCmCSf-gYdbEFfij3DfM0wBrPHI,2103
 iqm/station_control/interface/models/sweep.py,sha256=HFoFIrKhlYmHIBfGltY2O9_J28OvkkZILRbDHuqR0wc,2509
-iqm/station_control/interface/models/type_aliases.py,sha256=StsUwqwPp1N9wh79w40C6eEp7OmQ8E5AnJX7w2mqTnQ,1153
-iqm_station_control_client-11.1.0.dist-info/LICENSE.txt,sha256=R6Q7eUrLyoCQgWYorQ8WJmVmWKYU3dxA3jYUp0wwQAw,11332
-iqm_station_control_client-11.1.0.dist-info/METADATA,sha256=dy48AOJf3w-rbZY9rQ1rUfMnoFiMI6EQbe1Qfe2JncQ,14107
-iqm_station_control_client-11.1.0.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
-iqm_station_control_client-11.1.0.dist-info/top_level.txt,sha256=NB4XRfyDS6_wG9gMsyX-9LTU7kWnTQxNvkbzIxGv3-c,4
-iqm_station_control_client-11.1.0.dist-info/RECORD,,
+iqm/station_control/interface/models/type_aliases.py,sha256=HbHXNbY8UJ9eqk8BiVmogF-jHrgrcJxrWtUq6atwSg4,1219
+iqm_station_control_client-11.2.0.dist-info/LICENSE.txt,sha256=R6Q7eUrLyoCQgWYorQ8WJmVmWKYU3dxA3jYUp0wwQAw,11332
+iqm_station_control_client-11.2.0.dist-info/METADATA,sha256=EHr3eHm6e0JFKzoEpdaMq1gXfdyAEPMcVAFIJjctcDk,14107
+iqm_station_control_client-11.2.0.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
+iqm_station_control_client-11.2.0.dist-info/top_level.txt,sha256=NB4XRfyDS6_wG9gMsyX-9LTU7kWnTQxNvkbzIxGv3-c,4
+iqm_station_control_client-11.2.0.dist-info/RECORD,,