iqm-station-control-client 8.1.0__py3-none-any.whl → 9.1.0__py3-none-any.whl

iqm/station_control/client/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2024 IQM
+# Copyright 2025 IQM
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

iqm/station_control/client/iqm_server/error.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from exa.common.errors.server_errors import StationControlError
+from exa.common.errors.station_control_errors import StationControlError
 
 
 class IqmServerError(StationControlError):

iqm/station_control/client/iqm_server/grpc_utils.py

@@ -25,6 +25,7 @@ from pydantic import HttpUrl
 
 from iqm.station_control.client.iqm_server import proto
 from iqm.station_control.client.iqm_server.error import IqmServerError
+from iqm.station_control.interface.models.type_aliases import StrUUID
 
 
 class ClientCallDetails(grpc.ClientCallDetails):
@@ -43,8 +44,7 @@ class ApiTokenAuth(grpc.UnaryUnaryClientInterceptor, grpc.UnaryStreamClientInter
 
     def _add_auth_header(self, client_call_details) -> ClientCallDetails:
         details = ClientCallDetails(client_call_details)
-        token = self.get_token_callback()
-        details.metadata.append(("authorization", f"Bearer {token}"))
+        details.metadata.append(("authorization", self.get_token_callback()))
         return details
 
     def intercept_unary_stream(self, continuation, client_call_details, request):
@@ -115,7 +115,9 @@ def create_channel(
     return channel
 
 
-def to_proto_uuid(value: uuid.UUID) -> proto.Uuid:
+def to_proto_uuid(value: StrUUID) -> proto.Uuid:
+    if isinstance(value, str):
+        value = uuid.UUID(value)
     return proto.Uuid(raw=value.bytes)
 
 

iqm/station_control/client/iqm_server/iqm_server_client.py

@@ -11,9 +11,9 @@
 # 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.
-"""StationControlClient implementation for IQM Server"""
+"""Client implementation for IQM Server."""
 
-from collections.abc import Callable, Iterable
+from collections.abc import Callable, Iterable, Sequence
 from contextlib import contextmanager
 import dataclasses
 from io import BytesIO
@@ -22,9 +22,11 @@ import logging
 from time import sleep
 from typing import Any, TypeVar, cast
 import uuid
+from uuid import UUID
 
 import grpc
 from iqm.models.channel_properties import ChannelProperties
+import requests
 
 from exa.common.data.setting_node import SettingNode
 from exa.common.data.value import ObservationValue, validate_value
@@ -39,42 +41,64 @@ from iqm.station_control.client.iqm_server.grpc_utils import (
     to_datetime,
     to_proto_uuid,
 )
-from iqm.station_control.client.iqm_server.meta_class import IqmServerClientMeta
 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 StationControlClient
+from iqm.station_control.client.station_control import _StationControlClientBase
+from iqm.station_control.interface.list_with_meta import ListWithMeta
 from iqm.station_control.interface.models import (
     DutData,
     DutFieldData,
+    DynamicQuantumArchitecture,
+    JobData,
     JobExecutorStatus,
+    JobResult,
+    ObservationData,
+    ObservationDefinition,
+    ObservationLite,
+    ObservationSetData,
+    ObservationSetDefinition,
+    ObservationSetUpdate,
+    ObservationUpdate,
+    QualityMetrics,
+    RunData,
+    RunDefinition,
+    RunLite,
+    SequenceMetadataData,
+    SequenceMetadataDefinition,
+    SequenceResultData,
+    SequenceResultDefinition,
+    StaticQuantumArchitecture,
     Statuses,
     SweepData,
     SweepDefinition,
     SweepResults,
 )
-from iqm.station_control.interface.models.jobs import JobData, JobError, JobResult
+from iqm.station_control.interface.models.jobs import JobError
 from iqm.station_control.interface.models.sweep import SweepBase
+from iqm.station_control.interface.models.type_aliases import GetObservationsMode, SoftwareVersionSet, StrUUID
 
 logger = logging.getLogger(__name__)
 
 T = TypeVar("T")
 
 
-class IqmServerClient(StationControlClient, metaclass=IqmServerClientMeta):
+class IqmServerClient(_StationControlClientBase):
     def __init__(
         self,
         root_url: str,
+        *,
         get_token_callback: Callable[[], str] | None = None,
+        client_signature: str | None = None,
         grpc_channel: grpc.Channel | None = None,
     ):
-        self.root_url = root_url
+        super().__init__(root_url, get_token_callback=get_token_callback, client_signature=client_signature)
         self._connection_params = parse_connection_params(root_url)
         self._cached_resources = {}
         self._latest_submitted_sweep = None
-        self._channel = grpc_channel or create_channel(self._connection_params, get_token_callback)
+        self._channel = grpc_channel or create_channel(self._connection_params, self._get_token_callback)
         self._current_qc = resolve_current_qc(self._channel, self._connection_params.quantum_computer)
 
     def __del__(self):
@@ -86,9 +110,18 @@ class IqmServerClient(StationControlClient, metaclass=IqmServerClientMeta):
     def get_about(self) -> dict:
         return self._get_resource("about", parse_json)
 
+    def get_health(self) -> dict:
+        raise NotImplementedError
+
     def get_configuration(self) -> dict:
         return self._get_resource("configuration", parse_json)
 
+    def get_exa_configuration(self) -> str:
+        raise NotImplementedError
+
+    def get_or_create_software_version_set(self, software_version_set: SoftwareVersionSet) -> int:
+        raise NotImplementedError
+
     def get_settings(self) -> SettingNode:
         return self._get_resource("settings", deserialize_setting_node).copy()
 
@@ -98,14 +131,6 @@ class IqmServerClient(StationControlClient, metaclass=IqmServerClientMeta):
     def get_channel_properties(self) -> dict[str, ChannelProperties]:
         return self._get_resource("channel-properties", unpack_channel_properties)
 
-    def get_duts(self) -> list[DutData]:
-        return self._get_resource("duts", lambda data: DutList.model_validate(parse_json(data)))
-
-    def get_dut_fields(self, dut_label: str) -> list[DutFieldData]:
-        return self._get_resource(
-            f"dut-fields/{dut_label}", lambda data: DutFieldDataList.model_validate(parse_json(data))
-        )
-
     def sweep(self, sweep_definition: SweepDefinition) -> dict:
         with wrap_error("Job submission failed"):
             jobs = proto.JobsStub(self._channel)
@@ -126,8 +151,11 @@ class IqmServerClient(StationControlClient, metaclass=IqmServerClientMeta):
                 "job_id": str(job_id),
             }
 
-    def get_sweep(self, sweep_id: uuid.UUID) -> SweepData:
+    def get_sweep(self, sweep_id: UUID) -> SweepData:
         with wrap_error("Job loading failed"):
+            if isinstance(sweep_id, str):
+                sweep_id = uuid.UUID(sweep_id)
+
             jobs = proto.JobsStub(self._channel)
             job_lookup = proto.JobLookupV1(id=to_proto_uuid(sweep_id))
             job: proto.JobV1 = jobs.GetJobV1(job_lookup)
@@ -146,18 +174,118 @@ class IqmServerClient(StationControlClient, metaclass=IqmServerClientMeta):
                 **{f.name: getattr(sweep, f.name) for f in dataclasses.fields(SweepBase)},
             )
 
