iqm-station-control-client 9.12.0__tar.gz → 9.14.0__tar.gz

{iqm_station_control_client-9.12.0 → iqm_station_control_client-9.14.0}/CHANGELOG.rst

@@ -2,6 +2,21 @@
 Changelog
 =========
 
+Version 9.14.0 (2025-08-14)
+===========================
+
+Bug fixes
+---------
+- Fixed an issue where the `IQMServerClient` was not correctly handling the retrieval of channel properties.
+
+Version 9.13.0 (2025-08-12)
+===========================
+
+Features
+--------
+
+- Fix Pydantic RootModel related mypy warnings.
+
 Version 9.12.0 (2025-08-08)
 ===========================
 

{iqm_station_control_client-9.12.0/src/iqm_station_control_client.egg-info → iqm_station_control_client-9.14.0}/PKG-INFO

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

@@ -25,7 +25,7 @@ import uuid
 from uuid import UUID
 
 import grpc
-from iqm.models.channel_properties import ChannelProperties
+from iqm.models.channel_properties import AWGProperties, ChannelProperties, ReadoutProperties
 import requests
 
 from exa.common.data.setting_node import SettingNode
@@ -43,7 +43,6 @@ from iqm.station_control.client.iqm_server.grpc_utils import (
 )
 from iqm.station_control.client.list_models import DutFieldDataList, DutList
 from iqm.station_control.client.serializers import deserialize_sweep_results, serialize_sweep_job_request
-from iqm.station_control.client.serializers.channel_property_serializer import unpack_channel_properties
 from iqm.station_control.client.serializers.setting_node_serializer import deserialize_setting_node
 from iqm.station_control.client.serializers.task_serializers import deserialize_sweep_job_request
 from iqm.station_control.client.station_control import _StationControlClientBase
@@ -129,7 +128,14 @@ class IqmServerClient(_StationControlClientBase):
         return self._get_resource(f"chip-design-records/{dut_label}", parse_json)
 
     def get_channel_properties(self) -> dict[str, ChannelProperties]:
-        return self._get_resource("channel-properties", unpack_channel_properties)
+        def bytes_to_dict(data: bytes) -> dict[str, ChannelProperties]:
+            """Deserialize bytes to a dictionary of channel property values."""
+            json_props: dict[str, dict] = json.loads(data.decode("utf-8"))
+            # Convert JSON representation to pythonic ChannelProperties
+            return _convert_channel_property_json_to_python(json_props)
+
+        channel_props = self._get_resource("channel-properties", bytes_to_dict)
+        return channel_props
 
     def sweep(self, sweep_definition: SweepDefinition) -> dict:
         with wrap_error("Job submission failed"):
@@ -411,6 +417,32 @@ def subscribe_to_job_events(channel: grpc.Channel, job_id: uuid.UUID) -> Iterabl
             raise e
 
 
+def _convert_channel_property_json_to_python(channel_property_json: dict[str, dict]) -> dict[str, ChannelProperties]:
+    """Convert the JSON representation of channel properties to a dictionary containing pythonic ChannelProperties."""
+    channel_properties: dict[str, ChannelProperties] = {}
+    for name, props in channel_property_json.items():
+        if "fast_feedback_sources" in props:
+            channel_properties[name] = AWGProperties(
+                sampling_rate=props.get("sampling_rate"),
+                instruction_duration_granularity=props.get("instruction_duration_granularity"),
+                instruction_duration_min=props.get("instruction_duration_min"),
+                fast_feedback_sources=props.get("fast_feedback_sources", []),
+                compatible_instructions=props.get("compatible_instructions", []),
+                local_oscillator=props.get("local_oscillator"),
+                mixer_correction=props.get("mixer_correction"),
+            )
+        if "integration_start_dead_time" in props:
+            channel_properties[name] = ReadoutProperties(
+                sampling_rate=props.get("sampling_rate"),
+                instruction_duration_granularity=props.get("instruction_duration_granularity"),
+                instruction_duration_min=props.get("instruction_duration_min"),
+                compatible_instructions=props.get("compatible_instructions", []),
+                integration_start_dead_time=props.get("integration_start_dead_time"),
+                integration_stop_dead_time=props.get("integration_stop_dead_time"),
+            )
+    return channel_properties
+
+
 def parse_calibration_set(cal_set_data: bytes) -> tuple[uuid.UUID, dict[str, ObservationValue]]:
     # IQM server calibration sets are in cocos calibration set JSON format, we can get
     # both id and observations from it

{iqm_station_control_client-9.12.0 → iqm_station_control_client-9.14.0}/src/iqm/station_control/client/list_models.py

