iqm-station-control-client 9.4.0__tar.gz → 9.6.0__tar.gz

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/CHANGELOG.rst

@@ -2,6 +2,22 @@
 Changelog
 =========
 
+Version 9.6.0 (2025-07-09)
+==========================
+
+Features
+--------
+
+- Enable mypy type checking in CI and add temporary type ignores to the source code. :issue:`SW-1615`
+
+Version 9.5.0 (2025-07-07)
+==========================
+
+Features
+--------
+
+- Improve documentation.
+
 Version 9.4.0 (2025-06-26)
 ==========================
 

{iqm_station_control_client-9.4.0/src/iqm_station_control_client.egg-info → iqm_station_control_client-9.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-station-control-client
-Version: 9.4.0
+Version: 9.6.0
 Summary: Python client for communicating with Station Control Service
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License
@@ -217,11 +217,14 @@ Requires-Dist: iqm-exa-common<27,>=26
 Requires-Dist: iqm-data-definitions<3.0,>=2.13
 Requires-Dist: opentelemetry-exporter-otlp==1.25.0
 Requires-Dist: protobuf<5.0,>=4.25.3
+Requires-Dist: types-protobuf
 Requires-Dist: grpcio<2.0,>=1.65.4
 Requires-Dist: pydantic<3.0,>=2.10.4
 Requires-Dist: PyYAML==6.0
 Requires-Dist: requests==2.32.3
+Requires-Dist: types-requests
 Requires-Dist: tqdm>=4.59.0
+Requires-Dist: types-tqdm
 
 Station control client library
 ==============================

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/pyproject.toml

@@ -21,6 +21,14 @@ file = "LICENSE.txt"
 Documentation = "https://iqm-finland.github.io/docs/iqm-station-control-client/"
 Homepage = "https://pypi.org/project/iqm-station-control-client/"
 
+[tool.mypy]
+explicit_package_bases = true
+mypy_path = "$MYPY_CONFIG_FILE_DIR/src"
+namespace_packages = true
+[[tool.mypy.overrides]]
+module = [ "iqm.data_definitions.*", "iqm.models.*", "daemon.*", "quimb.*", "qiskit.*", "qiskit_aer.*", "grpc.*", "lmfit.*", "emukit.*", "mockito.*", "sklearn.*", "dill.*", "uncertainties.*", "GPy.*", "pythonjsonlogger.*",]
+ignore_missing_imports = true
+
 [tool.ruff]
 exclude = [ "*.ipynb", "*.rst",]
 extend-exclude = [ "src/iqm/station_control/client/iqm_server/proto",]

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/requirements/base.in

@@ -1,8 +1,11 @@
 iqm-data-definitions >= 2.13, < 3.0
 opentelemetry-exporter-otlp == 1.25.0
 protobuf >= 4.25.3, < 5.0
+types-protobuf
 grpcio >= 1.65.4, < 2.0
 pydantic >= 2.10.4, <3.0
 PyYAML == 6.0
 requests == 2.32.3
+types-requests
 tqdm >= 4.59.0
+types-tqdm

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/requirements/base.txt

@@ -2,8 +2,11 @@ iqm-exa-common>=26,<27
 iqm-data-definitions >= 2.13, < 3.0
 opentelemetry-exporter-otlp == 1.25.0
 protobuf >= 4.25.3, < 5.0
+types-protobuf
 grpcio >= 1.65.4, < 2.0
 pydantic >= 2.10.4, <3.0
 PyYAML == 6.0
 requests == 2.32.3
-tqdm >= 4.59.0
+types-requests
+tqdm >= 4.59.0
+types-tqdm

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/src/iqm/station_control/client/iqm_server/grpc_utils.py

@@ -152,5 +152,5 @@ def extract_error(error: grpc.RpcError, title: str | None = None) -> IqmServerEr
         message=f"{title}: {message}" if title else message,
         status_code=status_code,
         error_code=error_code,
-        details=details,
+        details=details,  # type: ignore[arg-type]
     )

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/src/iqm/station_control/client/iqm_server/iqm_server_client.py

@@ -146,7 +146,7 @@ class IqmServerClient(_StationControlClientBase):
             # right after submitting it so we can cache reference to the submitted sweep here
             # to avoid extra request to the server
             job_id = from_proto_uuid(job.id)
