Merge pull request #7065 from jenshnielsen/refactor_doxd

jenshnielsen · web-flow · commit 8d1a9b25bfa7 · 2025-04-16T08:40:16.000Z
Replace do0d and do1 with a wrapper around dond
diff --git a/docs/changes/newsfragments/7065.improved b/docs/changes/newsfragments/7065.improved
@@ -0,0 +1,3 @@
+The implementation of ``do0d`` and ``do1d`` have been replaced with a wrapper around `dond`.
+This aligns the keyword arguments with ``dond`` and ensures that these function support
+the same features as ``dond``. The same change is planned for ``do2d`` in the future.
diff --git a/src/qcodes/dataset/dond/do_0d.py b/src/qcodes/dataset/dond/do_0d.py
@@ -5,88 +5,46 @@
 
 from opentelemetry import trace
 
-from qcodes import config
-from qcodes.parameters import ParameterBase
+from .do_nd import DondKWargs, dond
 
-from ..descriptions.detect_shapes import detect_shape_of_measurement
-from ..measurements import Measurement
-from ..threading import process_params_meas
-from .do_nd_utils import _handle_plotting, _register_parameters, _set_write_period
+if TYPE_CHECKING:
+    from typing_extensions import Unpack
+
+    from .do_nd_utils import (
+        AxesTupleListWithDataSet,
+        ParamMeasT,
+    )
 
 LOG = logging.getLogger(__name__)
 TRACER = trace.get_tracer(__name__)
 
-if TYPE_CHECKING:
-    from ..descriptions.versioning.rundescribertypes import Shapes
-    from ..experiment_container import Experiment
-    from .do_nd_utils import AxesTupleListWithDataSet, ParamMeasT
-
 
 @TRACER.start_as_current_span("qcodes.dataset.do0d")
 def do0d(
-    *param_meas: ParamMeasT,
-    write_period: float | None = None,
-    measurement_name: str = "",
-    exp: Experiment | None = None,
-    do_plot: bool | None = None,
-    use_threads: bool | None = None,
-    log_info: str | None = None,
+    *param_meas: ParamMeasT, **kwargs: Unpack[DondKWargs]
 ) -> AxesTupleListWithDataSet:
     """
     Perform a measurement of a single parameter. This is probably most
-    useful for an ArrayParameter that already returns an array of data points
+    useful for a ParameterWithSetpoints that already returns an array of data points.
 
     Args:
         *param_meas: Parameter(s) to measure at each step or functions that
           will be called at each step. The function should take no arguments.
           The parameters and functions are called in the order they are
           supplied.
-        write_period: The time after which the data is actually written to the
-            database.
-        measurement_name: Name of the measurement. This will be passed down to
-            the dataset produced by the measurement. If not given, a default
-            value of 'results' is used for the dataset.
-        exp: The experiment to use for this measurement.
-        do_plot: should png and pdf versions of the images be saved after the
-            run. If None the setting will be read from ``qcodesrc.json``
-        use_threads: If True measurements from each instrument will be done on
-            separate threads. If you are measuring from several instruments
-            this may give a significant speedup.
-        log_info: Message that is logged during the measurement. If None a default
-            message is used.
+        **kwargs: kwargs are the same as for :func:`dond` and forwarded directly to :func:`dond`.
 
     Returns:
         The QCoDeS dataset.
 
     """
-    if do_plot is None:
-        do_plot = cast("bool", config.dataset.dond_plot)
-    meas = Measurement(name=measurement_name, exp=exp)
-    if log_info is not None:
-        meas._extra_log_info = log_info
-    else:
-        meas._extra_log_info = "Using 'qcodes.dataset.do0d'"
 
-    measured_parameters = tuple(
-        param for param in param_meas if isinstance(param, ParameterBase)
-    )
-
-    try:
-        shapes: Shapes | None = detect_shape_of_measurement(
-            measured_parameters,
-        )
-    except TypeError:
-        LOG.exception(
-            f"Could not detect shape of {measured_parameters} "
-            f"falling back to unknown shape."
-        )
-        shapes = None
-
-    _register_parameters(meas, param_meas, shapes=shapes)
-    _set_write_period(meas, write_period)
+    kwargs.setdefault("log_info", "Using 'qcodes.dataset.do0d'")
 
-    with meas.run() as datasaver:
-        datasaver.add_result(*process_params_meas(param_meas, use_threads=use_threads))
-        dataset = datasaver.dataset
-
-    return _handle_plotting(dataset, do_plot)
+    # since we only support entering parameters
+    # as a simple list or args we are sure to always
+    # get back a AxesTupleListWithDataSet and cast is safe
+    return cast(
+        "AxesTupleListWithDataSet",
+        dond(*param_meas, **kwargs, squeeze=True),
+    )
diff --git a/src/qcodes/dataset/dond/do_1d.py b/src/qcodes/dataset/dond/do_1d.py
@@ -1,46 +1,24 @@
 from __future__ import annotations
 
 import logging
