Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions xarray/core/datatree.py
Original file line number Diff line number Diff line change
Expand Up @@ -910,6 +910,26 @@ def __setitem__(
else:
raise ValueError("Invalid format for key")

def __delitem__(self, key: str) -> None:
"""Remove a variable or child node from this datatree node."""
if key in self.children:
super().__delitem__(key)

elif key in self._node_coord_variables:
if key in self._node_indexes:
del self._node_indexes[key]
del self._node_coord_variables[key]
self._node_dims = calculate_dimensions(self.variables)

elif key in self._data_variables:
del self._data_variables[key]
self._node_dims = calculate_dimensions(self.variables)

else:
raise KeyError(
f"Cannot delete key '{key}' as it was not found on this datatree node. Must be one of {list(self)}"
)

@overload
def update(self, other: Dataset) -> None: ...

Expand Down
4 changes: 2 additions & 2 deletions xarray/core/treenode.py
Original file line number Diff line number Diff line change
Expand Up @@ -559,14 +559,14 @@ def _set_item(
else:
current_node._set(name, item)

def __delitem__(self: Tree, key: str):
def __delitem__(self: Tree, key: str) -> None:
"""Remove a child node from this tree object."""
if key in self.children:
child = self._children[key]
del self._children[key]
child.orphan()
else:
raise KeyError("Cannot delete")
raise KeyError(f"Child node {key} not found")

def same_tree(self, other: Tree) -> bool:
"""True if other node is in the same tree as this node."""
Expand Down
27 changes: 26 additions & 1 deletion xarray/tests/test_datatree.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import pytest

import xarray as xr
from xarray import Dataset
from xarray.core.datatree import DataTree
from xarray.core.datatree_ops import _MAPPED_DOCSTRING_ADDENDUM, insert_doc_addendum
from xarray.core.treenode import NotFoundInTreeError
Expand Down Expand Up @@ -525,7 +526,31 @@ def test_setitem_dataarray_replace_existing_node(self):
assert_identical(results.to_dataset(), expected)


class TestDictionaryInterface: ...
def test_delitem():
ds = Dataset({"a": 0}, coords={"x": ("x", [1, 2]), "z": "a"})
dt = DataTree(ds, children={"c": DataTree()})

# test delete children
del dt["c"]
assert dt.children == {}
assert set(dt.variables) == {"x", "z", "a"}

# test delete variables
del dt["a"]
assert set(dt.coords) == {"x", "z"}

# test delete coordinates
del dt["z"]
assert set(dt.coords) == {"x"}

# test delete indexed coordinates
del dt["x"]
assert dt.variables == {}
assert dt.coords == {}
assert dt.indexes == {}

with pytest.raises(KeyError, match="Cannot delete key 'foo' as it was not found"):
del dt["foo"]


class TestTreeFromDict:
Expand Down