-            self._latest_submitted_sweep = dataclasses.replace(sweep_definition, sweep_id=job_id)
+            self._latest_submitted_sweep = dataclasses.replace(sweep_definition, sweep_id=job_id)  # type: ignore[assignment]
             return {
                 "job_id": str(job_id),
             }
@@ -194,12 +194,12 @@ class IqmServerClient(_StationControlClientBase):
     def get_run(self, run_id: UUID) -> RunData:
         raise NotImplementedError
 
-    def query_runs(self, **kwargs) -> ListWithMeta[RunLite]:
+    def query_runs(self, **kwargs) -> ListWithMeta[RunLite]:  # type: ignore[type-arg]
         raise NotImplementedError
 
     def create_observations(
         self, observation_definitions: Sequence[ObservationDefinition]
-    ) -> ListWithMeta[ObservationData]:
+    ) -> ListWithMeta[ObservationData]:  # type: ignore[type-arg]
         raise NotImplementedError
 
     def get_observations(
@@ -216,13 +216,13 @@ class IqmServerClient(_StationControlClientBase):
     ) -> list[ObservationData]:
         raise NotImplementedError
 
-    def query_observations(self, **kwargs) -> ListWithMeta[ObservationData]:
+    def query_observations(self, **kwargs) -> ListWithMeta[ObservationData]:  # type: ignore[type-arg]
         raise NotImplementedError
 
     def update_observations(self, observation_updates: Sequence[ObservationUpdate]) -> list[ObservationData]:
         raise NotImplementedError
 
-    def query_observation_sets(self, **kwargs) -> ListWithMeta[ObservationSetData]:
+    def query_observation_sets(self, **kwargs) -> ListWithMeta[ObservationSetData]:  # type: ignore[type-arg]
         raise NotImplementedError
 
     def create_observation_set(self, observation_set_definition: ObservationSetDefinition) -> ObservationSetData:
@@ -260,14 +260,15 @@ class IqmServerClient(_StationControlClientBase):
         raise NotImplementedError
 
     def get_duts(self) -> list[DutData]:
-        return self._get_resource("duts", lambda data: DutList.model_validate(parse_json(data)))
+        return self._get_resource("duts", lambda data: DutList.model_validate(parse_json(data)))  # type: ignore[arg-type,return-value]
 
     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))
+            f"dut-fields/{dut_label}",
+            lambda data: DutFieldDataList.model_validate(parse_json(data)),  # type: ignore[arg-type,return-value]
         )
 
