iqm-exa-common 27.3.1__py3-none-any.whl → 27.4.0__py3-none-any.whl

exa/common/api/proto_serialization/nd_sweep.py

@@ -20,8 +20,7 @@ from iqm.data_definitions.common.v1.sweep_pb2 import SingleParameterSweep as spb
 
 from exa.common.api.proto_serialization import sequence
 import exa.common.api.proto_serialization._parameter as param_proto
-from exa.common.control.sweep.sweep import Sweep
-from exa.common.data.parameter import DataType, Parameter
+from exa.common.data.parameter import DataType, Parameter, Sweep
 from exa.common.sweep.util import NdSweep
 
 

exa/common/control/sweep/sweep.py

@@ -12,43 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Base immutable class for sweeps specifications."""
+"""Deprecated import path for :class:`.Sweep`."""
 
-from typing import Any
-
-from exa.common.control.sweep.option import CenterSpanOptions, StartStopOptions
-from exa.common.control.sweep.sweep_values import SweepValues
-from exa.common.data.base_model import BaseModel
-from exa.common.data.parameter import Parameter
-
-
-class Sweep(BaseModel):
-    """Base immutable class for sweeps."""
-
-    parameter: Parameter
-    """The Sweep represents changing the values of this Parameter."""
-
-    data: SweepValues
-    """List of values for :attr:`parameter`"""
-
-    def model_post_init(self, __context: Any) -> None:
-        if not all(self.parameter.validate(value) for value in self.data):
-            raise ValueError(f"Invalid range data {self.data} for parameter type {self.parameter.data_type}.")
-
-    @classmethod
-    def __from_center_span(cls, parameter: Parameter, options: CenterSpanOptions) -> SweepValues:
-        cls._validate_value(parameter, options.center, "center")
-        cls._validate_value(parameter, options.span, "span")
-        return options.data
-
-    @classmethod
-    def __from_start_stop(cls, parameter: Parameter, options: StartStopOptions) -> SweepValues:
-        cls._validate_value(parameter, options.start, "start")
-        cls._validate_value(parameter, options.stop, "stop")
-        cls._validate_value(parameter, options.step, "step")  # type: ignore[arg-type]
-        return options.data
-
-    @staticmethod
-    def _validate_value(parameter: Parameter, value: complex | str | bool, value_label: str) -> None:
-        if not parameter.validate(value):
-            raise ValueError(f"Invalid {value_label} value {value} for parameter type {parameter.data_type}.")
+from ...data.parameter import Sweep  # noqa: F401 # Reimport for backwards compatibility

exa/common/data/parameter.py

@@ -600,3 +600,29 @@ class Setting(BaseModel):
     def with_path_name(self) -> Setting:
         """Copy of self with the parameter name replaced by the path name."""
         return self.model_copy(update={"parameter": self.parameter.model_copy(update={"name": self.path})})
+
+    def sweep(self, values: SweepValues) -> Sweep:
+        """Create a Sweep object that represents a 1d scan of this setting over the given values.
+
+        Args:
+            values: Sweep values.
+
+        Returns:
+            The Sweep object.
+
+        """
+        return Sweep(parameter=self.parameter, data=values)
+
+
+class Sweep(BaseModel):
+    """Base immutable class for sweeps."""
+
+    parameter: Parameter
+    """The Sweep represents changing the values of this Parameter."""
+
+    data: SweepValues
+    """List of values for :attr:`parameter`"""
+
+    def model_post_init(self, __context: Any) -> None:
+        if not all(self.parameter.validate(value) for value in self.data):
+            raise ValueError(f"Invalid range data {self.data} for parameter type {self.parameter.data_type}.")

exa/common/errors/station_control_errors.py

@@ -64,10 +64,18 @@ class ConflictError(StationControlError):
     """
 
 
+class PayloadTooLargeError(StationControlError):
+    """This error happens when the request payload is too large."""
+
+
 class ValidationError(StationControlError):
     """Error raised when something is unprocessable in general, for example if the input value is not acceptable."""
 
 
