Deprecate to_xarray_dataarray_dict

Author: jenshnielsen

src/qcodes/dataset/data_set.py

@@ -15,6 +15,7 @@
 import numpy
 import numpy.typing as npt
 from tqdm.auto import trange
+from typing_extensions import deprecated
 
 import qcodes
 from qcodes.dataset.data_set_protocol import (
@@ -84,6 +85,7 @@
 from qcodes.utils import (
     NumpyJSONEncoder,
 )
+from qcodes.utils.deprecate import QCoDeSDeprecationWarning
 
 from .data_set_cache import DataSetCacheWithDBBackend
 from .data_set_in_memory import DataSetInMem, load_from_file
@@ -95,7 +97,7 @@
     load_to_dataframe_dict,
 )
 from .exporters.export_to_xarray import (
-    load_to_xarray_dataarray_dict,
+    load_to_xarray_dataarray_dict,  # pyright: ignore[reportDeprecated]
     load_to_xarray_dataset,
     load_to_xarray_dataset_dict,
     xarray_to_h5netcdf_with_complex_numbers,
@@ -965,6 +967,10 @@ def to_pandas_dataframe(
         datadict = self.get_parameter_data(*params, start=start, end=end)
         return load_to_concatenated_dataframe(datadict, self.description.interdeps)
 
+    @deprecated(
+        "to_xarray_dataarray_dict is deprecated, use to_xarray_dataset_dict instead",
+        category=QCoDeSDeprecationWarning,
+    )
     def to_xarray_dataarray_dict(
         self,
         *params: str | ParamSpec | ParameterBase,
@@ -1026,7 +1032,7 @@ def to_xarray_dataarray_dict(
 
         """
         data = self.get_parameter_data(*params, start=start, end=end)
-        datadict = load_to_xarray_dataarray_dict(
+        datadict = load_to_xarray_dataarray_dict(  # pyright: ignore[reportDeprecated]
             self, data, use_multi_index=use_multi_index
         )
 

src/qcodes/dataset/data_set_cache.py

@@ -6,16 +6,18 @@
 
 import numpy as np
 import numpy.typing as npt
+from typing_extensions import deprecated
 
 from qcodes.dataset.exporters.export_info import ExportInfo
 from qcodes.dataset.sqlite.queries import completed, load_new_data_for_rundescriber
+from qcodes.utils import QCoDeSDeprecationWarning
 
 from .exporters.export_to_pandas import (
     load_to_concatenated_dataframe,
     load_to_dataframe_dict,
 )
 from .exporters.export_to_xarray import (
-    load_to_xarray_dataarray_dict,
+    load_to_xarray_dataarray_dict,  # pyright: ignore[reportDeprecated]
     load_to_xarray_dataset,
     load_to_xarray_dataset_dict,
 )
@@ -186,6 +188,10 @@ def to_pandas_dataframe(self) -> pd.DataFrame:
         data = self.data()
         return load_to_concatenated_dataframe(data, self.rundescriber.interdeps)
 
+    @deprecated(
+        "to_xarray_dataarray_dict is deprecated, use to_xarray_dataset_dict instead",
+        category=QCoDeSDeprecationWarning,
+    )
     def to_xarray_dataarray_dict(
         self, *, use_multi_index: Literal["auto", "always", "never"] = "auto"
     ) -> dict[str, xr.DataArray]:
@@ -201,7 +207,7 @@ def to_xarray_dataarray_dict(
 
         """
         data = self.data()
-        data_dict = load_to_xarray_dataarray_dict(
+        data_dict = load_to_xarray_dataarray_dict(  # pyright: ignore[reportDeprecated]
             self._dataset, data, use_multi_index=use_multi_index
         )
         return data_dict

src/qcodes/dataset/data_set_in_memory.py

@@ -11,6 +11,7 @@
 
 import numpy as np
 import numpy.typing as npt
+from typing_extensions import deprecated
 
 from qcodes.dataset.data_set_protocol import (
     SPECS,
@@ -40,7 +41,7 @@
     update_parent_datasets,
     update_run_description,
 )
-from qcodes.utils import NumpyJSONEncoder
+from qcodes.utils import NumpyJSONEncoder, QCoDeSDeprecationWarning
 
 from .data_set_cache import DataSetCacheDeferred, DataSetCacheInMem
 from .dataset_helpers import _add_run_to_runs_table
@@ -848,6 +849,10 @@ def _parameters(self) -> str | None:
         else:
             return None
 
+    @deprecated(
+        "to_xarray_dataarray_dict is deprecated, use to_xarray_dataset_dict instead",
+        category=QCoDeSDeprecationWarning,
+    )
     def to_xarray_dataarray_dict(
         self,
         *params: str | ParamSpec | ParameterBase,
@@ -856,7 +861,7 @@ def to_xarray_dataarray_dict(
         use_multi_index: Literal["auto", "always", "never"] = "auto",
     ) -> dict[str, xr.DataArray]:
         self._warn_if_set(*params, start=start, end=end)
-        return self.cache.to_xarray_dataarray_dict()
+        return self.cache.to_xarray_dataarray_dict()  # pyright: ignore[reportDeprecated]
 
     def to_xarray_dataset_dict(
         self,

src/qcodes/dataset/exporters/export_to_xarray.py

@@ -7,8 +7,10 @@
 from typing import TYPE_CHECKING, Literal
 
 from packaging import version as p_version
+from typing_extensions import deprecated
 
 from qcodes.dataset.linked_datasets.links import links_to_str
+from qcodes.utils import QCoDeSDeprecationWarning
 
 from ..descriptions.versioning import serialization as serial
 from .export_to_pandas import (
@@ -210,6 +212,10 @@ def _xarray_data_array_direct(
     return ds
 
 
+@deprecated(
+    "load_to_xarray_dataarray_dict is deprecated, use load_to_xarray_dataarray_dict instead",
+    category=QCoDeSDeprecationWarning,
+)
 def load_to_xarray_dataarray_dict(
     dataset: DataSetProtocol,
     datadict: Mapping[str, Mapping[str, npt.NDArray]],