-    def query_sequence_metadatas(self, **kwargs) -> ListWithMeta[SequenceMetadataData]:
+    def query_sequence_metadatas(self, **kwargs) -> ListWithMeta[SequenceMetadataData]:  # type: ignore[type-arg]
         raise NotImplementedError
 
     def create_sequence_metadata(
@@ -291,7 +292,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,
+                job_status=job.status,  # type: ignore[arg-type]
                 job_result=JobResult(
                     job_id=from_proto_uuid(job.id),
                     parallel_sweep_progress=[],

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/src/iqm/station_control/client/serializers/run_serializers.py

@@ -40,8 +40,8 @@ def serialize_run_definition(run_definition: RunDefinition) -> RunDefinitionProt
         username=run_definition.username,
         experiment_name=run_definition.experiment_name,
         experiment_label=run_definition.experiment_label,
-        options=serialize_struct(run_definition.options),
-        additional_run_properties=serialize_struct(run_definition.additional_run_properties),
+        options=serialize_struct(run_definition.options),  # type: ignore[arg-type]
+        additional_run_properties=serialize_struct(run_definition.additional_run_properties),  # type: ignore[arg-type]
         software_version_set_id=run_definition.software_version_set_id,
         components=run_definition.components,
         default_data_parameters=run_definition.default_data_parameters,
@@ -50,7 +50,7 @@ def serialize_run_definition(run_definition: RunDefinition) -> RunDefinitionProt
     run_definition_proto.sweep_definition_payload.Pack(
         serialize_sweep_definition(run_definition.sweep_definition), type_url_prefix="iqm-data-definitions"
     )
-    for key, sweep in run_definition.hard_sweeps.items():
+    for key, sweep in run_definition.hard_sweeps.items():  # type: ignore[union-attr]
         run_definition_proto.hard_sweeps[key].CopyFrom(proto_serialization.nd_sweep.pack(sweep, minimal=False))
     return run_definition_proto
 
@@ -94,7 +94,7 @@ def serialize_run_data(run_data: RunData) -> dict:
         "options": run_data.options,
         "additional_run_properties": run_data.additional_run_properties,
         "software_version_set_id": run_data.software_version_set_id,
-        "hard_sweeps": {key: encode_nd_sweeps(value) for key, value in run_data.hard_sweeps.items()},
+        "hard_sweeps": {key: encode_nd_sweeps(value) for key, value in run_data.hard_sweeps.items()},  # type: ignore[union-attr]
         "components": run_data.components,
         "default_data_parameters": run_data.default_data_parameters,
         "default_sweep_parameters": run_data.default_sweep_parameters,
@@ -124,8 +124,8 @@ def deserialize_run_data(data: dict) -> RunData:
         default_data_parameters=data["default_data_parameters"],
         default_sweep_parameters=data["default_sweep_parameters"],
         sweep_data=deserialize_sweep_data(data["sweep_data"]),
-        created_timestamp=deserialize_datetime(data["created_timestamp"]),
-        modified_timestamp=deserialize_datetime(data["modified_timestamp"]),
-        begin_timestamp=deserialize_datetime(data["begin_timestamp"]),
+        created_timestamp=deserialize_datetime(data["created_timestamp"]),  # type: ignore[arg-type]
+        modified_timestamp=deserialize_datetime(data["modified_timestamp"]),  # type: ignore[arg-type]
+        begin_timestamp=deserialize_datetime(data["begin_timestamp"]),  # type: ignore[arg-type]
         end_timestamp=deserialize_datetime(data["end_timestamp"]),
     )

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/src/iqm/station_control/client/serializers/sweep_serializers.py

@@ -84,10 +84,10 @@ def deserialize_sweep_data(data: dict) -> SweepData:
         sweep_id=uuid.UUID(data["sweep_id"]),
         dut_label=data["dut_label"],
         settings=SettingNode(**json.loads(data["settings"])),
-        sweeps=decode_and_validate_sweeps(data["sweeps"]),
+        sweeps=decode_and_validate_sweeps(data["sweeps"]),  # type: ignore[arg-type]
         return_parameters=data["return_parameters"],
-        created_timestamp=deserialize_datetime(data["created_timestamp"]),
-        modified_timestamp=deserialize_datetime(data["modified_timestamp"]),
+        created_timestamp=deserialize_datetime(data["created_timestamp"]),  # type: ignore[arg-type]
+        modified_timestamp=deserialize_datetime(data["modified_timestamp"]),  # type: ignore[arg-type]
         begin_timestamp=deserialize_datetime(data["begin_timestamp"]),
         end_timestamp=deserialize_datetime(data["end_timestamp"]),
         job_status=JobExecutorStatus(data["job_status"]),

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/src/iqm/station_control/client/station_control.py

@@ -186,7 +186,7 @@ class _StationControlClientBase(StationControlInterface):
                 error_message = response.text
 
             try:
-                error_class = map_from_status_code_to_error(response.status_code)
+                error_class = map_from_status_code_to_error(response.status_code)  # type: ignore[arg-type]
             except KeyError:
                 raise RuntimeError(f"Unexpected response status code {response.status_code}: {error_message}")
 
@@ -350,14 +350,14 @@ class StationControlClient(_StationControlClientBase):
         response = self._send_request(requests.get, f"runs/{run_id}")
         return deserialize_run_data(response.json())
 
-    def query_runs(self, **kwargs) -> ListWithMeta[RunLite]:
+    def query_runs(self, **kwargs) -> ListWithMeta[RunLite]:  # type: ignore[type-arg]
         params = self._clean_query_parameters(RunData, **kwargs)
         response = self._send_request(requests.get, "runs", params=params)
         return self._deserialize_response(response, RunLiteList, list_with_meta=True)
 
     def create_observations(
         self, observation_definitions: Sequence[ObservationDefinition]
-    ) -> ListWithMeta[ObservationData]:
+    ) -> ListWithMeta[ObservationData]:  # type: ignore[type-arg]
         json_str = self._serialize_model(ObservationDefinitionList(observation_definitions))
         response = self._send_request(requests.post, "observations", json_str=json_str)
         return self._deserialize_response(response, ObservationDataList, list_with_meta=True)
