From 53457f99d4b1961327e54823a4685d141d50b1f0 Mon Sep 17 00:00:00 2001 From: Esben Bork Hansen Date: Thu, 27 Mar 2025 15:16:12 +0100 Subject: [PATCH 01/10] change short_name to register_name in parameters snapshot --- src/qcodes/dataset/measurements.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/qcodes/dataset/measurements.py b/src/qcodes/dataset/measurements.py index e04a0cceed20..6ca799ed6cbb 100644 --- a/src/qcodes/dataset/measurements.py +++ b/src/qcodes/dataset/measurements.py @@ -670,7 +670,7 @@ def __enter__(self) -> DataSaver: snapshot = {} if self._registered_parameters is not None: parameter_snapshot = { - param.short_name: param.snapshot() + param.register_name: param.snapshot() for param in self._registered_parameters } snapshot["parameters"] = parameter_snapshot From bb7e16bb083388bf222ce0c745fc7c66a4e9c25d Mon Sep 17 00:00:00 2001 From: Esben Bork Hansen Date: Thu, 27 Mar 2025 15:32:39 +0100 Subject: [PATCH 02/10] added newfragments --- docs/changes/newsfragments/7012.improved | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/changes/newsfragments/7012.improved diff --git a/docs/changes/newsfragments/7012.improved b/docs/changes/newsfragments/7012.improved new file mode 100644 index 000000000000..1ff46a12a93c --- /dev/null +++ b/docs/changes/newsfragments/7012.improved @@ -0,0 +1 @@ +Change snapshot to use the register_name of the parameter instead of short_name as key in the parameters snapshot. \ No newline at end of file From d6b26f4c3913faeaec03668fbbbd54a30d9ee1b0 Mon Sep 17 00:00:00 2001 From: Esben Bork Hansen Date: Thu, 27 Mar 2025 15:39:02 +0100 Subject: [PATCH 03/10] pre-commit --- docs/changes/newsfragments/7012.improved | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changes/newsfragments/7012.improved b/docs/changes/newsfragments/7012.improved index 1ff46a12a93c..f2fb259549fb 100644 --- a/docs/changes/newsfragments/7012.improved +++ b/docs/changes/newsfragments/7012.improved @@ -1 +1 @@ -Change snapshot to use the register_name of the parameter instead of short_name as key in the parameters snapshot. \ No newline at end of file +Change snapshot to use the register_name of the parameter instead of short_name as key in the parameters snapshot. From 92cea5a007b6c45a9f1d4fd5da58cc71d5e39ac6 Mon Sep 17 00:00:00 2001 From: Esben Bork Hansen Date: Thu, 27 Mar 2025 15:40:34 +0100 Subject: [PATCH 04/10] review comment --- docs/changes/newsfragments/7012.improved | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changes/newsfragments/7012.improved b/docs/changes/newsfragments/7012.improved index f2fb259549fb..c48e493e3fcb 100644 --- a/docs/changes/newsfragments/7012.improved +++ b/docs/changes/newsfragments/7012.improved @@ -1 +1 @@ -Change snapshot to use the register_name of the parameter instead of short_name as key in the parameters snapshot. +Use the register_name of the parameter instead of short_name as key in the parameters snapshot in datasets (not the station snapshot). From 708f61919d9d69b3d99f8ecff3c4dffb3f6de493 Mon Sep 17 00:00:00 2001 From: Esben Bork Hansen Date: Fri, 28 Mar 2025 10:18:22 +0100 Subject: [PATCH 05/10] update test and newfragments --- docs/changes/newsfragments/{7012.improved => 7012.breaking} | 0 tests/dataset/test_snapshot.py | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename docs/changes/newsfragments/{7012.improved => 7012.breaking} (100%) diff --git a/docs/changes/newsfragments/7012.improved b/docs/changes/newsfragments/7012.breaking similarity index 100% rename from docs/changes/newsfragments/7012.improved rename to docs/changes/newsfragments/7012.breaking diff --git a/tests/dataset/test_snapshot.py b/tests/dataset/test_snapshot.py index 607f992b4939..361b335bd1df 100644 --- a/tests/dataset/test_snapshot.py +++ b/tests/dataset/test_snapshot.py @@ -44,7 +44,7 @@ def test_station_snapshot_during_measurement( measurement.register_parameter(dac.ch1) measurement.register_parameter(dmm.v1, setpoints=[dac.ch1]) snapshot_of_parameters = { - parameter.short_name: parameter.snapshot() for parameter in (dac.ch1, dmm.v1) + parameter.register_name: parameter.snapshot() for parameter in (dac.ch1, dmm.v1) } with measurement.run() as data_saver: data_saver.add_result((dac.ch1, 7), (dmm.v1, 5)) From 6026ae7def20a80d43e8457d047cf633715801e8 Mon Sep 17 00:00:00 2001 From: Esben Bork Hansen Date: Wed, 2 Apr 2025 18:01:02 +0200 Subject: [PATCH 06/10] record parameter snapshot under both long and short name keys --- src/qcodes/dataset/measurements.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/qcodes/dataset/measurements.py b/src/qcodes/dataset/measurements.py index 66928602fbea..fd4771c3d74e 100644 --- a/src/qcodes/dataset/measurements.py +++ b/src/qcodes/dataset/measurements.py @@ -670,9 +670,13 @@ def __enter__(self) -> DataSaver: snapshot = {} if self._registered_parameters is not None: parameter_snapshot = { - param.register_name: param.snapshot() + param.short_name: param.snapshot() for param in self._registered_parameters } + parameter_snapshot.update({ + param.register_name: param.snapshot() + for param in self._registered_parameters + }) snapshot["parameters"] = parameter_snapshot self.ds.prepare( From 38ffab44fb6359bcf61d4ed5fa125b9250b116bf Mon Sep 17 00:00:00 2001 From: Esben Bork Hansen Date: Wed, 2 Apr 2025 18:07:06 +0200 Subject: [PATCH 07/10] update newfragments --- docs/changes/newsfragments/7012.breaking | 1 - docs/changes/newsfragments/7012.improved | 2 ++ 2 files changed, 2 insertions(+), 1 deletion(-) delete mode 100644 docs/changes/newsfragments/7012.breaking create mode 100644 docs/changes/newsfragments/7012.improved diff --git a/docs/changes/newsfragments/7012.breaking b/docs/changes/newsfragments/7012.breaking deleted file mode 100644 index c48e493e3fcb..000000000000 --- a/docs/changes/newsfragments/7012.breaking +++ /dev/null @@ -1 +0,0 @@ -Use the register_name of the parameter instead of short_name as key in the parameters snapshot in datasets (not the station snapshot). diff --git a/docs/changes/newsfragments/7012.improved b/docs/changes/newsfragments/7012.improved new file mode 100644 index 000000000000..e89a4ebefb1e --- /dev/null +++ b/docs/changes/newsfragments/7012.improved @@ -0,0 +1,2 @@ +Save the parameter snapshot under the long name key in the parameters snapshot in datasets (not the station snapshot), to avoid overwritting the snapshot multiple parameters have identical short names. +The parameter snapshot saved under the short name key is kept for backwards compatibility, but will be removed at a later time. From 67d37dcd5cda506057cc093c2cd176467446c897 Mon Sep 17 00:00:00 2001 From: Esben Bork Hansen Date: Thu, 3 Apr 2025 10:16:14 +0200 Subject: [PATCH 08/10] pre-commit --- src/qcodes/dataset/measurements.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/qcodes/dataset/measurements.py b/src/qcodes/dataset/measurements.py index fd4771c3d74e..7818b525bba7 100644 --- a/src/qcodes/dataset/measurements.py +++ b/src/qcodes/dataset/measurements.py @@ -673,10 +673,12 @@ def __enter__(self) -> DataSaver: param.short_name: param.snapshot() for param in self._registered_parameters } - parameter_snapshot.update({ - param.register_name: param.snapshot() - for param in self._registered_parameters - }) + parameter_snapshot.update( + { + param.register_name: param.snapshot() + for param in self._registered_parameters + } + ) snapshot["parameters"] = parameter_snapshot self.ds.prepare( From 6bf48c17357979d3b9f735a1906380100d94cb6d Mon Sep 17 00:00:00 2001 From: Esben Bork Hansen Date: Thu, 3 Apr 2025 11:00:03 +0200 Subject: [PATCH 09/10] fix test --- tests/dataset/test_snapshot.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/tests/dataset/test_snapshot.py b/tests/dataset/test_snapshot.py index 361b335bd1df..0efee53da7a9 100644 --- a/tests/dataset/test_snapshot.py +++ b/tests/dataset/test_snapshot.py @@ -44,8 +44,14 @@ def test_station_snapshot_during_measurement( measurement.register_parameter(dac.ch1) measurement.register_parameter(dmm.v1, setpoints=[dac.ch1]) snapshot_of_parameters = { - parameter.register_name: parameter.snapshot() for parameter in (dac.ch1, dmm.v1) + parameter.short_name: parameter.snapshot() for parameter in (dac.ch1, dmm.v1) } + snapshot_of_parameters.update( + { + parameter.register_name: parameter.snapshot() + for parameter in (dac.ch1, dmm.v1) + } + ) with measurement.run() as data_saver: data_saver.add_result((dac.ch1, 7), (dmm.v1, 5)) From 143db9cb3446316c25a7d01636f1f3084a048abb Mon Sep 17 00:00:00 2001 From: Mikhail Astafev Date: Thu, 3 Apr 2025 11:40:43 +0200 Subject: [PATCH 10/10] Update docs/changes/newsfragments/7012.improved --- docs/changes/newsfragments/7012.improved | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changes/newsfragments/7012.improved b/docs/changes/newsfragments/7012.improved index e89a4ebefb1e..8f3784eb46b2 100644 --- a/docs/changes/newsfragments/7012.improved +++ b/docs/changes/newsfragments/7012.improved @@ -1,2 +1,2 @@ -Save the parameter snapshot under the long name key in the parameters snapshot in datasets (not the station snapshot), to avoid overwritting the snapshot multiple parameters have identical short names. +Save the parameter snapshot under the `register_name` key in the parameters snapshot in datasets (not the station snapshot), to avoid overwritting the snapshot multiple parameters have identical `short_name`s. The parameter snapshot saved under the short name key is kept for backwards compatibility, but will be removed at a later time.