iqm-exa-common 26.6__tar.gz → 26.8__tar.gz

{iqm_exa_common-26.6 → iqm_exa_common-26.8}/CHANGELOG.rst

@@ -2,6 +2,22 @@
 Changelog
 =========
 
+Version 26.8 (2025-04-02)
+=========================
+
+Features
+********
+
+- Update the documentation footer to display the package version.
+
+Version 26.7 (2025-04-01)
+=========================
+
+Features
+--------
+
+- Use standard process of deprecation. No functional changes. :issue:`SW-450`
+
 Version 26.6 (2025-03-21)
 =========================
 

{iqm_exa_common-26.6/src/iqm_exa_common.egg-info → iqm_exa_common-26.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-exa-common
-Version: 26.6
+Version: 26.8
 Summary: Framework for control and measurement of superconducting qubits: common library
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License

{iqm_exa_common-26.6 → iqm_exa_common-26.8}/docs/conf.py

@@ -45,7 +45,6 @@ master_doc = "index"
 
 # General information about the project.
 project = "exa-common"
-copyright = "2019-2022, IQM Finland Oy"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -61,6 +60,8 @@ except ImportError:
 else:
     version = parse(release).base_version
 
+copyright = "2019-2025, IQM Finland Oy, Release {}".format(release)
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 # language = None

{iqm_exa_common-26.6 → iqm_exa_common-26.8}/src/exa/common/control/sweep/exponential_sweep.py

@@ -15,14 +15,17 @@
 """Sweep specification with exponentially spaced values."""
 
 from typing import Any
-import warnings
+
+from typing_extensions import deprecated
 
 from exa.common.control.sweep.option import CenterSpanBaseOptions, StartStopBaseOptions
 from exa.common.control.sweep.sweep import Sweep
 from exa.common.data.parameter import Parameter
 from exa.common.errors.exa_error import InvalidSweepOptionsTypeError
+from exa.common.helpers.deprecation import format_deprecated
 
 
+@deprecated(format_deprecated(old="`ExponentialSweep`", new="`Sweep`", since="28.3.2025"))
 class ExponentialSweep(Sweep):
     """Generates parameter values spaced evenly on a geometric progression based on `options`.
 
@@ -45,7 +48,6 @@ class ExponentialSweep(Sweep):
         data: list[Any] | None = None,
         **kwargs,
     ) -> None:
-        warnings.warn("ExponentialSweep is deprecated, use Sweep instead.", DeprecationWarning)
         if options and not isinstance(options, StartStopBaseOptions | CenterSpanBaseOptions):
             raise InvalidSweepOptionsTypeError(str(type(options)))
         super().__init__(parameter, options, data=data, **kwargs)

{iqm_exa_common-26.6 → iqm_exa_common-26.8}/src/exa/common/control/sweep/fixed_sweep.py

@@ -15,21 +15,23 @@
 """Sweep specification with arbitrary values."""
 
 from typing import Any
-import warnings
+
+from typing_extensions import deprecated
 
 from exa.common.control.sweep.option import FixedOptions
 from exa.common.control.sweep.sweep import Sweep
 from exa.common.data.parameter import Parameter
 from exa.common.errors.exa_error import InvalidSweepOptionsTypeError
+from exa.common.helpers.deprecation import format_deprecated
 
 
+@deprecated(format_deprecated(old="`FixedSweep`", new="`Sweep`", since="28.3.2025"))
 class FixedSweep(Sweep):
     """A sweep over arbitrary set of values, given by `options`."""
 
     def __init__(
         self, parameter: Parameter, options: FixedOptions | None = None, *, data: list[Any] | None = None, **kwargs
     ) -> None:
-        warnings.warn("FixedSweep is deprecated, use Sweep instead.", DeprecationWarning)
         if options and not isinstance(options, FixedOptions):
             raise InvalidSweepOptionsTypeError(str(type(options)))
         super().__init__(parameter, options, data=data, **kwargs)

{iqm_exa_common-26.6 → iqm_exa_common-26.8}/src/exa/common/control/sweep/linear_sweep.py

@@ -15,14 +15,17 @@
 """Sweep specification with linearly spaced values."""
 
 from typing import Any
-import warnings
+
+from typing_extensions import deprecated
 
 from exa.common.control.sweep.option import CenterSpanOptions, StartStopOptions
 from exa.common.control.sweep.sweep import Sweep
 from exa.common.data.parameter import Parameter
 from exa.common.errors.exa_error import InvalidSweepOptionsTypeError
+from exa.common.helpers.deprecation import format_deprecated
 
 
+@deprecated(format_deprecated(old="`LinearSweep`", new="`Sweep`", since="28.3.2025"))
 class LinearSweep(Sweep):
     """Generates evenly spaced parameter values based on `options`.
 
@@ -43,7 +46,6 @@ class LinearSweep(Sweep):
         data: list[Any] | None = None,
         **kwargs,
     ) -> None:
-        warnings.warn("LinearSweep is deprecated, use Sweep instead.", DeprecationWarning)
         if options and not isinstance(options, StartStopOptions | CenterSpanOptions):
             raise InvalidSweepOptionsTypeError(str(type(options)))
         super().__init__(parameter, options, data=data, **kwargs)

{iqm_exa_common-26.6 → iqm_exa_common-26.8}/src/exa/common/data/base_model.py

@@ -2,6 +2,9 @@ from typing import Any, Self
 
 import pydantic
 from pydantic import ConfigDict
+from typing_extensions import deprecated
+
+from exa.common.helpers.deprecation import format_deprecated
 
 
 class BaseModel(pydantic.BaseModel):
@@ -28,10 +31,7 @@ class BaseModel(pydantic.BaseModel):
         """
         return super().model_copy(update=update, deep=deep)
 
+    @deprecated(format_deprecated(old="`copy` method", new="`model_copy`", since="28.3.2025"))
     def copy(self, **kwargs) -> Self:
-        """Returns a copy of the model.
-
-        DEPRECATED: Use model_copy(update: dict[str, Any], deep: bool) instead.
-        """
-        # Call deprecated copy() here deliberately to trigger deprecation warning from Pydantic.
+        """Returns a copy of the model."""
         return super().copy(update=kwargs, deep=True)

{iqm_exa_common-26.6 → iqm_exa_common-26.8}/src/exa/common/data/parameter.py

@@ -209,7 +209,7 @@ class Parameter(BaseModel):
             label = name
         if data_type == DataType.NUMBER:
             warnings.warn(
-                "data_type 'DataType.NUMBER' is deprecated, using 'DataType.FLOAT' instead.",
+                "data_type 'DataType.NUMBER' is deprecated, use 'DataType.FLOAT' instead.",
                 DeprecationWarning,
             )
             # Consider DataType.NUMBER as a deprecated alias for DataType.FLOAT

{iqm_exa_common-26.6 → iqm_exa_common-26.8}/src/exa/common/errors/exa_error.py

@@ -1,4 +1,6 @@
-import warnings
+from typing_extensions import deprecated
+
+from exa.common.helpers.deprecation import format_deprecated
 
 
 class ExaError(Exception):
@@ -25,9 +27,9 @@ class EmptyComponentListError(ExaError, ValueError):
     """Error raised when an empty list is given as components for running an experiment."""
 
 
+@deprecated(format_deprecated(old="`InvalidSweepOptionsTypeError`", new="`Sweep.data`", since="28.3.2025"))
 class InvalidSweepOptionsTypeError(ExaError, TypeError):
     """The type of sweep options is invalid."""
 
     def __init__(self, options: str, *args):
-        warnings.warn("InvalidSweepOptionsTypeError is deprecated.", DeprecationWarning)
         super().__init__(f"Options have unsupported type of {options}", *args)

iqm_exa_common-26.8/src/exa/common/helpers/deprecation.py

@@ -0,0 +1,12 @@
+from datetime import datetime
+from typing import LiteralString
+
+
+def format_deprecated(old: str, new: str | None, since: str) -> LiteralString:
+    datetime.strptime(since, "%d.%m.%Y")
+    message: str = (
+        f"{old} is deprecated since {since}, it can be be removed from the codebase in the next major release."
+    )
+    if new:
+        message += f" Use {new} instead."
+    return message

{iqm_exa_common-26.6 → iqm_exa_common-26.8/src/iqm_exa_common.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-exa-common
-Version: 26.6
+Version: 26.8
 Summary: Framework for control and measurement of superconducting qubits: common library
 Author-email: IQM Finland Oy <info@meetiqm.com>
 License:                                  Apache License

{iqm_exa_common-26.6 → iqm_exa_common-26.8}/src/iqm_exa_common.egg-info/SOURCES.txt

@@ -55,6 +55,7 @@ src/exa/common/errors/exa_error.py
 src/exa/common/errors/server_errors.py
 src/exa/common/helpers/__init__.py
 src/exa/common/helpers/data_helper.py
+src/exa/common/helpers/deprecation.py
 src/exa/common/helpers/json_helper.py
 src/exa/common/helpers/numpy_helper.py
 src/exa/common/helpers/software_version_helper.py

iqm_exa_common-26.8/version.txt

@@ -0,0 +1 @@
+26.8

iqm_exa_common-26.6/version.txt

@@ -1 +0,0 @@
-26.6