@@ -370,8 +370,8 @@ class StationControlClient(_StationControlClientBase):
         dut_field: str | None = None,
         tags: list[str] | None = None,
         invalid: bool | None = False,
-        run_ids: list[StrUUID] | None = None,
-        sequence_ids: list[StrUUID] | None = None,
+        run_ids: list[StrUUID] | None = None,  # type: ignore[override]
+        sequence_ids: list[StrUUID] | None = None,  # type: ignore[override]
         limit: int | None = None,
     ) -> list[ObservationData]:
         kwargs = {
@@ -388,7 +388,7 @@ class StationControlClient(_StationControlClientBase):
         response = self._send_request(requests.get, "observations", params=params)
         return self._deserialize_response(response, ObservationDataList)
 
-    def query_observations(self, **kwargs) -> ListWithMeta[ObservationData]:
+    def query_observations(self, **kwargs) -> ListWithMeta[ObservationData]:  # type: ignore[type-arg]
         params = self._clean_query_parameters(ObservationData, **kwargs)
         response = self._send_request(requests.get, "observations", params=params)
         return self._deserialize_response(response, ObservationDataList, list_with_meta=True)
@@ -398,7 +398,7 @@ class StationControlClient(_StationControlClientBase):
         response = self._send_request(requests.patch, "observations", json_str=json_str)
         return self._deserialize_response(response, ObservationDataList)
 
-    def query_observation_sets(self, **kwargs) -> ListWithMeta[ObservationSetData]:
+    def query_observation_sets(self, **kwargs) -> ListWithMeta[ObservationSetData]:  # type: ignore[type-arg]
         params = self._clean_query_parameters(ObservationSetData, **kwargs)
         response = self._send_request(requests.get, "observation-sets", params=params)
         return self._deserialize_response(response, ObservationSetDataList, list_with_meta=True)
@@ -406,16 +406,16 @@ class StationControlClient(_StationControlClientBase):
     def create_observation_set(self, observation_set_definition: ObservationSetDefinition) -> ObservationSetData:
         json_str = self._serialize_model(observation_set_definition)
         response = self._send_request(requests.post, "observation-sets", json_str=json_str)
-        return self._deserialize_response(response, ObservationSetData)
+        return self._deserialize_response(response, ObservationSetData)  # type: ignore[return-value]
 
     def get_observation_set(self, observation_set_id: StrUUID) -> ObservationSetData:
         response = self._send_request(requests.get, f"observation-sets/{observation_set_id}")
-        return self._deserialize_response(response, ObservationSetData)
+        return self._deserialize_response(response, ObservationSetData)  # type: ignore[return-value]
 
     def update_observation_set(self, observation_set_update: ObservationSetUpdate) -> ObservationSetData:
         json_str = self._serialize_model(observation_set_update)
         response = self._send_request(requests.patch, "observation-sets", json_str=json_str)
-        return self._deserialize_response(response, ObservationSetData)
+        return self._deserialize_response(response, ObservationSetData)  # type: ignore[return-value]
 
     def finalize_observation_set(self, observation_set_id: StrUUID) -> None:
         self._send_request(requests.post, f"observation-sets/{observation_set_id}/finalize")
@@ -426,7 +426,7 @@ class StationControlClient(_StationControlClientBase):
 
     def get_default_calibration_set(self) -> ObservationSetData:
         response = self._send_request(requests.get, "calibration-sets/default")
-        return self._deserialize_response(response, ObservationSetData)
+        return self._deserialize_response(response, ObservationSetData)  # type: ignore[return-value]
 
     def get_default_calibration_set_observations(self) -> list[ObservationLite]:
         response = self._send_request(requests.get, "calibration-sets/default/observations")
@@ -434,22 +434,22 @@ class StationControlClient(_StationControlClientBase):
 
     def get_default_dynamic_quantum_architecture(self) -> DynamicQuantumArchitecture:
         response = self._send_request(requests.get, "calibration-sets/default/dynamic-quantum-architecture")
-        return self._deserialize_response(response, DynamicQuantumArchitecture)
+        return self._deserialize_response(response, DynamicQuantumArchitecture)  # type: ignore[return-value]
 
     @cache
     def get_dynamic_quantum_architecture(self, calibration_set_id: StrUUID) -> DynamicQuantumArchitecture:
         response = self._send_request(
             requests.get, f"calibration-sets/{calibration_set_id}/dynamic-quantum-architecture"
         )
-        return self._deserialize_response(response, DynamicQuantumArchitecture)
+        return self._deserialize_response(response, DynamicQuantumArchitecture)  # type: ignore[return-value]
 
     def get_default_calibration_set_quality_metrics(self) -> QualityMetrics:
         response = self._send_request(requests.get, "calibration-sets/default/metrics")
-        return self._deserialize_response(response, QualityMetrics)
+        return self._deserialize_response(response, QualityMetrics)  # type: ignore[return-value]
 
     def get_calibration_set_quality_metrics(self, calibration_set_id: StrUUID) -> QualityMetrics:
         response = self._send_request(requests.get, f"calibration-sets/{calibration_set_id}/metrics")
-        return self._deserialize_response(response, QualityMetrics)
+        return self._deserialize_response(response, QualityMetrics)  # type: ignore[return-value]
 
     def get_duts(self) -> list[DutData]:
         response = self._send_request(requests.get, "duts")
@@ -460,7 +460,7 @@ class StationControlClient(_StationControlClientBase):
         response = self._send_request(requests.get, "dut-fields", params=params)
         return self._deserialize_response(response, DutFieldDataList)
 
-    def query_sequence_metadatas(self, **kwargs) -> ListWithMeta[SequenceMetadataData]:
+    def query_sequence_metadatas(self, **kwargs) -> ListWithMeta[SequenceMetadataData]:  # type: ignore[type-arg]
         params = self._clean_query_parameters(SequenceMetadataData, **kwargs)
         response = self._send_request(requests.get, "sequence-metadatas", params=params)
         return self._deserialize_response(response, SequenceMetadataDataList, list_with_meta=True)
@@ -470,7 +470,7 @@ class StationControlClient(_StationControlClientBase):
     ) -> SequenceMetadataData:
         json_str = self._serialize_model(sequence_metadata_definition)
         response = self._send_request(requests.post, "sequence-metadatas", json_str=json_str)
