Merge pull request #811 from DHI/deprecated

Use new @deprecated decorator.

Author: ecomodeller

mikeio/dataset/_dataset.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 from pathlib import Path
-import warnings
 from datetime import datetime
 from copy import deepcopy
 from typing import (
@@ -16,6 +15,9 @@
     TYPE_CHECKING,
     Callable,
 )
+import warnings
+from typing_extensions import deprecated
+# from warnings import deprecated
 
 
 import numpy as np
@@ -97,6 +99,35 @@ 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: (

pyproject.toml

@@ -30,6 +30,7 @@ dependencies = [
     "PyYAML",
     "tqdm",
     "xarray",
+    "typing-extensions",
 ]
 
 authors = [