[WIP] Add convenience methods to DelegateParameter #6832

jenshnielsen · 2025-01-27T12:21:23Z

DelegateParameter now includes validators of its source Parameter into its validators. This ensures that a DelegateParameter
with a non numeric source parameter is registered correctly in a measurement when the DelegateParameter it self does not
set a validator. Furthermore `DelegateParameterhas gained aroot_source`` attribute that makes it easier to get the
root source of a ``DelegateParameter`` that delegates to another ``DelegateParameter``.

Alternative to #6817

codecov · 2025-01-27T12:29:13Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.39%. Comparing base (83d4cd5) to head (d3d58bf).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6832      +/-   ##
==========================================
+ Coverage   69.37%   69.39%   +0.01%     
==========================================
  Files         341      341              
  Lines       31381    31399      +18     
==========================================
+ Hits        21771    21789      +18     
  Misses       9610     9610

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/qcodes/parameters/delegate_parameter.py

tests/dataset/measurement/test_measurement_context_manager.py

jenshnielsen · 2025-02-04T15:09:36Z

tests/dataset/measurement/test_measurement_context_manager.py

+    meas.register_parameter(delegate_param, setpoints=(x_param,))
+    assert len(meas.parameters) == 2
+    assert meas.parameters["delegate"].type == "complex"
+    assert meas.parameters["x"].type == "numeric"


Lets also add a test for delegate of delegate of complex

A -> B -> C -> None

Add source to C

verify that A has the correct validator.

jenshnielsen · 2025-02-04T15:13:10Z

tests/parameter/test_delegate_parameter.py

+    delegate_param.source.vals = None
+
+    assert delegate_param.validators == (some_other_validator,)
+    assert delegate_param.vals == some_other_validator


Extend to 2 delegate parameters too

This will ensure that when the validator is used to find the datatype of a parameter it can be detected correctly

…ct type

…dator

jenshnielsen · 2025-02-05T14:13:42Z

Moved the validators to #6865 will figure out how to integrate the test with the infer module here in a more consistent way

astafan8 · 2025-02-11T09:54:12Z

docs/changes/newsfragments/6832.improved

@@ -0,0 +1,4 @@
+``DelegateParameter`` now includes validators of its source Parameter into its validators. This ensures that a ``DelegateParameter``
+with a non numeric source parameter is registered correctly in a measurement when the ``DelegateParameter`` it self does not
+set a validator. Furthermore `DelegateParameter`` has gained ``root_source`` and ``root_delegate`` attributes that makes it easier to get the


Suggested change

