Remove support for list of numpy arrays from Dataset.__init__

Author: ecomodeller

mikeio/dataset/_dataset.py

@@ -16,8 +16,6 @@
     Callable,
 )
 import warnings
-from typing_extensions import deprecated
-# from warnings import deprecated
 
 
 import numpy as np
@@ -62,23 +60,9 @@ class Dataset:
     Parameters
     ----------
     data:
-        a sequence or mapping of numpy arrays
-        By providing a mapping of data arrays, the remaining parameters are not needed
-    time:
-        a pandas.DatetimeIndex with the time instances of the data
-    items:
-        a list of ItemInfo with name, type and unit
-    geometry:
-        a geometry object e.g. Grid2D or GeometryFM2D
-    zn:
-        only relevant for Dfsu3d
-    dims:
-        named dimensions
+        Data arrays used to create a dataset.
     validate:
         Optional validation of consistency of data arrays.
-    dt:
-        placeholder timestep
-
 
     Notes
     ---------------
@@ -99,66 +83,13 @@ class Dataset:
 
     """
 
-    @overload
-    @deprecated(
-        "Supplying data as a list of numpy arrays is deprecated. Use Dataset.from_numpy instead"
-    )
-    def __init__(
-        self,
-        data: (Sequence[NDArray[np.floating]]),
-        time: pd.DatetimeIndex | None = None,
-        items: Sequence[ItemInfo] | None = None,
-        geometry: Any = None,
-        zn: NDArray[np.floating] | None = None,
-        dims: tuple[str, ...] | None = None,
-        validate: bool = True,
-        dt: float = 1.0,
-    ): ...
-
-    @overload
     def __init__(
         self,
         data: (Mapping[str, DataArray] | Sequence[DataArray]),
-        time: pd.DatetimeIndex | None = None,
-        items: Sequence[ItemInfo] | None = None,
-        geometry: Any = None,
-        zn: NDArray[np.floating] | None = None,
-        dims: tuple[str, ...] | None = None,
-        validate: bool = True,
-        dt: float = 1.0,
-    ): ...
-
-    def __init__(
-        self,
-        data: (
-            Mapping[str, DataArray]
-            | Sequence[DataArray]
-            | Sequence[NDArray[np.floating]]
-        ),
-        time: pd.DatetimeIndex | None = None,
-        items: Sequence[ItemInfo] | None = None,
-        geometry: Any = None,
-        zn: NDArray[np.floating] | None = None,
-        dims: tuple[str, ...] | None = None,
         validate: bool = True,
-        dt: float = 1.0,
     ):
-        if not self._is_DataArrays(data):
-            warnings.warn(
-                "Supplying data as a list of numpy arrays is deprecated. Use Dataset.from_numpy",
-                FutureWarning,
-            )
-            data = self._create_dataarrays(
-                data=data,
-                time=time,
-                items=items,
-                geometry=geometry,
-                zn=zn,
-                dims=dims,
-                dt=dt,
-            )
         self._data_vars = self._init_from_DataArrays(
-            data,  # type: ignore
+            data,
             validate=validate,
         )
         self.plot = _DatasetPlotter(self)
@@ -172,9 +103,28 @@ def from_numpy(
         geometry: Any | None = None,
         zn: NDArray[np.floating] | None = None,
         dims: tuple[str, ...] | None = None,
-        validate: bool = True,
         dt: float = 1.0,
     ) -> Dataset:
+        """Create Dataset from list of NumPy arrays.
+
+        Parameters
+        ----------
+        data:
+            a sequence or mapping of numpy arrays
+        time:
+            a pandas.DatetimeIndex with the time instances of the data
+        items:
+            a list of ItemInfo with name, type and unit
+        geometry:
+            a geometry object e.g. Grid2D or GeometryFM2D
+        zn:
+            only relevant for Dfsu3d
+        dims:
+            named dimensions
+        dt:
+            placeholder timestep
+
+        """
         das = Dataset._create_dataarrays(
             data=data,
             time=time,
@@ -184,27 +134,8 @@ def from_numpy(
             dims=dims,
             dt=dt,
         )
-
         return Dataset(das)
 
-    @staticmethod
-    def _is_DataArrays(data: Any) -> bool:
-        """Check if input is Sequence/Mapping of DataArrays."""
-        if isinstance(data, (Dataset, DataArray)):
-            return True
-        if isinstance(data, Mapping):
-            for da in data.values():
-                if not isinstance(da, DataArray):
-                    raise TypeError("Please provide List/Mapping of DataArrays")
-            return True
-        if isinstance(data, Iterable):
-            for da in data:
-                if not isinstance(da, DataArray):
-                    return False
-                    # raise TypeError("Please provide List/Mapping of DataArrays")
-            return True
-        return False
-
     @staticmethod
     def _create_dataarrays(
         data: Any,

mikeio/dfs/_dfs0.py

@@ -176,7 +176,7 @@ def read(
             fitems = [self.items[it] for it in item_numbers]
         else:
             fitems = self.items
-        ds = Dataset.from_numpy(fdata, time=ftime, items=fitems, validate=False)
+        ds = Dataset.from_numpy(fdata, time=ftime, items=fitems)
 
         # select time steps
         self._n_timesteps = dfs.FileInfo.TimeAxis.NumberOfTimeSteps

mikeio/dfs/_dfs1.py

@@ -181,7 +181,6 @@ def read(
             items=items,
             dims=tuple(dims),
             geometry=self.geometry,
-            validate=False,
             dt=self._timestep,
         )
 

mikeio/dfs/_dfs2.py

@@ -249,7 +249,6 @@ def read(
             items=items,
             geometry=geometry,
             dims=dims,
-            validate=False,
         )
 
     def append(self, ds: Dataset, validate: bool = True) -> None:

mikeio/dfs/_dfs3.py

@@ -273,7 +273,6 @@ def read(
             items=items,
             geometry=geometry,
             dims=dims,
-            validate=False,
         )
 
     def append(self, ds: Dataset, validate: bool = True) -> None:

mikeio/dfsu/_dfsu.py

@@ -420,7 +420,6 @@ def read(
             items=item_infos,
             geometry=geometry,
             dims=dims,
-            validate=False,
             dt=self.timestep,
         )
 

mikeio/dfsu/_layered.py

@@ -369,7 +369,6 @@ def read(
                 geometry=geometry,
                 zn=data_list[0],
                 dims=dims,
-                validate=False,
                 dt=self.timestep,
             )
         else:
@@ -379,7 +378,6 @@ def read(
                 items=items,
                 geometry=geometry,
                 dims=dims,
-                validate=False,
                 dt=self.timestep,
             )
 

mikeio/dfsu/_spectral.py

@@ -398,7 +398,6 @@ def read(
             items=items,
             geometry=geometry,
             dims=dims,
-            validate=False,
         )
 
     def _parse_geometry_sel(

tests/test_dataset.py

@@ -53,11 +53,6 @@ def ds3():
     return mikeio.Dataset.from_numpy(data=data, time=time, items=items)
 
 
-def test_list_of_numpy_deprecated() -> None:
-    with pytest.warns(FutureWarning, match="from_numpy"):
-        mikeio.Dataset([np.zeros(2)], pd.date_range("2000-1-2", freq="h", periods=2))
-
-
 def test_create_wrong_data_type_error():
     data = ["item 1", "item 2"]