+class TooManyRequestsError(StationControlError):
+    """Error raised when the user has sent too many requests in a given amount of time ("rate limiting")."""
+
+
 class InternalServerError(StationControlError):
     """Error raised when an unexpected error happened on the server side.
 
@@ -94,7 +102,9 @@ _ERROR_TO_STATUS_CODE_MAPPING = {
     ForbiddenError: HTTPStatus.FORBIDDEN,  # 403
     NotFoundError: HTTPStatus.NOT_FOUND,  # 404
     ConflictError: HTTPStatus.CONFLICT,  # 409
+    PayloadTooLargeError: HTTPStatus.REQUEST_ENTITY_TOO_LARGE,  # 413
     ValidationError: HTTPStatus.UNPROCESSABLE_ENTITY,  # 422
+    TooManyRequestsError: HTTPStatus.TOO_MANY_REQUESTS,  # 429
     InternalServerError: HTTPStatus.INTERNAL_SERVER_ERROR,  # 500
     BadGatewayError: HTTPStatus.BAD_GATEWAY,  # 502
     ServiceUnavailableError: HTTPStatus.SERVICE_UNAVAILABLE,  # 503
@@ -115,6 +125,8 @@ def map_from_error_to_status_code(error: StationControlError) -> HTTPStatus:
     return HTTPStatus.INTERNAL_SERVER_ERROR
 
 
-def map_from_status_code_to_error(status_code: HTTPStatus) -> type[StationControlError]:
+def map_from_status_code_to_error(status_code: HTTPStatus | int) -> type[StationControlError]:
     """Map an HTTPStatus code to a StationControlError."""
+    if isinstance(status_code, int):
+        status_code = HTTPStatus(status_code)
     return _STATUS_CODE_TO_ERROR_MAPPING.get(status_code, InternalServerError)

exa/common/helpers/data_helper.py

@@ -24,7 +24,7 @@ import xarray as xr
 def add_data_array(ds: xr.Dataset, da: xr.DataArray, name: Hashable | None = None) -> xr.Dataset:
     """Add data array `da` to dataset `ds`.
 
-    Unlike the default xarray command, preserves metadata of the dataset.
+    Unlike the default xarray command, preserves metadata of the coordinates.
 
     Args:
         ds: Dataset to add to.
