Try @deprecated

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,7 @@
     TYPE_CHECKING,
     Callable,
 )
+from warnings import deprecated
 
 
 import numpy as np
@@ -97,6 +97,22 @@ 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,
+    ): ...
+
     def __init__(
         self,
         data: (
@@ -113,10 +129,6 @@ def __init__(
         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,

mikeio/generic.py

@@ -11,7 +11,7 @@
 from shutil import copyfile
 from collections.abc import Iterable, Sequence
 from typing import Callable, Union
-import warnings
+from warnings import deprecated
 
 
 import numpy as np
@@ -329,14 +329,13 @@ def _process_dfs_files(
 
 
 # TODO sum is conflicting with the built-in sum function, which we could haved used above.
+@deprecated("Use add instead.")
 def sum(
     infilename_a: str | pathlib.Path,
     infilename_b: str | pathlib.Path,
     outfilename: str | pathlib.Path,
 ) -> None:
     """Sum two dfs files (a+b)."""
-    # deprecated
-    warnings.warn(FutureWarning("This function is deprecated. Use add instead."))
     _process_dfs_files(infilename_a, infilename_b, outfilename, operator.add)