Add warning to add_parameter when bind_to_instrument is False

microsoft · Dec 16, 2024 · cbdc9bf · cbdc9bf
1 parent 72d0be9
commit cbdc9bf
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 6 deletions.
diff --git a/src/qcodes/instrument/instrument_base.py b/src/qcodes/instrument/instrument_base.py
@@ -168,6 +168,14 @@ def add_parameter(
 
         bind_to_instrument = kwargs["bind_to_instrument"]
 
+        if bind_to_instrument is False:
+            warnings.warn(
+                f"Parameter {name} passed to `add_parameter` "
+                "on instrument {self.full_name} with `bind_to_instrument=False`. "
+                "This is not recommended as it results in inconsistent behavior. "
+                "To disable snapshotting of the parameter set `snapshot_exclude=True`."
+            )
+
         try:
             param = parameter_class(name=name, instrument=self, **kwargs)
         except TypeError:

diff --git a/tests/parameter/test_parameter_registration.py b/tests/parameter/test_parameter_registration.py
@@ -93,10 +93,11 @@ def test_parameter_registration_with_non_kwargs_passing_parameter(
 def test_parameter_registration_bind_to_instrument_false(
     dummy_attr_instr: DummyAttrInstrument,
 ) -> None:
-    dummy_attr_instr.add_parameter(
-        name="non_binding_parameter",
-        set_cmd=None,
-        get_cmd=None,
-        bind_to_instrument=False,
-    )
+    with pytest.warns(UserWarning, match="passed to `add_parameter`"):
+        dummy_attr_instr.add_parameter(
+            name="non_binding_parameter",
+            set_cmd=None,
+            get_cmd=None,
+            bind_to_instrument=False,
+        )
     assert "non_binding_parameter" not in dummy_attr_instr.parameters.keys()