-        return self._deserialize_response(response, SequenceMetadataData)
+        return self._deserialize_response(response, SequenceMetadataData)  # type: ignore[return-value]
 
     def save_sequence_result(self, sequence_result_definition: SequenceResultDefinition) -> SequenceResultData:
         # FIXME: We don't have information if the object was created or updated. Thus, server always responds 200 (OK).
@@ -478,20 +478,20 @@ class StationControlClient(_StationControlClientBase):
         response = self._send_request(
             requests.put, f"sequence-results/{sequence_result_definition.sequence_id}", json_str=json_str
         )
-        return self._deserialize_response(response, SequenceResultData)
+        return self._deserialize_response(response, SequenceResultData)  # type: ignore[return-value]
 
     def get_sequence_result(self, sequence_id: StrUUID) -> SequenceResultData:
         response = self._send_request(requests.get, f"sequence-results/{sequence_id}")
-        return self._deserialize_response(response, SequenceResultData)
+        return self._deserialize_response(response, SequenceResultData)  # type: ignore[return-value]
 
     @cache
     def get_static_quantum_architecture(self, dut_label: str) -> StaticQuantumArchitecture:
         response = self._send_request(requests.get, f"static-quantum-architectures/{dut_label}")
-        return self._deserialize_response(response, StaticQuantumArchitecture)
+        return self._deserialize_response(response, StaticQuantumArchitecture)  # type: ignore[return-value]
 
     def get_job(self, job_id: StrUUID) -> JobData:
         response = self._send_request(requests.get, f"jobs/{job_id}")
-        return self._deserialize_response(response, JobData)
+        return self._deserialize_response(response, JobData)  # type: ignore[return-value]
 
     def abort_job(self, job_id: StrUUID) -> None:
         self._send_request(requests.post, f"jobs/{job_id}/abort")
@@ -516,7 +516,7 @@ class StationControlClient(_StationControlClientBase):
         max_seen_position = 0
         while True:
             job = self._poll_job(job_id)