@@ -16,7 +16,7 @@
 These are used mainly for easy serialization and deserialization of list of objects.
 """
 
-from typing import Generic, TypeAlias, TypeVar
+from typing import Generic, TypeVar
 
 from pydantic import ConfigDict, RootModel
 
@@ -64,12 +64,37 @@ class ListModel(RootModel):
     )
 
 
-DutList: TypeAlias = ListModel[list[DutData]]  # type: ignore[type-arg]
-DutFieldDataList: TypeAlias = ListModel[list[DutFieldData]]  # type: ignore[type-arg]
-ObservationDataList: TypeAlias = ListModel[list[ObservationData]]  # type: ignore[type-arg]
-ObservationDefinitionList: TypeAlias = ListModel[list[ObservationDefinition]]  # type: ignore[type-arg]
-ObservationLiteList: TypeAlias = ListModel[list[ObservationLite]]  # type: ignore[type-arg]
-ObservationUpdateList: TypeAlias = ListModel[list[ObservationUpdate]]  # type: ignore[type-arg]
-ObservationSetDataList: TypeAlias = ListModel[list[ObservationSetData]]  # type: ignore[type-arg]
-SequenceMetadataDataList: TypeAlias = ListModel[list[SequenceMetadataData]]  # type: ignore[type-arg]
-RunLiteList: TypeAlias = ListModel[list[RunLite]]  # type: ignore[type-arg]
+class DutList(ListModel):
+    root: list[DutData]
+
+
+class DutFieldDataList(ListModel):
+    root: list[DutFieldData]
+
+
+class ObservationDataList(ListModel):
+    root: list[ObservationData]
+
+
+class ObservationDefinitionList(ListModel):
+    root: list[ObservationDefinition]
+
+
+class ObservationLiteList(ListModel):
+    root: list[ObservationLite]
+
+
+class ObservationUpdateList(ListModel):
+    root: list[ObservationUpdate]
+
+
+class ObservationSetDataList(ListModel):
+    root: list[ObservationSetData]
+
+
+class SequenceMetadataDataList(ListModel):
+    root: list[SequenceMetadataData]
+
+
+class RunLiteList(ListModel):
+    root: list[RunLite]

{iqm_station_control_client-9.12.0 → iqm_station_control_client-9.14.0}/src/iqm/station_control/client/station_control.py

@@ -62,7 +62,7 @@ from iqm.station_control.client.serializers import (
 from iqm.station_control.client.serializers.channel_property_serializer import unpack_channel_properties
 from iqm.station_control.client.serializers.setting_node_serializer import deserialize_setting_node
 from iqm.station_control.client.serializers.sweep_serializers import deserialize_sweep_data
-from iqm.station_control.interface.list_with_meta import ListWithMeta
+from iqm.station_control.interface.list_with_meta import ListWithMeta, Meta
 from iqm.station_control.interface.models import (
     DutData,
     DutFieldData,
@@ -358,7 +358,7 @@ class StationControlClient(_StationControlClientBase):
     def create_observations(
         self, observation_definitions: Sequence[ObservationDefinition]
     ) -> ListWithMeta[ObservationData]:  # type: ignore[type-arg]
-        json_str = self._serialize_model(ObservationDefinitionList(observation_definitions))
+        json_str = self._serialize_model(ObservationDefinitionList(list(observation_definitions)))
         response = self._send_request(requests.post, "observations", json_str=json_str)
         return self._deserialize_response(response, ObservationDataList, list_with_meta=True)
 
@@ -394,7 +394,7 @@ class StationControlClient(_StationControlClientBase):
         return self._deserialize_response(response, ObservationDataList, list_with_meta=True)
 
     def update_observations(self, observation_updates: Sequence[ObservationUpdate]) -> list[ObservationData]:
-        json_str = self._serialize_model(ObservationUpdateList(observation_updates))
+        json_str = self._serialize_model(ObservationUpdateList(list(observation_updates)))
         response = self._send_request(requests.patch, "observations", json_str=json_str)
         return self._deserialize_response(response, ObservationDataList)
 
@@ -612,22 +612,23 @@ class StationControlClient(_StationControlClientBase):
     @staticmethod
     def _deserialize_response(
         response: requests.Response,
-        model_class: type[TypePydanticBase | ListModel[list[TypePydanticBase]]],  # type: ignore[type-arg]
+        model_class: type[TypePydanticBase | ListModel],
         *,
         list_with_meta: bool = False,
-    ) -> TypePydanticBase | ListWithMeta[TypePydanticBase]:  # type: ignore[type-arg]
+    ) -> TypePydanticBase | ListWithMeta:
         # Use "model_validate_json(response.text)" instead of "model_validate(response.json())".
         # 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.model_validate_json(response.text)  # type: ignore[var-annotated]
-            if response_with_meta.meta and response_with_meta.meta.errors:
-                logger.warning(
-                    "Errors in station control response:\n  - %s", "\n  - ".join(response_with_meta.meta.errors)
-                )
-            return ListWithMeta(model_class.model_validate(response_with_meta.items), meta=response_with_meta.meta)  # type: ignore[arg-type]
+            response_with_meta: ResponseWithMeta = ResponseWithMeta.model_validate_json(response.text)
+            meta = response_with_meta.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)
         model = model_class.model_validate_json(response.text)
-        return model  # type: ignore[return-value]
+        if isinstance(model, ListModel):
+            return model.root
+        return model
 
 
 def _remove_empty_values(kwargs: dict[str, Any]) -> dict[str, Any]:

{iqm_station_control_client-9.12.0 → iqm_station_control_client-9.14.0}/src/iqm/station_control/interface/list_with_meta.py

@@ -11,7 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-"""Models to extend standard list with metadata."""
+"""Models to extend a standard list with metadata."""
 
 from collections.abc import Iterable
 from dataclasses import dataclass

{iqm_station_control_client-9.12.0 → iqm_station_control_client-9.14.0/src/iqm_station_control_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-station-control-client
-Version: 9.12.0
+Version: 9.14.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-9.14.0/version.txt

@@ -0,0 +1 @@
+9.14.0

iqm_station_control_client-9.12.0/version.txt

@@ -1 +0,0 @@
-9.12.0