Merge pull request #823 from DHI/getitem_time

Deprecate time slicing using getitem.

Author: ecomodeller

docs/user-guide/dataarray.qmd

@@ -29,14 +29,25 @@ da
 
 ## {{< fa calendar >}} Temporal selection
 
+A time slice of a DataArray can be selected in several different ways. 
+
 ```{python}
 da.sel(time="1985-08-06 12:00")
 ```
 
 ```{python}
-da["1985-8-7":]
+da.sel(time=slice("1985-08-06 12:00", "1985-08-06 17:00"))
+```
+
+```{python}
+da.isel(time=2)
 ```
 
+```{python}
+da.isel(time=range(2, ds.n_timesteps, 2))
+```
+
+
 ## {{< fa map >}} Spatial selection
              
 The [`sel`](`mikeio.DataArray.sel`) method finds the nearest element.

docs/user-guide/dataset.qmd

@@ -58,9 +58,20 @@ ds.sel(time="1985-08-06 12:00")
 ```
 
 ```{python}
-ds["1985-8-7":]
+ds.sel(time=slice("1985-08-06 12:00", "1985-08-06 17:00"))
 ```
 
+```{python}
+ds.isel(time=2)
+```
+
+```{python}
+ds.isel(time=range(2, ds.n_timesteps, 2))
+```
+
+
+
+
 ## {{< fa map >}} Spatial selection
 
 The `sel` method finds a single element.

mikeio/dataset/_dataarray.py

@@ -629,6 +629,24 @@ def __getitem__(self, key: Any) -> "DataArray":
         return da
 
     def _getitem_parse_key(self, key: Any) -> Any:
+        if isinstance(key, str):
+            warnings.warn(
+                "Indexing with strings is deprecated. Only integer indexing is allowed. Otherwise use .sel(time=...).",
+                FutureWarning,
+            )
+        if isinstance(key, slice):
+            if isinstance(key.start, str) or isinstance(key.stop, str):
+                warnings.warn(
+                    "Indexing with strings is deprecated. Only integer indexing is allowed. Otherwise use .sel(time=...).",
+                    FutureWarning,
+                )
+        if isinstance(key, Iterable):
+            if any([isinstance(k, str) for k in key]):
+                warnings.warn(
+                    "Indexing with strings is deprecated. Only integer indexing is allowed. Otherwise use .sel(time=...).",
+                    FutureWarning,
+                )
+
         key = key if isinstance(key, tuple) else (key,)
         if len(key) > len(self.dims):
             raise IndexError(

mikeio/dataset/_dataset.py

@@ -740,6 +740,10 @@ def __getitem__(self, key: Any) -> DataArray | "Dataset":
             time_steps = _get_time_idx_list(self.time, key)
             if _n_selected_timesteps(self.time, time_steps) == 0:
                 raise IndexError("No timesteps found!")
+            warnings.warn(
+                "Subsetting in time using indexing is deprecated. Use .sel(time=...) or .isel(time=...) instead.",
+                FutureWarning,
+            )
             return self.isel(time=time_steps)
         if isinstance(key, slice):
             if self._is_slice_time_slice(key):
@@ -748,6 +752,11 @@ def __getitem__(self, key: Any) -> DataArray | "Dataset":
                     time_steps = list(range(s.start, s.stop))
                 except ValueError:
                     time_steps = list(range(*key.indices(len(self.time))))
+                # deprecated, use sel instead or isel instead
+                warnings.warn(
+                    "Subsetting in time using indexing is deprecated. Use .sel(time=...) or .isel(time=...) instead.",
+                    FutureWarning,
+                )
                 return self.isel(time=time_steps)
 
         if self._multi_indexing_attempted(key):

tests/test_consistency.py

@@ -258,10 +258,6 @@ def test_read_dfs_time_selection_str() -> None:
         assert all(dsr.time == dssel.time)
         assert dsr.shape == dssel.shape
 
-        dsgetitem = ds[time]
-        assert all(dsr.time == dsgetitem.time)
-        assert dsr.shape == dsgetitem.shape
-
 
 def test_open_dfs_repr() -> None:
     extensions = ["dfsu", "dfs2", "dfs1", "dfs0"]
@@ -286,10 +282,6 @@ def test_read_dfs_time_selection_str_specific() -> None:
         assert all(dsr.time == dssel.time)
         assert dsr.shape == dssel.shape
 
-        dsgetitem = ds[time]
-        assert all(dsr.time == dsgetitem.time)
-        assert dsr.shape == dsgetitem.shape
-
 
 def test_read_dfs_time_selection_list_str() -> None:
     extensions = ["dfsu", "dfs2", "dfs1", "dfs0"]
@@ -304,10 +296,6 @@ def test_read_dfs_time_selection_list_str() -> None:
         assert all(dsr.time == dssel.time)
         assert dsr.shape == dssel.shape
 
-        dsgetitem = ds[time]
-        assert all(dsr.time == dsgetitem.time)
-        assert dsr.shape == dsgetitem.shape
-
 
 def test_read_dfs_time_selection_pdTimestamp() -> None:
     extensions = ["dfsu", "dfs2", "dfs1", "dfs0"]
@@ -323,10 +311,6 @@ def test_read_dfs_time_selection_pdTimestamp() -> None:
         assert all(dsr.time == dssel.time)
         assert dsr.shape == dssel.shape
 
-        dsgetitem = ds[time]
-        assert all(dsr.time == dsgetitem.time)
-        assert dsr.shape == dsgetitem.shape
-
 
 def test_read_dfs_time_selection_pdDatetimeIndex() -> None:
     extensions = ["dfsu", "dfs2", "dfs1", "dfs0"]
@@ -341,10 +325,6 @@ def test_read_dfs_time_selection_pdDatetimeIndex() -> None:
         assert all(dsr.time == dssel.time)
         assert dsr.shape == dssel.shape
 
-        dsgetitem = ds[time]
-        assert all(dsr.time == dsgetitem.time)
-        assert dsr.shape == dsgetitem.shape
-
 
 def test_read_dfs_time_selection_datetime() -> None:
     extensions = ["dfsu", "dfs2", "dfs1", "dfs0"]
@@ -360,10 +340,6 @@ def test_read_dfs_time_selection_datetime() -> None:
         assert all(dsr.time == dssel.time)
         assert dsr.shape == dssel.shape
 
-        dsgetitem = ds[time]
-        assert all(dsr.time == dsgetitem.time)
-        assert dsr.shape == dsgetitem.shape
-
         dsr2 = mikeio.read(filename=filename, time=pd.Timestamp(time))
         assert all(dsr2.time == dsr.time)
         assert dsr2.shape == dsr.shape
@@ -382,10 +358,6 @@ def test_read_dfs_time_list_datetime() -> None:
         assert all(dsr.time == dssel.time)
         assert dsr.shape == dssel.shape
 
-        dsgetitem = ds[time]
-        assert all(dsr.time == dsgetitem.time)
-        assert dsr.shape == dsgetitem.shape
-
 
 def test_read_dfs_time_slice_datetime() -> None:
     extensions = ["dfsu", "dfs2", "dfs1", "dfs0"]
@@ -400,10 +372,6 @@ def test_read_dfs_time_slice_datetime() -> None:
         assert all(dsr.time == dssel.time)
         assert dsr.shape == dssel.shape
 
-        dsgetitem = ds[time]
-        assert all(dsr.time == dsgetitem.time)
-        assert dsr.shape == dsgetitem.shape
-
 
 def test_read_dfs_time_slice_str() -> None:
     extensions = ["dfsu", "dfs2", "dfs1", "dfs0"]
@@ -418,10 +386,6 @@ def test_read_dfs_time_slice_str() -> None:
         assert all(dsr.time == dssel.time)
         assert dsr.shape == dssel.shape
 
-        dsgetitem = ds[time]
-        assert all(dsr.time == dsgetitem.time)
-        assert dsr.shape == dsgetitem.shape
-
 
 def test_read_dfs_time_selection_str_slice() -> None:
     extensions = ["dfs0", "dfs2", "dfs1", "dfs0"]
@@ -437,10 +401,6 @@ def test_read_dfs_time_selection_str_slice() -> None:
         assert all(dsr.time == dssel.time)
         assert dsr.shape == dssel.shape
 
-        dsgetitem = ds[time]
-        assert all(dsr.time == dsgetitem.time)
-        assert dsr.shape == dsgetitem.shape
-
 
 def test_read_dfs_time_int() -> None:
     extensions = ["dfsu", "dfs2", "dfs1", "dfs0"]
@@ -456,11 +416,6 @@ def test_read_dfs_time_int() -> None:
         assert all(dsr.time == dssel.time)
         assert dsr.shape == dssel.shape
 
-        # integer time selection for DataArray (not Dataset)
-        dsgetitem = ds[0][time]
-        assert all(dsr[0].time == dsgetitem.time)
-        assert dsr[0].shape == dsgetitem.shape
-
 
 def test_read_dfs_time_list_int() -> None:
     extensions = ["dfsu", "dfs2", "dfs1", "dfs0"]
@@ -475,11 +430,6 @@ def test_read_dfs_time_list_int() -> None:
         assert all(dsr.time == dssel.time)
         assert dsr.shape == dssel.shape
 
-        # integer time selection for DataArray (not Dataset)
-        dsgetitem = ds[0][time]
-        assert all(dsr[0].time == dsgetitem.time)
-        assert dsr[0].shape == dsgetitem.shape
-
 
 def test_read_dfs_time_slice_int() -> None:
     extensions = ["dfsu", "dfs2", "dfs1", "dfs0"]
@@ -531,7 +481,7 @@ def test_filter_items_dfs0() -> None:
 def test_filter_items_wildcard_getitem() -> None:
     dsall = mikeio.read("tests/testdata/sw_points.dfs0")
 
-    ds = dsall["*Height*"]
+    ds = dsall["*Height*"]  # type: ignore
     assert ds.n_items == 12
 
 
@@ -543,7 +493,7 @@ def test_filter_items_dfsu() -> None:
 def test_filter_items_dfsu_getitem() -> None:
     dsall = mikeio.read("tests/testdata/wind_north_sea.dfsu")
     ds = dsall["*direction*"]
-    assert ds.n_items == 1
+    assert ds.n_items == 1  # type: ignore
     assert "direction" in ds[0].name
 
 

tests/test_dataarray.py

@@ -549,20 +549,25 @@ def test_dataarray_grid3d_indexing() -> None:
 def test_dataarray_getitem_time(da_grid2d: DataArray) -> None:
     da = da_grid2d
     # time=pd.date_range("2000-01-01", freq="h", periods=10)
-    da_sel = da["2000-1-1"]
+    # deprecated use .sel(time=...) or .isel(time=...) instead
+    with pytest.warns(FutureWarning, match="string"):
+        da_sel = da["2000-1-1"]
     assert da_sel.n_timesteps == da.n_timesteps
     assert da_sel.is_equidistant
 
-    da_sel = da["2000-1-1 02:00":"2000-1-1 05:00"]  # type: ignore
+    with pytest.warns(FutureWarning, match="string"):
+        da_sel = da["2000-1-1 02:00":"2000-1-1 05:00"]  # type: ignore
     assert da_sel.n_timesteps == 4
     assert da_sel.is_equidistant
 
     time = ["2000-1-1 02:00", "2000-1-1 04:00", "2000-1-1 06:00"]
-    da_sel = da[time]
+    with pytest.warns(FutureWarning, match="string"):
+        da_sel = da[time]
     assert da_sel.n_timesteps == 3
     assert da_sel.is_equidistant
 
     time = [da.time[0], da.time[1], da.time[3], da.time[7]]
+    # TODO should this type of indexing be allowed?
     da_sel = da[time]
     assert da_sel.n_timesteps == 4
     assert not da_sel.is_equidistant

tests/test_dataset.py

@@ -163,25 +163,32 @@ def test_index_with_attribute() -> None:
 
 def test_getitem_time(ds3: Dataset) -> None:
     # time = pd.date_range("2000-1-2", freq="h", periods=100)
-    ds_sel = ds3["2000-1-2"]
+
+    # deprecated use .sel(time=...) or .isel(time=...) instead
+    with pytest.warns(FutureWarning, match="time"):
+        ds_sel = ds3["2000-1-2"]  # type: ignore
     assert ds_sel.n_timesteps == 24
     assert ds_sel.is_equidistant
 
-    ds_sel = ds3["2000-1-2":"2000-1-3 00:00"]  # type: ignore
+    with pytest.warns(FutureWarning, match="time"):
+        ds_sel = ds3["2000-1-2":"2000-1-3 00:00"]  # type: ignore
     assert ds_sel.n_timesteps == 25
     assert ds_sel.is_equidistant
 
-    time = ["2000-1-2 04:00:00", "2000-1-2 08:00:00", "2000-1-2 12:00:00"]
-    ds_sel = ds3[time]
+    with pytest.warns(FutureWarning, match="time"):
+        time = ["2000-1-2 04:00:00", "2000-1-2 08:00:00", "2000-1-2 12:00:00"]
+        ds_sel = ds3[time]  # type: ignore
     assert ds_sel.n_timesteps == 3
     assert ds_sel.is_equidistant
 
-    time = [ds3.time[0], ds3.time[1], ds3.time[7], ds3.time[23]]
-    ds_sel = ds3[time]
+    with pytest.warns(FutureWarning, match="time"):
+        time = [ds3.time[0], ds3.time[1], ds3.time[7], ds3.time[23]]
+        ds_sel = ds3[time]  # type: ignore
     assert ds_sel.n_timesteps == 4
     assert not ds_sel.is_equidistant
 
-    ds_sel = ds3[ds3.time[:10]]
+    with pytest.warns(FutureWarning, match="time"):
+        ds_sel = ds3[ds3.time[:10]]  # type: ignore
     assert ds_sel.n_timesteps == 10
     assert ds_sel.is_equidistant
 
@@ -278,18 +285,22 @@ def test_temporal_subset_fancy() -> None:
     assert ds.time[0].hour == 0
     assert ds.time[-1].hour == 0
 
-    selds = ds["2000-01-01 00:00":"2000-01-02 00:00"]  # type: ignore
+    with pytest.warns(FutureWarning, match="time"):
+        selds = ds["2000-01-01 00:00":"2000-01-02 00:00"]  # type: ignore
 
     assert len(selds) == 2
     assert selds["Foo"].shape == (25, 100, 30)
 
-    selds = ds[:"2000-01-02 00:00"]  # type: ignore
+    with pytest.warns(FutureWarning, match="time"):
+        selds = ds[:"2000-01-02 00:00"]  # type: ignore
     assert selds["Foo"].shape == (25, 100, 30)
 
-    selds = ds["2000-01-31 00:00":]  # type: ignore
+    with pytest.warns(FutureWarning, match="time"):
+        selds = ds["2000-01-31 00:00":]  # type: ignore
     assert selds["Foo"].shape == (25, 100, 30)
 
-    selds = ds["2000-01-30":]  # type: ignore
+    with pytest.warns(FutureWarning, match="time"):
+        selds = ds["2000-01-30":]  # type: ignore
     assert selds["Foo"].shape == (49, 100, 30)