Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
35 changes: 20 additions & 15 deletions lib/ncdata/utils/_rename_dim.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,25 @@ def _rename_dims_in_vars(ncdata: NcData, name_from: str, name_to: str) -> None:
_rename_dims_in_vars(grp, name_from, name_to)


def _check_name_collisions(ncdata, name_from, name_to, group_path=""):
if name_to in ncdata.dimensions:
inner = f' in group "{group_path}"' if group_path else ""
msg = (
f"Cannot rename dimension {name_from!r} to {name_to!r}, "
f"because a {name_to!r} dimension already exists{inner}."
)
raise ValueError(msg)

for group in ncdata.groups.values():
if name_from in group.dimensions:
# Skip this group as its 'name_from' dim makes it a "scope hole".
continue
inner_path = group_path + "/" + group.name
_check_name_collisions(
group, name_from, name_to, group_path=inner_path
)


def rename_dimension(ncdata: NcData, name_from: str, name_to: str) -> None:
"""
Rename a dimension of an :class:`~ncdata.NcData`.
Expand Down Expand Up @@ -47,20 +66,6 @@ def rename_dimension(ncdata: NcData, name_from: str, name_to: str) -> None:
of the new name already exists, and if so raises an error.

"""

def check_name_collides(ncdata, name_to, group_path=""):
if name_to in ncdata.dimensions:
inner = f' in group "{group_path}"' if group_path else ""
msg = (
f"Cannot rename dimension {name_from!r} to {name_to!r}, "
f"because a {name_to!r} dimension already exists{inner}."
)
raise ValueError(msg)

for group in ncdata.groups.values():
inner_path = group_path + "/" + group.name
check_name_collides(group, name_to, group_path=inner_path)

check_name_collides(ncdata, name_to)
_check_name_collisions(ncdata, name_from, name_to)
ncdata.dimensions.rename(name_from, name_to)
_rename_dims_in_vars(ncdata, name_from, name_to)
11 changes: 11 additions & 0 deletions tests/unit/utils/test_rename_dimension.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,17 @@ def test_name_collision_ingroup_fail(self, innergroup):
with pytest.raises(ValueError, match=msg):
rename_dimension(ncdata, "x", "z")

def test_name_ingroup_masked_nofail(self):
ncdata = self.ncdata
ncdata.groups.add(
NcData(
name="inner",
dimensions=[NcDimension("x", 2), NcDimension("z", 2)],
)
)
# No error in this case, because the "z" is inside a group with its own "x".
rename_dimension(ncdata, "x", "z")

@pytest.fixture()
def group_example(self, setup):
ncdata = self.ncdata.copy()
Expand Down
Loading