@@ -44,16 +44,11 @@ def add_data_array(ds: xr.Dataset, da: xr.DataArray, name: Hashable | None = Non
     # Attributes of Dataset coordinates are dropped/replaced when adding a DataArray
     # https://github.com/pydata/xarray/issues/2245
     # So we need to temporarily store all coord attrs, and then add them back
-    attributes = {}
-    for key in ds.coords:
-        attributes[key] = ds.coords[key].attrs
-    for key in ds.data_vars:
-        attributes[key] = ds.data_vars[key].attrs
+    attributes = {key: value.attrs for key, value in ds.coords.items()}
+
     ds[name] = da
     for key in ds.coords:
         if attributes.get(key):
             ds.coords[key].attrs = attributes.get(key)  # type:ignore[assignment]
-    for key in ds.data_vars:
-        if attributes.get(key):
-            ds.data_vars[key].attrs = attributes[key]
+
     return ds

exa/common/helpers/deprecation.py

@@ -11,7 +11,7 @@ def _assert_iso_8601_format(since: str) -> None:
         raise ValueError("Invalid date format. Use 'YYYY-MM-DD'.")
 
 
-def format_deprecated(old: str, new: str | None, since: str) -> LiteralString:
+def format_deprecated(old: str, new: str | None, since: str) -> LiteralString:  # noqa: D103
     _assert_iso_8601_format(since)
     message: str = (
         f"{old} is deprecated since {since}, it can be be removed from the codebase in the next major release."

exa/common/qcm_data/chad_model.py

@@ -28,7 +28,7 @@ def _natural_sort_key(name: str) -> tuple[int | str | Any, ...]:
     return tuple(int(item) if item.isdigit() else item.lower() for item in re.split(r"(\d+)", name))
 
 
-class Component(ImmutableBaseModel):
+class Component(ImmutableBaseModel):  # noqa: D101
     name: str
     connections: tuple[str, ...] = ()
 
@@ -41,28 +41,28 @@ class Component(ImmutableBaseModel):
         return tuple(sorted(connections, key=_natural_sort_key))
 
 
-class Qubit(Component):
+class Qubit(Component):  # noqa: D101
     pass
 
 
-class Coupler(Component):
+class Coupler(Component):  # noqa: D101
     pass
 
 
-class ProbeLine(Component):
+class ProbeLine(Component):  # noqa: D101
     pass
 
 
-class Launcher(Component):
+class Launcher(Component):  # noqa: D101
     pin: str
     function: str
 
 
-class ComputationalResonator(Component):
+class ComputationalResonator(Component):  # noqa: D101
     pass
 
 
-class Components(ImmutableBaseModel):
+class Components(ImmutableBaseModel):  # noqa: D101
     # Alias list of components to plurals rather than singulars to follow normal naming conventions
     qubits: tuple[Qubit, ...] = Field((), alias="qubit")
     couplers: tuple[Coupler, ...] = Field((), alias="tunable_coupler")
@@ -83,7 +83,7 @@ class Components(ImmutableBaseModel):
         return {component.name: component for component in components}
 
 
-class CHAD(ImmutableBaseModel):
+class CHAD(ImmutableBaseModel):  # noqa: D101
     mask_set_name: str
     variant: str
     components: Components

exa/common/qcm_data/file_adapter.py

@@ -25,7 +25,7 @@ from requests.adapters import BaseAdapter
 from six import BytesIO
 
 
-class FileAdapter(BaseAdapter):
+class FileAdapter(BaseAdapter):  # noqa: D101
     def __init__(self, set_content_length=True):  # noqa: ANN001
         super(FileAdapter, self).__init__()
         self._set_content_length = set_content_length

exa/common/qcm_data/immutable_base_model.py

@@ -18,7 +18,7 @@ from pydantic import BaseModel, ConfigDict
 
 
 # Change the behaviour of pydantic globally
-class ImmutableBaseModel(BaseModel):
+class ImmutableBaseModel(BaseModel):  # noqa: D101
     # Unable to use cached_property
     # https://github.com/pydantic/pydantic/issues/1241
     model_config = ConfigDict(frozen=True, ignored_types=(cached_property,))

exa/common/sweep/database_serialization.py

@@ -20,8 +20,7 @@ serializing and deserializing sweep arguments before saving them to database.
 import json
 from typing import Any, cast
 
-from exa.common.control.sweep.sweep import Sweep
-from exa.common.data.parameter import Parameter
+from exa.common.data.parameter import Parameter, Sweep
 from exa.common.data.setting_node import SettingNode
 from exa.common.helpers import json_helper
 from exa.common.helpers.json_helper import decode_json, get_json_encoder

exa/common/sweep/util.py

@@ -17,8 +17,7 @@ user-friendly format to canonic ones.
 """
 
 from exa.common.control.sweep.option import StartStopOptions
-from exa.common.control.sweep.sweep import Sweep
-from exa.common.data.parameter import Parameter
+from exa.common.data.parameter import Parameter, Sweep
 
 # One sweep where many sweeps are executed together, like a zip. Type hint alias.
 ParallelSweep = tuple[Sweep, ...]

{iqm_exa_common-27.3.1.dist-info → iqm_exa_common-27.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-exa-common
-Version: 27.3.1
+Version: 27.4.0
 Summary: Framework for control and measurement of superconducting qubits: common library
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License: Apache License
@@ -204,7 +204,7 @@ License: Apache License
            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.
-Project-URL: Documentation, https://iqm-finland.github.io/docs/iqm-exa-common/
+Project-URL: Documentation, https://docs.meetiqm.com/iqm-exa-common/
 Project-URL: Homepage, https://pypi.org/project/iqm-exa-common/
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python :: 3 :: Only
@@ -231,7 +231,7 @@ EXA-common
 
 A Python-based project with abstract interfaces, helpers, etc. that are used both in backend and experiment layers.
 
-See `API documentation <https://iqm-finland.github.io/docs/iqm-exa-common/>`_.
+See `API documentation <https://docs.meetiqm.com/iqm-exa-common/>`_.
 
 Copyright
 ---------

{iqm_exa_common-27.3.1.dist-info → iqm_exa_common-27.4.0.dist-info}/RECORD

@@ -5,12 +5,12 @@ exa/common/api/proto_serialization/__init__.py,sha256=Vn2C79OqovFu5wJus9EHsMtK3O
 exa/common/api/proto_serialization/_parameter.py,sha256=d_LHc_Tl3OqiQmTGe6Y6mkHvQkknzFl5KPEJauPEKPM,3050
 exa/common/api/proto_serialization/array.py,sha256=CvuOV5jNyFAAdqrYsh_z4DeQA6kYvfidW9bEv_M7Ugo,3127
 exa/common/api/proto_serialization/datum.py,sha256=x9PJi3iiqAcG7aMUhBaho6vTNBQsm7pzY0HCFxB_zfM,4915
-exa/common/api/proto_serialization/nd_sweep.py,sha256=5Wi_iz4XqQE9GgSzt3vUTpYKwO5uCPGBa2OqwOMOXcQ,2912
+exa/common/api/proto_serialization/nd_sweep.py,sha256=mquxmfQ-VG2wbsHqoRtnxOc75bUhwxVeBKVAAhNmcow,2870
 exa/common/api/proto_serialization/sequence.py,sha256=4yQgdTUenbsY8yNu7JqSQSq2Ushd1zlzuciaqmyP7OY,2568
 exa/common/api/proto_serialization/setting_node.py,sha256=oAlJOmkQTmMSd6wpofoDLz3YIlkiqxX7kY84WnZZ4b4,4073
 exa/common/control/__init__.py,sha256=00T_xV0lL20QZcEt__vWq81N1oGF0KpJMhTitfAI4VI,629
 exa/common/control/sweep/__init__.py,sha256=GzKoQdQsLutcHhmrLPyPrW1n7Cpg766p3OWDHlRpuTs,607
-exa/common/control/sweep/sweep.py,sha256=7iaW_8baA0vZZjR7s6P1jkkG-B5Ncjez25xyExbKlf4,2260
+exa/common/control/sweep/sweep.py,sha256=K_7qzzOtlRqzYb7IIJ-clbMTAhSW-bmXmRfXNUWzOMs,708
 exa/common/control/sweep/sweep_values.py,sha256=c868qpnh3SP6DYN3eAt0SLaePuzzQwxTWYwnQwL4A-I,2277
 exa/common/control/sweep/option/__init__.py,sha256=Z01JS0FpchMvR8zfWBCs3jcPjh2H8X29YkN0SFxWLTY,906
 exa/common/control/sweep/option/center_span_base_options.py,sha256=uHWt4euQVF7EVXJid8wnIXo8PtJnyUdydxxAXPEMnV4,2558
@@ -23,16 +23,16 @@ exa/common/control/sweep/option/start_stop_options.py,sha256=vJottC6QX80MhVyg9_R
 exa/common/control/sweep/option/sweep_options.py,sha256=BhKB7RHP0VXJ9iUQKVzeQOM4j_x9AsMhRJgoR3gkiaY,933
 exa/common/data/__init__.py,sha256=F5SRe5QHBTjef4XJVQ63kO5Oxc_AiZnPbV560i7La0Y,644
 exa/common/data/base_model.py,sha256=foW3gtxoBtHfkDOjZPS7Eo1lcVKZwsDtyn-_0B7WnR8,1836
-exa/common/data/parameter.py,sha256=4CtvR6u5XT-5TJb_bTe9DYvBhOCNMlvOMepeGgr80FA,24500
+exa/common/data/parameter.py,sha256=nf5kiGxh0JBdAi1YNJe3dmer09u99ICXKBLkmDYblZ0,25297
 exa/common/data/setting_node.py,sha256=rTXo-D9v42L8HkJoNoCMtm8cyUEuNtpYGhHfi45ZPhA,44782
 exa/common/data/settingnode_v2.html.jinja2,sha256=mo-rlLLmU-Xxf6znJAisispAZK8sbV-2C13byKAtj_Q,3166
 exa/common/data/value.py,sha256=mtMws5UPGx1pCADK6Q2Tx4BwCXznvVRSNQRfcQ3NMmY,1853
 exa/common/errors/__init__.py,sha256=ArMBdpmx1EUenBpzrSNG63kmUf7PM0gCqSYnaCnL9Qk,597
 exa/common/errors/exa_error.py,sha256=wFfJbdeGs15XVF0VJvXPEjNavC2hXVJjchFcLfCfAiw,560
-exa/common/errors/station_control_errors.py,sha256=s0LimSOthQF8NWKyW556p-9vEapOxtn_W5ZiZVPTv_g,4489
+exa/common/errors/station_control_errors.py,sha256=_dI4rD7WZ7As2Kiz8GtjBmkWP8KWTkCcPYwLocmydsE,4990
 exa/common/helpers/__init__.py,sha256=IgtVD3tojIFA4MTV2mT5uYM6jb2qny9kBIIhEZT2PuI,610
-exa/common/helpers/data_helper.py,sha256=-AP0vwrf7WgyumLsicDtNP2VP5rhG4_oiOZgG4alNb4,2001
-exa/common/helpers/deprecation.py,sha256=n9_9Ii8UVW0dry7mvH_DOpSOwGQpbgw48EvhtLcgUc0,710
+exa/common/helpers/data_helper.py,sha256=1HP4EGt8lpzLY8kSdDk9FjQdLaKmY3THalgpNtr2exc,1792
+exa/common/helpers/deprecation.py,sha256=EUAHUiQZhvoI7zDAZICYQXVCUAWQ4wBWCnEBBAQ8pHs,724
 exa/common/helpers/json_helper.py,sha256=LoTrL6FREML1o0X3Zznf1baI4kn0kh03NE1nqBHgYss,2699
 exa/common/helpers/numpy_helper.py,sha256=KKKyZ_fD0O1gn7_InEQROYnX3WGMA6C1qHh8KzzjtUI,1062
 exa/common/helpers/software_version_helper.py,sha256=q7SVw7dSFBZIJQGwEpAR3rAFDlrC_s48-bM3Tqu5CQ0,5428
@@ -40,17 +40,17 @@ exa/common/helpers/yaml_helper.py,sha256=wLy-7Nyit597FoWBemduUilYP2VCk_aDDT8y62i
 exa/common/logger/__init__.py,sha256=1bIsGxHzfujXlkgtcAnWToKMkw3dpU5PEd_7LE_NpgQ,686
 exa/common/logger/logger.py,sha256=TA9HxFZDyFB7ai8C6mCZOm1cx3JMRAhB8DcMCwDAKt0,5713
 exa/common/qcm_data/__init__.py,sha256=VtsYkGoaniSjCkY0oQlqkcYJCtmC2sTDxfrIe_kpqZg,567
-exa/common/qcm_data/chad_model.py,sha256=1vWpB8gsrnIEDqEOqqQAXrofN2jM6c8AypZvOSH5I18,11279
+exa/common/qcm_data/chad_model.py,sha256=kk5j_ij1XL87o5ZggpuIP9jUxAqeZB8kTZuoVoFaL6w,11391
 exa/common/qcm_data/chip_layout.py,sha256=jDEMsujltH_KqLjj2Ja-XEEJubfsMg_HPlqnC4-L9YE,4555
 exa/common/qcm_data/chip_topology.py,sha256=cQTxuIouQ3yGSfMNbKzu76vERQGlK_TguhkJYN_ehB0,20075
-exa/common/qcm_data/file_adapter.py,sha256=VAvyV4FrCE93bvy7YP2DDlS_cgHQe-uwPdMQwMlZveQ,2319
-exa/common/qcm_data/immutable_base_model.py,sha256=QXmKIWQbsbWQvovXwKT1d9jtyf2LNJtjQquIwO52zOU,901
+exa/common/qcm_data/file_adapter.py,sha256=EvGXs5c2EWj0F-OUU0mu9vMUMXtyHJJC7RmkPyXSupw,2333
+exa/common/qcm_data/immutable_base_model.py,sha256=Mhz1nzxtx3c2KHs-HowGvh83rswz2oCm4MPQr9p6BvI,915
 exa/common/qcm_data/qcm_data_client.py,sha256=Rze6yQd0xUeH6eUMv3wduYbiDCTP3C4WECtCe7ONmyc,6061
 exa/common/sweep/__init__.py,sha256=uEKk5AtzSgSnf8Y0geRPwUpqXIBIXpeCxsN64sX7F1o,591
-exa/common/sweep/database_serialization.py,sha256=9n96OqmEnjy1x2F1HwaNOQgwX_39HjLtE9EUoetSw0E,7493
-exa/common/sweep/util.py,sha256=-QE2AaH-WDkYAVH5-Z-30leLgY0x4efmby4kc1JTCgY,3732
-iqm_exa_common-27.3.1.dist-info/LICENSE.txt,sha256=R6Q7eUrLyoCQgWYorQ8WJmVmWKYU3dxA3jYUp0wwQAw,11332
-iqm_exa_common-27.3.1.dist-info/METADATA,sha256=MuX5ZtCxb1efqRQSTH-LZKzOm5lkxBOKwyfdLQeBca4,14741
-iqm_exa_common-27.3.1.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
-iqm_exa_common-27.3.1.dist-info/top_level.txt,sha256=Clphg2toaZ3_jSFRPhjMNEmLurkMNMc4lkK2EFYsSlM,4
-iqm_exa_common-27.3.1.dist-info/RECORD,,
+exa/common/sweep/database_serialization.py,sha256=ZcvKpg5dREc8ynxp4alD4vdIwMsDOe2X5piavRWMtTU,7451
+exa/common/sweep/util.py,sha256=brUD6uDpQBCT0MMg5LdQj-ADWcJnaK3oZTiDzJbGHoc,3690
+iqm_exa_common-27.4.0.dist-info/LICENSE.txt,sha256=R6Q7eUrLyoCQgWYorQ8WJmVmWKYU3dxA3jYUp0wwQAw,11332
+iqm_exa_common-27.4.0.dist-info/METADATA,sha256=nc5ka-UkscDjNj6uXot2rN_pEJvwFroaisXgxDnHjUQ,14721
+iqm_exa_common-27.4.0.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
+iqm_exa_common-27.4.0.dist-info/top_level.txt,sha256=Clphg2toaZ3_jSFRPhjMNEmLurkMNMc4lkK2EFYsSlM,4
+iqm_exa_common-27.4.0.dist-info/RECORD,,