iqm-exa-common 26.26.0__py3-none-any.whl → 26.27.0__py3-none-any.whl

exa/common/data/parameter.py

@@ -61,7 +61,7 @@ import ast
 from collections.abc import Hashable
 import copy
 from enum import IntEnum
-from typing import Any, Self
+from typing import Any, Self, TypeAlias
 import warnings
 
 import numpy as np
@@ -73,7 +73,9 @@ from exa.common.data.base_model import BaseModel
 from exa.common.data.value import ObservationValue
 from exa.common.errors.station_control_errors import ValidationError
 
-CastType = str | list["CastType"] | None
+CastType: TypeAlias = str | list["CastType"] | None
+SourceType: TypeAlias = None | BaseModel | dict[str, Any]
+"""Type for Setting sources."""
 
 
 class DataType(IntEnum):
@@ -135,7 +137,7 @@ class DataType(IntEnum):
             raise TypeError("Boolean data types can only be 'false', 'true, '0' or '1' (case-insensitive)")
         elif self is DataType.STRING:
             return value
-        else:
+        else:  # TODO: can this be removed?
             try:
                 return ast.literal_eval(value)
             except (SyntaxError, ValueError):  # if the value can not be evaluated, return the original value
@@ -407,12 +409,19 @@ class Setting(BaseModel):
     path: str = ""
     """Path in the settings tree (starting from the root ``SettingNode``) for this setting."""
 
+    _source: SourceType = None
+    """The source for this Setting value. May contain an observation (ObservationDefinition or ObservationData)
+    or a source-dict (e.g. ``{"type": "configuration_source", "configurator": "defaults_from_yml"}``). By default,
+    ``None``, which denotes the source not being specified (e.g. hardcoded defaults). The source is stored in a private
+    attribute and thus is never serialized (the source field can contain non-serializable data such as Callables)."""
+
     def __init__(
         self,
         parameter: Parameter | None = None,
         value: ObservationValue | None = None,
         read_only: bool = False,
         path: str = "",
+        source: SourceType = None,
         **kwargs,
     ) -> None:
         super().__init__(
@@ -422,6 +431,7 @@ class Setting(BaseModel):
             path=path,
             **kwargs,
         )
+        self._source = source
 
     @model_validator(mode="after")
     def validate_parameter_value_after(self) -> Self:
@@ -435,8 +445,17 @@ class Setting(BaseModel):
             raise ValidationError(f"Invalid value '{self.value}' for parameter '{self.parameter}'.")
         return self
 