-import sys
-import time
 from typing import TYPE_CHECKING, cast
 
-import numpy as np
 from opentelemetry import trace
-from tqdm.auto import tqdm
 
-from qcodes import config
-from qcodes.dataset.descriptions.detect_shapes import detect_shape_of_measurement
-from qcodes.dataset.dond.do_nd_utils import (
-    BreakConditionInterrupt,
-    _handle_plotting,
-    _register_actions,
-    _register_parameters,
-    _set_write_period,
-    catch_interrupts,
-)
-from qcodes.dataset.measurements import Measurement
-from qcodes.dataset.threading import (
-    SequentialParamsCaller,
-    ThreadPoolParamsCaller,
-    process_params_meas,
-)
-from qcodes.parameters import ParameterBase
-
-LOG = logging.getLogger(__name__)
-TRACER = trace.get_tracer(__name__)
+from .do_nd import DondKWargs, dond
+from .sweeps import LinSweep
 
 if TYPE_CHECKING:
-    from collections.abc import Sequence
+    from typing_extensions import Unpack
 
-    from qcodes.dataset.descriptions.versioning.rundescribertypes import Shapes
     from qcodes.dataset.dond.do_nd_utils import (
-        ActionsT,
         AxesTupleListWithDataSet,
-        BreakConditionT,
         ParamMeasT,
     )
-    from qcodes.dataset.experiment_container import Experiment
+    from qcodes.parameters import ParameterBase
+
+LOG = logging.getLogger(__name__)
+TRACER = trace.get_tracer(__name__)
 
 
 @TRACER.start_as_current_span("qcodes.dataset.do1d")
@@ -51,17 +29,7 @@ def do1d(
     num_points: int,
     delay: float,
     *param_meas: ParamMeasT,
-    enter_actions: ActionsT = (),
-    exit_actions: ActionsT = (),
-    write_period: float | None = None,
-    measurement_name: str = "",
-    exp: Experiment | None = None,
-    do_plot: bool | None = None,
-    use_threads: bool | None = None,
-    additional_setpoints: Sequence[ParameterBase] = tuple(),
-    show_progress: bool | None = None,
-    log_info: str | None = None,
-    break_condition: BreakConditionT | None = None,
+    **kwargs: Unpack[DondKWargs],
 ) -> AxesTupleListWithDataSet:
     """
     Perform a 1D scan of ``param_set`` from ``start`` to ``stop`` in
@@ -74,106 +42,30 @@ def do1d(
         stop: End point of sweep
         num_points: Number of points in sweep
         delay: Delay after setting parameter before measurement is performed
-        param_meas: Parameter(s) to measure at each step or functions that
+        *param_meas: Parameter(s) to measure at each step or functions that
           will be called at each step. The function should take no arguments.
           The parameters and functions are called in the order they are
           supplied.
-        enter_actions: A list of functions taking no arguments that will be
-            called before the measurements start
-        exit_actions: A list of functions taking no arguments that will be
-            called after the measurements ends
-        write_period: The time after which the data is actually written to the
-            database.
-        additional_setpoints: A list of setpoint parameters to be registered in
-            the measurement but not scanned.
-        measurement_name: Name of the measurement. This will be passed down to
-            the dataset produced by the measurement. If not given, a default
-            value of 'results' is used for the dataset.
-        exp: The experiment to use for this measurement.
-        do_plot: should png and pdf versions of the images be saved after the
-            run. If None the setting will be read from ``qcodesrc.json``
-        use_threads: If True measurements from each instrument will be done on
-            separate threads. If you are measuring from several instruments
-            this may give a significant speedup.
-        show_progress: should a progress bar be displayed during the
-            measurement. If None the setting will be read from ``qcodesrc.json``
-        log_info: Message that is logged during the measurement. If None a default
-            message is used.
-        break_condition: Callable that takes no arguments. If returned True,
-            measurement is interrupted.
+        **kwargs: kwargs are the same as for :func:`dond` and forwarded directly to :func:`dond`.
 
     Returns:
         The QCoDeS dataset.
 
     """