set a validator. Furthermore `DelegateParameter`` has gained ``root_source`` and ``root_delegate`` attributes that makes it easier to get the

set a validator. Furthermore ``DelegateParameter`` has gained ``root_source`` and ``root_delegate`` attributes that makes it easier to get the

astafan8 · 2025-02-11T09:55:06Z

src/qcodes/parameters/delegate_parameter.py

+        """
+        The root source parameter that this :class:`DelegateParameter` is bound to
+        or ``None`` if this  :class:`DelegateParameter` is unbound. If
+        the source is it self a DelegateParameter it will recursively return that Parameter's


Suggested change

the source is it self a DelegateParameter it will recursively return that Parameter's

the source is it self a :class:`DelegateParameter`, this property will recursively return that Parameter's

astafan8 · 2025-02-11T09:56:07Z

src/qcodes/parameters/delegate_parameter.py

+        The root source parameter that this :class:`DelegateParameter` is bound to
+        or ``None`` if this  :class:`DelegateParameter` is unbound. If
+        the source is it self a DelegateParameter it will recursively return that Parameter's
+        source until a non DelegateParameter is found. For a non DelegateParameter source


Suggested change

source until a non DelegateParameter is found. For a non DelegateParameter source

source until a non DelegateParameter is found. If a source of this parameter is not a DelegateParameter,

astafan8 · 2025-02-11T09:58:23Z

src/qcodes/parameters/delegate_parameter.py

+        source until a non DelegateParameter is found. For a non DelegateParameter source
+        this behaves the same as ``self.source``
+
+        :getter: Returns the current source.


Suggested change

:getter: Returns the current source.

:getter: Returns the current source parameter that's at the end of a chain of DelegateParameters.

astafan8 · 2025-02-11T09:58:40Z

src/qcodes/parameters/delegate_parameter.py

+    @property
+    def root_delegate(self) -> DelegateParameter:
+        """
+        If this parameter is part of a chain of DelegateParameters return


Suggested change

If this parameter is part of a chain of DelegateParameters return

If this parameter is part of a chain of DelegateParameters, return

astafan8 · 2025-02-11T09:58:52Z

src/qcodes/parameters/delegate_parameter.py

+    def root_delegate(self) -> DelegateParameter:
+        """
+        If this parameter is part of a chain of DelegateParameters return
+        the first Parameter in the chain that has a non DelegateParameter source


Suggested change

the first Parameter in the chain that has a non DelegateParameter source

the first Parameter in the chain that has a non DelegateParameter source,

astafan8 · 2025-02-11T10:01:12Z

src/qcodes/parameters/delegate_parameter.py

+            self.source.validators if self.source is not None else ()
+        )
+
+        return tuple(self._vals) + source_validators


just wonder, if it's cleaner (and even possible) to use super here?

Suggested change

return tuple(self._vals) + source_validators

return super().validators + source_validators

jenshnielsen requested a review from a team as a code owner January 27, 2025 12:21

jenshnielsen mentioned this pull request Jan 27, 2025

add vals property and setter to delegate_parameter #6817

Closed

jenshnielsen force-pushed the exp_validator branch from 8925230 to 23591b1 Compare January 27, 2025 13:17

jenshnielsen changed the title ~~[wip] extend test_value_validation to cover more cases~~ [wip] extend delegate parameter validators with validators from source parameter. Jan 27, 2025

jenshnielsen commented Feb 3, 2025

View reviewed changes

src/qcodes/parameters/delegate_parameter.py Outdated Show resolved Hide resolved

jenshnielsen force-pushed the exp_validator branch from 1c17998 to 3b110ea Compare February 3, 2025 09:58

jenshnielsen changed the title ~~[wip] extend delegate parameter validators with validators from source parameter.~~ Extend DelegateParameter validators with validators from source parameter and add root_source property Feb 3, 2025

esbenborkhansen approved these changes Feb 3, 2025

View reviewed changes

tests/dataset/measurement/test_measurement_context_manager.py Show resolved Hide resolved

jenshnielsen commented Feb 4, 2025

View reviewed changes

esbenborkhansen and others added 12 commits February 5, 2025 14:43

extend test_value_validation to cover more cases

568b0be

Add source validators to delegate parameter validator

87a0e79

This will ensure that when the validator is used to find the datatype of a parameter it can be detected correctly

Add root_source to DelegateParameter

4ed8c91

Add basic test that delegate parameters are registered with the corre…

972d1c3

…ct type

Add test that DelegateParameter correctly can see source param's vali…

17794cd

…dator

Add test for DelegateParamerer.root_source

40c5dd6

Add changelog for 6832

0c3d2e2

Add option to set root_source to DelegateParameter

af26314

Add tests for root_delegate and root_source setter

d044bcb

Extend changelog

fb665d5

Improve docstring

605c7db

Add test that delegate paramere registration works if source is set late

d3d58bf

jenshnielsen force-pushed the exp_validator branch from 0ea345c to d3d58bf Compare February 5, 2025 13:43

jenshnielsen mentioned this pull request Feb 5, 2025

Add source validators to delegate parameter validators #6865

Merged

jenshnielsen changed the title ~~Extend DelegateParameter validators with validators from source parameter and add root_source property~~ [WIP] Add convenience methods to DelegateParameter Feb 7, 2025

astafan8 approved these changes Feb 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Add convenience methods to DelegateParameter #6832

[WIP] Add convenience methods to DelegateParameter #6832

jenshnielsen commented Jan 27, 2025 •

edited

Loading

codecov bot commented Jan 27, 2025 •

edited

Loading

jenshnielsen Feb 4, 2025

jenshnielsen Feb 4, 2025

jenshnielsen Feb 4, 2025

jenshnielsen commented Feb 5, 2025

astafan8 Feb 11, 2025

astafan8 Feb 11, 2025

astafan8 Feb 11, 2025

astafan8 Feb 11, 2025

astafan8 Feb 11, 2025

astafan8 Feb 11, 2025

astafan8 Feb 11, 2025

	set a validator. Furthermore `DelegateParameter`` has gained ``root_source`` and ``root_delegate`` attributes that makes it easier to get the
	set a validator. Furthermore ``DelegateParameter`` has gained ``root_source`` and ``root_delegate`` attributes that makes it easier to get the

	the source is it self a DelegateParameter it will recursively return that Parameter's
	the source is it self a :class:`DelegateParameter`, this property will recursively return that Parameter's

	source until a non DelegateParameter is found. For a non DelegateParameter source
	source until a non DelegateParameter is found. If a source of this parameter is not a DelegateParameter,

	:getter: Returns the current source.
	:getter: Returns the current source parameter that's at the end of a chain of DelegateParameters.

	If this parameter is part of a chain of DelegateParameters return
	If this parameter is part of a chain of DelegateParameters, return

	the first Parameter in the chain that has a non DelegateParameter source
	the first Parameter in the chain that has a non DelegateParameter source,

	return tuple(self._vals) + source_validators
	return super().validators + source_validators

[WIP] Add convenience methods to DelegateParameter #6832

Are you sure you want to change the base?

[WIP] Add convenience methods to DelegateParameter #6832

Conversation

jenshnielsen commented Jan 27, 2025 • edited Loading

codecov bot commented Jan 27, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jenshnielsen commented Feb 5, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jenshnielsen commented Jan 27, 2025 •

edited

Loading

codecov bot commented Jan 27, 2025 •

edited

Loading