-    def update(self, value: ObservationValue) -> Setting:
-        """Create a new setting object with updated `value`."""
+    def update(self, value: ObservationValue, source: SourceType = None) -> Setting:
+        """Create a new setting object with updated value and source.
+
+        Args:
+            value: New value for the setting.
+            source: New source for the setting.
+
+        Returns:
+            Copy of ``self`` with modified properties.
+
+        """
         if self.read_only:
             raise ValueError(
                 f"Can't update the value of {self.parameter.name} to {value} since the setting is read-only."
@@ -445,7 +464,7 @@ class Setting(BaseModel):
             value = np.array(value)
         # Need to create a new Setting here instead of using Pydantic model_copy().
         # model_copy() can't handle backdoor settings without errors, i.e. values with a list of 2 elements.
-        return Setting(self.parameter, value, self.read_only, self.path)
+        return Setting(self.parameter, value, self.read_only, self.path, source=source)
 
     @property
     def name(self):
@@ -477,6 +496,11 @@ class Setting(BaseModel):
         """Element-wise indices of the parameter in ``self``."""
         return self.parameter.element_indices
 
+    @property
+    def source(self) -> SourceType:
+        """Return the source for this Setting's value."""
+        return self._source
+
     @staticmethod
     def get_by_name(name: str, values: set[Setting]) -> Setting | None:
         return next((setting for setting in values if setting.parameter.name == name), None)

exa/common/data/setting_node.py

@@ -217,7 +217,7 @@ import jinja2
 import numpy as np
 
 from exa.common.data.base_model import BaseModel
-from exa.common.data.parameter import CollectionType, Parameter, Setting
+from exa.common.data.parameter import CollectionType, Parameter, Setting, SourceType
 from exa.common.errors.exa_error import UnknownSettingError
 from exa.common.qcm_data.chip_topology import sort_components
 
@@ -603,7 +603,7 @@ class SettingNode(BaseModel):
         """
         for key, item in other.settings.items():
             if key in self.settings and (prioritize_other or (self[key].value is None)):
-                self.settings[key] = Setting(self.settings[key].parameter, item.value)
+                self.settings[key] = Setting(self.settings[key].parameter, item.value, source=self.settings[key].source)
         for key, item in other.subtrees.items():
             if key in self.subtrees:
                 self.subtrees[key].merge_values(copy(item), prioritize_other)
@@ -678,16 +678,22 @@ class SettingNode(BaseModel):
             new.subtrees[key] = cls.transform_node_types(subnode)
         return new
 
-    def set_from_dict(self, dct: dict[str, Any], strict: bool = False) -> None:
+    def set_from_dict(
+        self,
+        dct: dict[str, Any],
+        strict: bool = False,
+        source: SourceType = None,
+    ) -> None:
         """Recursively set values to Settings, taking values from a dictionary that has similar tree structure.
-        Keys that are not found in self are ignored, unless `strict` is True.
+        Keys that are not found in self are ignored, unless ``strict`` is True.
 
         Args:
             dct: Dictionary containing the new values to use.
-            strict: If True, will raise error if `dct` contains a setting that is not found in `self`.
+            strict: If True, will raise error if ``dct`` contains a setting that is not found in ``self``.
+            source: Source for the settings (this same source is applied to all settings from the dict).
 
         Raises:
-            UnknownSettingError: If the condition of `strict` happens.
+            UnknownSettingError: If the condition of ``strict`` happens.
 
         """
         for key, value in dct.items():
@@ -704,9 +710,10 @@ class SettingNode(BaseModel):
                     self.settings[key].name,
                     self.settings[key].parameter.data_type.cast(value),
                     path=self.settings[key].path,
+                    source=source,
                 )
             else:
-                self.settings[key] = self.settings[key].update(value)
+                self.settings[key] = self.settings[key].update(value, source=source)
 
     def setting_with_path_name(self, setting: Setting) -> Setting | None:
         """Get a copy of a setting with its name replaced with the path name."""
@@ -858,6 +865,7 @@ class SettingNode(BaseModel):
         nodes: Iterable[Setting | Parameter | SettingNode] | dict[str, Setting | Parameter | SettingNode],
         path: str,
         override_values: dict[str, Any] | None = None,
+        override_source: SourceType = None,
     ) -> None:
         """Add nodes to ``self`` while creating the missing nodes in-between.
 
@@ -873,6 +881,8 @@ class SettingNode(BaseModel):
                 found in self, the associated nodes will be created automatically.
             override_values: Optionally override the values for the `Settings` corresponding to ``nodes``. This dict
                 should have the same structure as ``nodes``, including matching names.
+            override_source: Optionally override the source for the ``Settings`` corresponding to ``nodes``. All the
+                settings will then have this same source.
 
         """
         override_values = override_values or {}
@@ -899,9 +909,10 @@ class SettingNode(BaseModel):
                 latest_node[key] = node
             else:
                 default_value = node.value if isinstance(node, Setting) else None
+                source = override_source or (node.source if isinstance(node, Setting) else None)
                 parameter = node.parameter if isinstance(node, Setting) else node
                 value = override_values.get(node.name) if override_values.get(node.name) is not None else default_value
-                latest_node[key] = Setting(parameter, value)
+                latest_node[key] = Setting(parameter, value, source=source)
 
     def get_default_implementation_name(self, gate: str, locus: str | Iterable[str]) -> str:
         """Get the default implementation name for a given gate and locus.
@@ -1034,6 +1045,20 @@ class SettingNode(BaseModel):
 
         raise ValueError(f"Locus {locus} cannot be found in the gate properties characterization settings.")
 
+    def set_source(self, source: SourceType, ignore_nones: bool = True) -> None:
+        """Set source recursively to all Settings in ``self``.
+
+        Args:
+            source: The source to set.
+            ignore_nones: If ``True``, the source will not be set for Settings with ``None`` value.
+
+        """
+        for setting in self.settings.values():
+            if not ignore_nones or setting.value is not None:
+                setting._source = source
+        for subtree in self.subtrees.values():
+            subtree.set_source(source, ignore_nones=ignore_nones)
+
     def _get_symmetric_loci(self, gate: str, implementation: str, locus: str | Iterable[str]) -> list[str]:
         if not isinstance(locus, str):
             if self.gate_definitions[gate][implementation].symmetric.value:

{iqm_exa_common-26.26.0.dist-info → iqm_exa_common-26.27.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iqm-exa-common
-Version: 26.26.0
+Version: 26.27.0
 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.26.0.dist-info → iqm_exa_common-26.27.0.dist-info}/RECORD

@@ -25,8 +25,8 @@ exa/common/control/sweep/option/start_stop_options.py,sha256=NAOCJgXvL5J4zewNvsI
 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=U508YCtvZabBGnKe1fqUimunmwGulOTM6DOKTUqnYp8,1835
-exa/common/data/parameter.py,sha256=GI-BJcXe53Mf2PXPzvftCV7L2kd_uC-hOjH_J__1MLc,23313
-exa/common/data/setting_node.py,sha256=obA9Rl3uSQ-pOoAAMzSQvzbRPygSIaFOM4W4foxKKKk,43344
+exa/common/data/parameter.py,sha256=93s9WH_GEBGLFy9LGWybtk3NEWLhTMdbf8Bf2Du7ruo,24397
+exa/common/data/setting_node.py,sha256=oDU9mNOl5uo7C-Nnhq4fQYvlqMRLvj2u5JoZwU46nUk,44525
 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
@@ -50,8 +50,8 @@ exa/common/qcm_data/qcm_data_client.py,sha256=Rze6yQd0xUeH6eUMv3wduYbiDCTP3C4WEC
 exa/common/sweep/__init__.py,sha256=uEKk5AtzSgSnf8Y0geRPwUpqXIBIXpeCxsN64sX7F1o,591
 exa/common/sweep/database_serialization.py,sha256=NUu1umxRQZpKtRmw1vNDsSbnofqbHvKFg_xQ2mdhY6k,7469
 exa/common/sweep/util.py,sha256=-QE2AaH-WDkYAVH5-Z-30leLgY0x4efmby4kc1JTCgY,3732
-iqm_exa_common-26.26.0.dist-info/LICENSE.txt,sha256=R6Q7eUrLyoCQgWYorQ8WJmVmWKYU3dxA3jYUp0wwQAw,11332
-iqm_exa_common-26.26.0.dist-info/METADATA,sha256=iD1DF1AEmak_PpscF39c2mw4n3OH3lAvZe4lZ74m1ww,14659
-iqm_exa_common-26.26.0.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
-iqm_exa_common-26.26.0.dist-info/top_level.txt,sha256=Clphg2toaZ3_jSFRPhjMNEmLurkMNMc4lkK2EFYsSlM,4
-iqm_exa_common-26.26.0.dist-info/RECORD,,
+iqm_exa_common-26.27.0.dist-info/LICENSE.txt,sha256=R6Q7eUrLyoCQgWYorQ8WJmVmWKYU3dxA3jYUp0wwQAw,11332
+iqm_exa_common-26.27.0.dist-info/METADATA,sha256=I1IQC6jmYF7G7-OwfsDvzak23LoG1YIMnl2WIzCkhG4,14659
+iqm_exa_common-26.27.0.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
+iqm_exa_common-26.27.0.dist-info/top_level.txt,sha256=Clphg2toaZ3_jSFRPhjMNEmLurkMNMc4lkK2EFYsSlM,4
+iqm_exa_common-26.27.0.dist-info/RECORD,,