-    if do_plot is None:
-        do_plot = cast("bool", config.dataset.dond_plot)
-    if show_progress is None:
-        show_progress = config.dataset.dond_show_progress
-
-    meas = Measurement(name=measurement_name, exp=exp)
-    if log_info is not None:
-        meas._extra_log_info = log_info
-    else:
-        meas._extra_log_info = "Using 'qcodes.dataset.do1d'"
-
-    all_setpoint_params = (param_set, *tuple(s for s in additional_setpoints))
-
-    measured_parameters = tuple(
-        param for param in param_meas if isinstance(param, ParameterBase)
+    kwargs.setdefault("log_info", "Using 'qcodes.dataset.do1d'")
+
+    return cast(
+        "AxesTupleListWithDataSet",
+        dond(
+            LinSweep(
+                param=param_set,
+                start=start,
+                stop=stop,
+                delay=delay,
+                num_points=num_points,
+            ),
+            *param_meas,
+            **kwargs,
+            squeeze=True,
+        ),
     )
-    try:
-        loop_shape = (num_points, *tuple(1 for _ in additional_setpoints))
-        shapes: Shapes | None = detect_shape_of_measurement(
-            measured_parameters, loop_shape
-        )
-    except TypeError:
-        LOG.exception(
-            f"Could not detect shape of {measured_parameters} "
-            f"falling back to unknown shape."
-        )
-        shapes = None
-
-    _register_parameters(meas, all_setpoint_params)
-    _register_parameters(meas, param_meas, setpoints=all_setpoint_params, shapes=shapes)
-    _set_write_period(meas, write_period)
-    _register_actions(meas, enter_actions, exit_actions)
-
-    if use_threads is None:
-        use_threads = config.dataset.use_threads
-
-    param_meas_caller = (
-        ThreadPoolParamsCaller(*param_meas)
-        if use_threads
-        else SequentialParamsCaller(*param_meas)
-    )
-
-    # do1D enforces a simple relationship between measured parameters
-    # and set parameters. For anything more complicated this should be
-    # reimplemented from scratch
-    with (
-        catch_interrupts() as interrupted,
-        meas.run() as datasaver,
-        param_meas_caller as call_param_meas,
-    ):
-        dataset = datasaver.dataset
-        additional_setpoints_data = process_params_meas(additional_setpoints)
-        setpoints = np.linspace(start, stop, num_points)
-
-        # flush to prevent unflushed print's to visually interrupt tqdm bar
-        # updates
-        sys.stdout.flush()
-        sys.stderr.flush()
-
-        for set_point in tqdm(setpoints, disable=not show_progress):
-            param_set.set(set_point)
-            time.sleep(delay)
-            datasaver.add_result(
-                (param_set, set_point), *call_param_meas(), *additional_setpoints_data
-            )
-
-            if callable(break_condition):
-                if break_condition():
-                    raise BreakConditionInterrupt("Break condition was met.")
-
-    return _handle_plotting(dataset, do_plot, interrupted())
diff --git a/src/qcodes/dataset/dond/do_nd.py b/src/qcodes/dataset/dond/do_nd.py
@@ -6,7 +6,7 @@
 from collections.abc import Callable, Mapping, Sequence
 from contextlib import ExitStack
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, Any, Literal, cast, overload
+from typing import TYPE_CHECKING, Any, Literal, NotRequired, cast, overload
 
 import numpy as np
 from opentelemetry import trace
@@ -33,8 +33,6 @@
 
 from .sweeps import AbstractSweep, TogetherSweep
 
-LOG = logging.getLogger(__name__)
-
 if TYPE_CHECKING:
     from qcodes.dataset.descriptions.versioning.rundescribertypes import Shapes
     from qcodes.dataset.dond.do_nd_utils import (
@@ -46,6 +44,7 @@
     )
     from qcodes.dataset.experiment_container import Experiment
 
+LOG = logging.getLogger(__name__)
 SweepVarType = Any
 
 TRACER = trace.get_tracer(__name__)
@@ -567,6 +566,22 @@ def parameters(self) -> tuple[ParameterBase, ...]:
         return self._parameters
 
 
+class DondKWargs(TypedDict):
+    write_period: NotRequired[float | None]
+    measurement_name: NotRequired[str | Sequence[str]]
+    exp: NotRequired[Experiment | Sequence[Experiment] | None]
+    enter_actions: NotRequired[ActionsT]
+    exit_actions: NotRequired[ActionsT]
+    do_plot: NotRequired[bool | None]
+    show_progress: NotRequired[bool | None]
+    use_threads: NotRequired[bool | None]
+    additional_setpoints: NotRequired[Sequence[ParameterBase]]
+    log_info: NotRequired[str | None]
+    break_condition: NotRequired[BreakConditionT | None]
+    dataset_dependencies: NotRequired[Mapping[str, Sequence[ParamMeasT]]]
+    in_memory_cache: NotRequired[bool | None]
+
+
 @overload
 def dond(
     *params: AbstractSweep | TogetherSweep | ParamMeasT | Sequence[ParamMeasT],

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+The implementation of ``do0d`` and ``do1d`` have been replaced with a wrapper around `dond`.
	`2`	+This aligns the keyword arguments with ``dond`` and ensures that these function support
	`3`	+the same features as ``dond``. The same change is planned for ``do2d`` in the future.