Skip to content

Commit 9a19d11

Browse files
authored
Make the first argument in DataTree.from_dict positional only (#9446)
The fact that it has the non-descriptive name "d" is a good indication that users should not be supplying it as a keyword argument. (Alternatively, we could make a more descriptive name, but I think positional only is also fine for now.)
1 parent f97f999 commit 9a19d11

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

xarray/core/datatree.py

+1
Original file line numberDiff line numberDiff line change
@@ -1046,6 +1046,7 @@ def drop_nodes(
10461046
def from_dict(
10471047
cls,
10481048
d: Mapping[str, Dataset | DataTree | None],
1049+
/,
10491050
name: str | None = None,
10501051
) -> DataTree:
10511052
"""

xarray/tests/test_datatree.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1072,7 +1072,7 @@ def test_match(self):
10721072

10731073
def test_filter(self):
10741074
simpsons = DataTree.from_dict(
1075-
d={
1075+
{
10761076
"/": xr.Dataset({"age": 83}),
10771077
"/Herbert": xr.Dataset({"age": 40}),
10781078
"/Homer": xr.Dataset({"age": 39}),
@@ -1083,7 +1083,7 @@ def test_filter(self):
10831083
name="Abe",
10841084
)
10851085
expected = DataTree.from_dict(
1086-
d={
1086+
{
10871087
"/": xr.Dataset({"age": 83}),
10881088
"/Herbert": xr.Dataset({"age": 40}),
10891089
"/Homer": xr.Dataset({"age": 39}),

xarray/tests/test_datatree_mapping.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ def test_not_a_tree(self):
1919
check_isomorphic("s", 1) # type: ignore[arg-type]
2020

2121
def test_different_widths(self):
22-
dt1 = DataTree.from_dict(d={"a": empty})
23-
dt2 = DataTree.from_dict(d={"b": empty, "c": empty})
22+
dt1 = DataTree.from_dict({"a": empty})
23+
dt2 = DataTree.from_dict({"b": empty, "c": empty})
2424
expected_err_str = (
2525
"Number of children on node '/' of the left object: 1\n"
2626
"Number of children on node '/' of the right object: 2"
@@ -320,7 +320,7 @@ def weighted_mean(ds):
320320

321321
def test_alter_inplace_forbidden(self):
322322
simpsons = DataTree.from_dict(
323-
d={
323+
{
324324
"/": xr.Dataset({"age": 83}),
325325
"/Herbert": xr.Dataset({"age": 40}),
326326
"/Homer": xr.Dataset({"age": 39}),

0 commit comments

Comments
 (0)