-            if job.job_status >= JobExecutorStatus.EXECUTION_STARTED:
+            if job.job_status >= JobExecutorStatus.EXECUTION_STARTED:  # type: ignore[operator]
                 if max_seen_position:
                     update_progress_callback([("Progress in queue", max_seen_position, max_seen_position)])
                 return job.job_status
@@ -525,8 +525,8 @@ class StationControlClient(_StationControlClientBase):
             if position == 0:
                 sleep(1)
                 continue
-            max_seen_position = max(max_seen_position, position)
-            update_progress_callback([("Progress in queue", max_seen_position - position, max_seen_position)])
+            max_seen_position = max(max_seen_position, position)  # type: ignore[type-var,assignment]
+            update_progress_callback([("Progress in queue", max_seen_position - position, max_seen_position)])  # type: ignore[operator]
             sleep(1)
 
     def _poll_job_status_until_terminal(
@@ -545,9 +545,9 @@ class StationControlClient(_StationControlClientBase):
     def _poll_job(self, job_id: str) -> JobData:
         response = self._send_request(requests.get, f"jobs/{job_id}")
         job = self._deserialize_response(response, JobData)
-        if job.job_status == JobExecutorStatus.FAILED:
-            raise InternalServerError(f"Job: {job.job_id}\n{job.job_error}")
-        return job
+        if job.job_status == JobExecutorStatus.FAILED:  # type: ignore[union-attr]
+            raise InternalServerError(f"Job: {job.job_id}\n{job.job_error}")  # type: ignore[union-attr]  # type: ignore[union-attr]
+        return job  # type: ignore[return-value]
 
     @staticmethod
     def _serialize_model(model: BaseModel) -> str:
@@ -612,22 +612,22 @@ class StationControlClient(_StationControlClientBase):
     @staticmethod
     def _deserialize_response(
         response: requests.Response,
-        model_class: type[TypePydanticBase | ListModel[list[TypePydanticBase]]],
+        model_class: type[TypePydanticBase | ListModel[list[TypePydanticBase]]],  # type: ignore[type-arg]
         *,
         list_with_meta: bool = False,
-    ) -> TypePydanticBase | ListWithMeta[TypePydanticBase]:
+    ) -> TypePydanticBase | ListWithMeta[TypePydanticBase]:  # type: ignore[type-arg]
         # 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)
+            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)
+            return ListWithMeta(model_class.model_validate(response_with_meta.items), meta=response_with_meta.meta)  # type: ignore[arg-type]
         model = model_class.model_validate_json(response.text)
-        return model
+        return model  # type: ignore[return-value]
 
 
 def _remove_empty_values(kwargs: dict[str, Any]) -> dict[str, Any]:

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/src/iqm/station_control/interface/models/jobs.py

@@ -46,51 +46,78 @@ class JobError(PydanticBase):
 
 
 class JobData(PydanticBase):
-    """Job response data model"""
+    """Status, artifacts and metadata of a job."""
 
     job_id: UUID
+    """Unique ID of the job."""
     job_status: JobExecutorStatus
+    """Current job status."""
     job_result: JobResult
+    """Progress information for the job."""  # FIXME why is it called JobResult? can it be None?
+    # job_result: The output of a progressing or a successful job. This includes progress indicators.
     job_error: JobError | None
+    """Error message(s) for a failed job."""
     position: int | None
+    """If the job is not completed, its position in the current queue.
+    1 means this task will be executed next. In other cases the value is 0."""
 
 
 @functools.total_ordering
 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
+    """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
     in at the appropriate place. See the :meth:`__lt__` implementation for further details.
     """
 
     # Received by the server
     RECEIVED = "received"
+    """The job has been received by the server."""
 
     # Validating the job
     VALIDATION_STARTED = "validation_started"
+    """The job is being validated."""
     VALIDATION_ENDED = "validation_ended"
+    """The job passed validation."""
 
     # Running PulLA
     FETCH_CALIBRATION_STARTED = "fetch_calibration_started"
+    """Calibration data for the job is being fetched."""
     FETCH_CALIBRATION_ENDED = "fetch_calibration_ended"
+    """Calibration data for the job has been fetched."""
     COMPILATION_STARTED = "compilation_started"
+    """The job is being compiled."""
     COMPILATION_ENDED = "compilation_ended"