-    def get_sweep_results(self, sweep_id: uuid.UUID) -> SweepResults:
+    def delete_sweep(self, sweep_id: UUID) -> None:
+        raise NotImplementedError
+
+    def get_sweep_results(self, sweep_id: UUID) -> SweepResults:
         with wrap_error("Job result loading failed"):
             jobs = proto.JobsStub(self._channel)
             data_chunks = jobs.GetJobResultsV1(proto.JobLookupV1(id=to_proto_uuid(sweep_id)))
             return deserialize_sweep_results(load_all(data_chunks))
 
-    def abort_job(self, sweep_id: uuid.UUID) -> None:
-        with wrap_error("Job cancellation failed"):
-            jobs = proto.JobsStub(self._channel)
-            jobs.CancelJobV1(proto.JobLookupV1(id=to_proto_uuid(sweep_id)))
+    def run(
+        self,
+        run_definition: RunDefinition,
+        update_progress_callback: Callable[[Statuses], None] | None = None,
+        wait_job_completion: bool = True,
+    ) -> bool:
+        raise NotImplementedError
+
+    def get_run(self, run_id: UUID) -> RunData:
+        raise NotImplementedError
+
+    def query_runs(self, **kwargs) -> ListWithMeta[RunLite]:
+        raise NotImplementedError
+
+    def create_observations(
+        self, observation_definitions: Sequence[ObservationDefinition]
+    ) -> ListWithMeta[ObservationData]:
+        raise NotImplementedError
+
+    def get_observations(
+        self,
+        *,
+        mode: GetObservationsMode,
+        dut_label: str | None = None,
+        dut_field: str | None = None,
+        tags: list[str] | None = None,
+        invalid: bool | None = False,
+        run_ids: list[UUID] | None = None,
+        sequence_ids: list[UUID] | None = None,
+        limit: int | None = None,
+    ) -> list[ObservationData]:
+        raise NotImplementedError
+
+    def query_observations(self, **kwargs) -> ListWithMeta[ObservationData]:
+        raise NotImplementedError
+
+    def update_observations(self, observation_updates: Sequence[ObservationUpdate]) -> list[ObservationData]:
+        raise NotImplementedError
+
+    def query_observation_sets(self, **kwargs) -> ListWithMeta[ObservationSetData]:
+        raise NotImplementedError
+
+    def create_observation_set(self, observation_set_definition: ObservationSetDefinition) -> ObservationSetData:
+        raise NotImplementedError
+
+    def get_observation_set(self, observation_set_id: UUID) -> ObservationSetData:
+        raise NotImplementedError
+
+    def update_observation_set(self, observation_set_update: ObservationSetUpdate) -> ObservationSetData:
+        raise NotImplementedError
+
+    def finalize_observation_set(self, observation_set_id: UUID) -> None:
+        raise NotImplementedError
+
+    def get_observation_set_observations(self, observation_set_id: UUID) -> list[ObservationLite]:
+        raise NotImplementedError
+
+    def get_default_calibration_set(self) -> ObservationSetData:
+        raise NotImplementedError
+
+    def get_default_calibration_set_observations(self) -> list[ObservationLite]:
+        raise NotImplementedError
+
+    def get_dynamic_quantum_architecture(self, calibration_set_id: UUID) -> DynamicQuantumArchitecture:
+        response = self._send_request(requests.get, f"api/v1/calibration/{calibration_set_id}/gates")
+        return DynamicQuantumArchitecture.model_validate_json(response.text)
+
+    def get_default_dynamic_quantum_architecture(self) -> DynamicQuantumArchitecture:
+        raise NotImplementedError
+
+    def get_default_calibration_set_quality_metrics(self) -> QualityMetrics:
+        raise NotImplementedError
+
+    def get_calibration_set_quality_metrics(self, calibration_set_id: UUID) -> QualityMetrics:
+        raise NotImplementedError
+
+    def get_duts(self) -> list[DutData]:
+        return self._get_resource("duts", lambda data: DutList.model_validate(parse_json(data)))
+
+    def get_dut_fields(self, dut_label: str) -> list[DutFieldData]:
+        return self._get_resource(
+            f"dut-fields/{dut_label}", lambda data: DutFieldDataList.model_validate(parse_json(data))
+        )
+
+    def query_sequence_metadatas(self, **kwargs) -> ListWithMeta[SequenceMetadataData]:
+        raise NotImplementedError
+
+    def create_sequence_metadata(
+        self, sequence_metadata_definition: SequenceMetadataDefinition
+    ) -> SequenceMetadataData:
+        raise NotImplementedError
+
+    def save_sequence_result(self, sequence_result_definition: SequenceResultDefinition) -> SequenceResultData:
+        raise NotImplementedError
+
+    def get_sequence_result(self, sequence_id: UUID) -> SequenceResultData:
+        raise NotImplementedError
 
