iqm-exa-common 27.3.1__tar.gz → 27.4.1__tar.gz

{iqm_exa_common-27.3.1 → iqm_exa_common-27.4.1}/CHANGELOG.rst

@@ -1,11 +1,25 @@
-=========
-Changelog
-=========
+Version 27.4.1 (2025-12-02)
+===========================
+
+Bug fixes
+---------
+
+- Fix version ranges in python package dependencies.
 
-Version 27.3.1 (2025-10-27)
+Version 27.4.0 (2025-11-19)
 ===========================
 
-- Bump version for 4.3.1 release. No functional changes.
+Features
+--------
+
+- Add new error types ``PayloadTooLargeError`` and ``TooManyRequestsError`` used by IQMServer in REST API responses.
+- Add a shortcut ``Setting.sweep(values)`` to create a ``Sweep``.
+
+Bug fixes
+---------
+
+- When adding a DataArray with the name of an existing DataArray to a dataset using :func:``add_data_array``,
+  update the attributes of the DataArray itself.
 
 Version 27.3.0 (2025-10-06)
 ===========================
@@ -238,7 +252,7 @@ Version 26.10.0 (2025-04-07)
 Features
 --------
 
-- Fix package version in published docs footers, :issue:`SW-1392`. 
+- Fix package version in published docs footers, :issue:`SW-1392`.
 
 Version 26.9.0 (2025-04-03)
 ===========================

iqm_exa_common-27.4.1/MANIFEST.in

@@ -0,0 +1,4 @@
+include version.txt
+include LICENSE.txt
+prune tests/*
+exclude .gitlab-ci.yml

{iqm_exa_common-27.3.1/src/iqm_exa_common.egg-info → iqm_exa_common-27.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-exa-common
-Version: 27.3.1
+Version: 27.4.1
 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 → iqm_exa_common-27.4.1}/README.rst

@@ -3,7 +3,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.4.1/docs/changelog.rst

@@ -0,0 +1,8 @@
+.. _changelog:
+
+=========
+CHANGELOG
+=========
+
+.. include:: ../CHANGELOG.rst
+   :literal:

{iqm_exa_common-27.3.1 → iqm_exa_common-27.4.1}/pyproject.toml

@@ -1,4 +1,3 @@
-# This file is managed by monotool.py, do not edit by hand
 [build-system]
 build-backend = "setuptools.build_meta"
 requires = [ "setuptools", "setuptools_scm[toml]",]
@@ -18,7 +17,7 @@ email = "info@meetiqm.com"
 file = "LICENSE.txt"
 
 [project.urls]
-Documentation = "https://iqm-finland.github.io/docs/iqm-exa-common/"
+Documentation = "https://docs.meetiqm.com/iqm-exa-common/"
 Homepage = "https://pypi.org/project/iqm-exa-common/"
 
 [tool.mypy]
@@ -57,7 +56,7 @@ nb_diff_ignore = [ "/metadata/language_info", "/metadata/widgets", "/cells/*/exe
 
 [tool.ruff.lint]
 ignore = [ "D203", "D213",]
-select = [ "E4", "E7", "E9", "E5", "F", "Q", "PL", "I", "D", "UP007", "UP006", "UP035", "ANN001", "ANN201", "ANN202",]
+select = [ "E4", "E7", "E9", "E5", "F", "Q", "PL", "I", "D", "UP007", "UP006", "UP035", "ANN001", "ANN201", "ANN202", "NPY201",]
 unfixable = [ "F401",]
 
 [tool.ruff.lint.isort]
@@ -68,10 +67,10 @@ known-third-party = [ "exa", "iqm",]
 relative-imports-order = "closest-to-furthest"
 
 [tool.ruff.lint.per-file-ignores]
-"**/__init__.py" = [ "F401", "PLR0402",]
+"**/__init__.py" = [ "D104", "F401", "PLR0402",]
 "**/docs/*" = [ "E402", "D100",]
 "**/setup.py" = [ "D100", "D103", "I001", "ANN201",]
-"**/src/*" = [ "PLR2004", "D400", "D415", "D205", "D401", "D417", "D100", "D101", "D107", "D102", "D105", "D103", "D404", "D104",]
+"**/src/*" = [ "PLR2004", "D400", "D415", "D205", "D401", "D417", "D100", "D107", "D105", "D102", "D404",]
 "**/tests/*" = [ "F632", "PLR2004", "PLR0402", "PLC0414", "D", "ANN001", "ANN201", "ANN202",]
 
 [tool.ruff.lint.pylint]

{iqm_exa_common-27.3.1 → iqm_exa_common-27.4.1}/requirements/base.txt

@@ -9,4 +9,5 @@ ruamel-yaml==0.17.32
 ruamel-yaml-clib==0.2.8
 jinja2 == 3.0.3
 six==1.16.0
-types-six
+types-six
+

{iqm_exa_common-27.3.1 → iqm_exa_common-27.4.1}/src/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
 
 

iqm_exa_common-27.4.1/src/exa/common/control/sweep/sweep.py

@@ -0,0 +1,17 @@
+# Copyright 2024 IQM
+#
+# 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.
+
+"""Deprecated import path for :class:`.Sweep`."""
+
+from ...data.parameter import Sweep  # noqa: F401 # Reimport for backwards compatibility

{iqm_exa_common-27.3.1 → iqm_exa_common-27.4.1}/src/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}.")

{iqm_exa_common-27.3.1 → iqm_exa_common-27.4.1}/src/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)

{iqm_exa_common-27.3.1 → iqm_exa_common-27.4.1}/src/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

{iqm_exa_common-27.3.1 → iqm_exa_common-27.4.1}/src/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."

{iqm_exa_common-27.3.1 → iqm_exa_common-27.4.1}/src/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

{iqm_exa_common-27.3.1 → iqm_exa_common-27.4.1}/src/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

{iqm_exa_common-27.3.1 → iqm_exa_common-27.4.1}/src/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,))

{iqm_exa_common-27.3.1 → iqm_exa_common-27.4.1}/src/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

{iqm_exa_common-27.3.1 → iqm_exa_common-27.4.1}/src/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 → iqm_exa_common-27.4.1/src/iqm_exa_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-exa-common
-Version: 27.3.1
+Version: 27.4.1
 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 → iqm_exa_common-27.4.1}/src/iqm_exa_common.egg-info/SOURCES.txt

@@ -18,6 +18,7 @@ docs/_static/images/logo.png
 docs/_templates/autosummary-class-template.rst
 docs/_templates/autosummary-module-template.rst
 requirements/base.in
+requirements/base.in.internal
 requirements/base.txt
 src/exa/common/__init__.py
 src/exa/common/py.typed

iqm_exa_common-27.4.1/version.txt

@@ -0,0 +1 @@
+27.4.1

iqm_exa_common-27.3.1/MANIFEST.in

@@ -1,10 +0,0 @@
-include CHANGELOG.rst
-include version.txt
-prune changelog/
-prune tests/*
-exclude docbuild
-exclude format
-exclude lint
-exclude sub-pyproject.toml
-exclude test
-exclude .gitlab-ci.yml

iqm_exa_common-27.3.1/docs/changelog.rst

@@ -1,2 +0,0 @@
-.. _changes:
-.. include:: ../CHANGELOG.rst

iqm_exa_common-27.3.1/src/exa/common/control/sweep/sweep.py

@@ -1,54 +0,0 @@
-# Copyright 2024 IQM
-#
-# 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.
-
-"""Base immutable class for sweeps specifications."""
-
-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}.")

iqm_exa_common-27.3.1/version.txt

@@ -1 +0,0 @@
-27.3.1