+    """The job has been succesfully compiled."""
 
     # Executing sweep
     SAVE_SWEEP_METADATA_STARTED = "save_sweep_metadata_started"
+    """Metadata about the sweep is being stored to database."""
     SAVE_SWEEP_METADATA_ENDED = "save_sweep_metadata_ended"
+    """Metadata about the sweep has been stored to database."""
     PENDING_EXECUTION = "pending_execution"
+    """The job is ready for execution and is waiting for its turn in the queue."""
     EXECUTION_STARTED = "execution_started"
+    """The job has started executing on the instruments."""
     EXECUTION_ENDED = "execution_ended"
+    """The job has finished execution on the instruments."""
     POST_PROCESSING_PENDING = "post_processing_pending"
+    """The job has finished execution and is awaiting further processing."""
     POST_PROCESSING_STARTED = "post_processing_started"
+    """Execution artifacts are being constructed and persisted."""
     POST_PROCESSING_ENDED = "post_processing_ended"
+    """Execution artifacts have been constructed and persisted."""
+
     READY = "ready"
+    """The job has completed."""
 
     # Job failed, can happen at any stage
     FAILED = "failed"
+    """The job has failed. Error message(s) may be available."""
 
-    # Job aborted
     ABORTED = "aborted"
+    """The job has been aborted."""
 
     def __str__(self):
         return self.name.lower()
@@ -109,7 +136,7 @@ class JobExecutorStatus(Enum):
         return self.name == other.name
 
     def __lt__(self, other):
-        """Enable comparison according to definition order.
+        """Comparison according to definition order.
 
         :meta public:
 

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/src/iqm/station_control/interface/models/observation.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.
-"""Observation related station control interface models."""
+"""Observation related Station Control interface models."""
 
 from datetime import datetime
 from typing import Any
@@ -35,7 +35,7 @@ class ObservationBase(PydanticBase):
     uncertainty: Uncertainty | None = None
     """Uncertainty of the observation value. ``None`` means unknown."""
     invalid: bool = False
-    """Flag indicating if the object is invalid. Automated systems must not use invalid objects."""
+    """Flag indicating if the observation is invalid. Automated systems must not use invalid observations."""
 
 
 class ObservationDefinition(ObservationBase):
@@ -92,4 +92,4 @@ class ObservationUpdate(PydanticBase):
     observation_id: int
     """Unique identifier of the observation."""
     invalid: bool
-    """Flag indicating if the object is invalid. Automated systems must not use invalid objects."""
+    """Flag indicating if the observation is invalid. Automated systems must not use invalid observations."""

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/src/iqm/station_control/interface/models/observation_set.py

@@ -33,7 +33,7 @@ class ObservationSetBase(PydanticBase):
     describes_id: uuid.UUID | None = Field(default=None)
     """Unique identifier of the observation set this observation set describes."""
     invalid: bool = Field(default=False)
-    """Flag indicating if the object is invalid. Automated systems must not use invalid objects."""
+    """Flag indicating if the set is invalid. Automated systems must not use invalid sets."""
 
 
 class ObservationSetDefinition(ObservationSetBase):
@@ -71,10 +71,10 @@ class ObservationSetUpdate(PydanticBase):
     """Database IDs of the observations belonging to the observation set.
 
     This will only add new observations to the observation set, deleting existing ones is not possible.
-    Setting this to `None` or omitting it will leave existing observation_ids as is with no changes.
+    Setting this to ``None`` or omitting it will leave existing :attr:`observation_ids` as is with no changes.
     """
     invalid: bool
-    """Flag indicating if the object is invalid. Automated systems must not use invalid objects."""
+    """Flag indicating if the set is invalid. Automated systems must not use invalid sets."""
 
 
 class ObservationSetWithObservations(ObservationSetData):

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/src/iqm/station_control/interface/station_control.py

@@ -194,7 +194,7 @@ class StationControlInterface(ABC):
         """Get run data from the database."""
 
     @abstractmethod
-    def query_runs(self, **kwargs) -> ListWithMeta[RunLite]:
+    def query_runs(self, **kwargs) -> ListWithMeta[RunLite]:  # type: ignore[type-arg]
         """Query runs from the database.
 
         Runs are queried by the given query parameters. Currently supported query parameters:
@@ -228,7 +228,7 @@ class StationControlInterface(ABC):
     @abstractmethod
     def create_observations(
         self, observation_definitions: Sequence[ObservationDefinition]
-    ) -> ListWithMeta[ObservationData]:
+    ) -> ListWithMeta[ObservationData]:  # type: ignore[type-arg]
         """Create observations in the database.
 
         Args:
@@ -285,7 +285,7 @@ class StationControlInterface(ABC):
         """
 
     @abstractmethod
-    def query_observations(self, **kwargs) -> ListWithMeta[ObservationData]:
+    def query_observations(self, **kwargs) -> ListWithMeta[ObservationData]:  # type: ignore[type-arg]
         """Query observations from the database.
 
         Observations are queried by the given query parameters. Currently supported query parameters:
@@ -324,7 +324,7 @@ class StationControlInterface(ABC):
         """
 
     @abstractmethod
-    def query_observation_sets(self, **kwargs) -> ListWithMeta[ObservationSetData]:
+    def query_observation_sets(self, **kwargs) -> ListWithMeta[ObservationSetData]:  # type: ignore[type-arg]
         """Query observation sets from the database.
 
         Observation sets are queried by the given query parameters. Currently supported query parameters:
@@ -455,7 +455,7 @@ class StationControlInterface(ABC):
         """Get DUT fields for the specified DUT label from the database."""
 
     @abstractmethod
-    def query_sequence_metadatas(self, **kwargs) -> ListWithMeta[SequenceMetadataData]:
+    def query_sequence_metadatas(self, **kwargs) -> ListWithMeta[SequenceMetadataData]:  # type: ignore[type-arg]
         """Query sequence metadatas from the database.
 
         Sequence metadatas are queried by the given query parameters. Currently supported query parameters:

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.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.4.0
+Version: 9.6.0
 Summary: Python client for communicating with Station Control Service
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License
@@ -217,11 +217,14 @@ Requires-Dist: iqm-exa-common<27,>=26
 Requires-Dist: iqm-data-definitions<3.0,>=2.13
 Requires-Dist: opentelemetry-exporter-otlp==1.25.0
 Requires-Dist: protobuf<5.0,>=4.25.3
+Requires-Dist: types-protobuf
 Requires-Dist: grpcio<2.0,>=1.65.4
 Requires-Dist: pydantic<3.0,>=2.10.4
 Requires-Dist: PyYAML==6.0
 Requires-Dist: requests==2.32.3
+Requires-Dist: types-requests
 Requires-Dist: tqdm>=4.59.0
+Requires-Dist: types-tqdm
 
 Station control client library
 ==============================

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/src/iqm_station_control_client.egg-info/SOURCES.txt

@@ -20,6 +20,7 @@ requirements/base.in
 requirements/base.txt
 src/iqm/station_control/client/__init__.py
 src/iqm/station_control/client/list_models.py
+src/iqm/station_control/client/py.typed
 src/iqm/station_control/client/station_control.py
 src/iqm/station_control/client/utils.py
 src/iqm/station_control/client/iqm_server/__init__.py
@@ -55,6 +56,7 @@ src/iqm/station_control/client/serializers/sweep_serializers.py
 src/iqm/station_control/client/serializers/task_serializers.py
 src/iqm/station_control/interface/__init__.py
 src/iqm/station_control/interface/list_with_meta.py
+src/iqm/station_control/interface/py.typed
 src/iqm/station_control/interface/pydantic_base.py
 src/iqm/station_control/interface/station_control.py
 src/iqm/station_control/interface/models/__init__.py

{iqm_station_control_client-9.4.0 → iqm_station_control_client-9.6.0}/src/iqm_station_control_client.egg-info/requires.txt

@@ -2,8 +2,11 @@ iqm-exa-common<27,>=26
 iqm-data-definitions<3.0,>=2.13
 opentelemetry-exporter-otlp==1.25.0
 protobuf<5.0,>=4.25.3
+types-protobuf
 grpcio<2.0,>=1.65.4
 pydantic<3.0,>=2.10.4
 PyYAML==6.0
 requests==2.32.3
+types-requests
 tqdm>=4.59.0
+types-tqdm

iqm_station_control_client-9.6.0/version.txt

@@ -0,0 +1 @@
+9.6.0

iqm_station_control_client-9.4.0/version.txt

@@ -1 +0,0 @@
-9.4.0