-    def get_job(self, job_id: uuid.UUID) -> JobData:
+    def get_static_quantum_architecture(self, dut_label: str) -> StaticQuantumArchitecture:
+        response = self._send_request(requests.get, "api/v1/quantum-architecture")
+        return StaticQuantumArchitecture.model_validate_json(response.text)
+
+    def get_job(self, job_id: StrUUID) -> JobData:
         with wrap_error("Job loading failed"):
             jobs = proto.JobsStub(self._channel)
             job: proto.JobV1 = jobs.GetJobV1(proto.JobLookupV1(id=to_proto_uuid(job_id)))
@@ -175,6 +303,34 @@ class IqmServerClient(StationControlClient, metaclass=IqmServerClientMeta):
                 position=job.queue_position if job.HasField("queue_position") else None,
             )
 
+    def abort_job(self, job_id: StrUUID) -> None:
+        with wrap_error("Job cancellation failed"):
+            jobs = proto.JobsStub(self._channel)
+            jobs.CancelJobV1(proto.JobLookupV1(id=to_proto_uuid(job_id)))
+
+    def get_calibration_set_values(self, calibration_set_id: StrUUID) -> dict[str, ObservationValue]:
+        with wrap_error("Calibration set loading failed"):
+            calibrations = proto.CalibrationsStub(self._channel)
+            data_chunks = calibrations.GetFullCalibrationDataV1(
+                proto.CalibrationLookupV1(
+                    id=to_proto_uuid(calibration_set_id),
+                )
+            )
+            _, cal_set_values = parse_calibration_set(load_all(data_chunks))
+            return cal_set_values
+
+    def get_latest_calibration_set_id(self, dut_label: str) -> uuid.UUID:
+        with wrap_error("Calibration set metadata loading failed"):
+            calibrations = proto.CalibrationsStub(self._channel)
+            metadata: proto.CalibrationMetadataV1 = calibrations.GetLatestQuantumComputerCalibrationV1(
+                proto.LatestQuantumComputerCalibrationLookupV1(
+                    qc_id=self._current_qc.id,
+                )
+            )
+            if metadata.dut_label != dut_label:
+                raise ValueError(f"No calibration set for dut_label = {dut_label}")
+            return from_proto_uuid(metadata.id)
+
     def _wait_job_completion(
         self,
         task_id: str,
@@ -202,29 +358,6 @@ class IqmServerClient(StationControlClient, metaclass=IqmServerClientMeta):
             except KeyboardInterrupt:
                 return True
 
-    def get_calibration_set_values(self, calibration_set_id: uuid.UUID) -> dict[str, ObservationValue]:
-        with wrap_error("Calibration set loading failed"):
-            calibrations = proto.CalibrationsStub(self._channel)
-            data_chunks = calibrations.GetFullCalibrationDataV1(
-                proto.CalibrationLookupV1(
-                    id=to_proto_uuid(calibration_set_id),
-                )
-            )
-            _, cal_set_values = parse_calibration_set(load_all(data_chunks))
-            return cal_set_values
-
-    def get_latest_calibration_set_id(self, dut_label: str) -> uuid.UUID:
-        with wrap_error("Calibration set metadata loading failed"):
-            calibrations = proto.CalibrationsStub(self._channel)
-            metadata: proto.CalibrationMetadataV1 = calibrations.GetLatestQuantumComputerCalibrationV1(
-                proto.LatestQuantumComputerCalibrationLookupV1(
-                    qc_id=self._current_qc.id,
-                )
-            )
-            if metadata.dut_label != dut_label:
-                raise ValueError(f"No calibration set for dut_label = {dut_label}")
-            return from_proto_uuid(metadata.id)
-
     def _get_cached_sweep(self, sweep_id: uuid.UUID) -> SweepDefinition | None:
         latest_submitted = self._latest_submitted_sweep
         if latest_submitted and latest_submitted.sweep_id == sweep_id:

iqm/station_control/client/list_models.py

@@ -1,4 +1,4 @@
-# Copyright 2024 IQM
+# Copyright 2025 IQM
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -11,9 +11,12 @@
 # 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.
-"""Station control client type adapters."""
+"""Station control client list types for different models.
 
-from typing import Generic, TypeVar
+These are used mainly for easy serialization and deserialization of list of objects.
+"""
+
+from typing import Generic, TypeAlias, TypeVar
 
 from pydantic import ConfigDict, RootModel
 
@@ -53,17 +56,20 @@ class ListModel(RootModel):
     def __len__(self) -> int:
         return len(self.root)
 
+    def __str__(self) -> str:
+        return str(self.root)
+
     model_config = ConfigDict(
         ser_json_inf_nan="constants",  # Will serialize Infinity and NaN values as Infinity and NaN
     )
 
 
-DutList = ListModel[list[DutData]]  # type: ignore
-DutFieldDataList = ListModel[list[DutFieldData]]  # type: ignore
-ObservationDataList = ListModel[list[ObservationData]]  # type: ignore
-ObservationDefinitionList = ListModel[list[ObservationDefinition]]  # type: ignore
-ObservationLiteList = ListModel[list[ObservationLite]]  # type: ignore
-ObservationUpdateList = ListModel[list[ObservationUpdate]]  # type: ignore
-ObservationSetDataList = ListModel[list[ObservationSetData]]  # type: ignore
-SequenceMetadataDataList = ListModel[list[SequenceMetadataData]]  # type: ignore
-RunLiteList = ListModel[list[RunLite]]  # type: ignore
+DutList: TypeAlias = ListModel[list[DutData]]
+DutFieldDataList: TypeAlias = ListModel[list[DutFieldData]]
+ObservationDataList: TypeAlias = ListModel[list[ObservationData]]
+ObservationDefinitionList: TypeAlias = ListModel[list[ObservationDefinition]]
+ObservationLiteList: TypeAlias = ListModel[list[ObservationLite]]
+ObservationUpdateList: TypeAlias = ListModel[list[ObservationUpdate]]
+ObservationSetDataList: TypeAlias = ListModel[list[ObservationSetData]]
+SequenceMetadataDataList: TypeAlias = ListModel[list[SequenceMetadataData]]
+RunLiteList: TypeAlias = ListModel[list[RunLite]]

iqm/station_control/client/serializers/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2024 IQM
+# Copyright 2025 IQM
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

iqm/station_control/client/serializers/channel_property_serializer.py

@@ -1,10 +1,16 @@
-#  ********************************************************************************
-#  Copyright (c) 2019-2024 IQM Finland Oy.
-#  All rights reserved. Confidential and proprietary.
+# Copyright 2025 IQM
 #
-#  Distribution or reproduction of any information contained herein
-#  is prohibited without IQM Finland Oy’s prior written permission.
-#  ********************************************************************************
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
 """Serializers and deserializers for :class:`~iqm.models.channel_properties.channel_properties.ChannelProperties`"""
 
 from collections.abc import Iterable

iqm/station_control/client/serializers/datetime_serializers.py

@@ -1,4 +1,4 @@
-# Copyright 2024 IQM
+# Copyright 2025 IQM
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

iqm/station_control/client/serializers/playlist_serializers.py

@@ -1,4 +1,4 @@
-# Copyright 2024 IQM
+# Copyright 2025 IQM
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

iqm/station_control/client/serializers/run_serializers.py

@@ -1,4 +1,4 @@
-# Copyright 2024 IQM
+# Copyright 2025 IQM
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

iqm/station_control/client/serializers/setting_node_serializer.py

@@ -1,4 +1,4 @@
-# Copyright 2024 IQM
+# Copyright 2025 IQM
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

iqm/station_control/client/serializers/struct_serializer.py

@@ -1,4 +1,4 @@
-# Copyright 2024 IQM
+# Copyright 2025 IQM
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

iqm/station_control/client/serializers/sweep_serializers.py

@@ -1,4 +1,4 @@
-# Copyright 2024 IQM
+# Copyright 2025 IQM
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -27,8 +27,7 @@ from exa.common.data.setting_node import SettingNode
 from exa.common.sweep.database_serialization import decode_and_validate_sweeps, encode_nd_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 JobExecutorStatus
+from iqm.station_control.interface.models import JobExecutorStatus, SweepData, SweepDefinition, SweepResults
 
 
 def serialize_sweep_definition(sweep_definition: SweepDefinition) -> SweepDefinitionProto:

iqm/station_control/client/serializers/task_serializers.py

@@ -1,4 +1,4 @@
-# Copyright 2024 IQM
+# Copyright 2025 IQM
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.