#91 Rename class attribute (key → name)

Author: astropenguin

tests/test_datamodel.py

@@ -54,28 +54,28 @@ class ColorImage:
 # test functions
 def test_xaxis_attr() -> None:
     item = next(iter(xaxis_model.attr.values()))
-    assert item.key == "units"
+    assert item.name == "units"
     assert item.value == "pixel"
     assert item.type == "builtins.str"
 
 
 def test_xaxis_data() -> None:
     item = next(iter(xaxis_model.data.values()))
-    assert item.key == "data"
+    assert item.name == "data"
     assert item.type == {"dims": ("x",), "dtype": "int"}
     assert item.factory is None
 
 
 def test_yaxis_attr() -> None:
     item = next(iter(yaxis_model.attr.values()))
-    assert item.key == "units"
+    assert item.name == "units"
     assert item.value == "pixel"
     assert item.type == "builtins.str"
 
 
 def test_yaxis_data() -> None:
     item = next(iter(yaxis_model.data.values()))
-    assert item.key == "data"
+    assert item.name == "data"
     assert item.type == {"dims": ("y",), "dtype": "int"}
     assert item.factory is None
 
@@ -84,24 +84,24 @@ def test_image_coord() -> None:
     items = iter(image_model.coord.values())
 
     item = next(items)
-    assert item.key == "mask"
+    assert item.name == "mask"
     assert item.type == {"dims": ("x", "y"), "dtype": "bool"}
     assert item.factory is None
 
     item = next(items)
-    assert item.key == "x"
+    assert item.name == "x"
     assert item.type == {"dims": ("x",), "dtype": "int"}
     assert item.factory is XAxis
 
     item = next(items)
-    assert item.key == "y"
+    assert item.name == "y"
     assert item.type == {"dims": ("y",), "dtype": "int"}
     assert item.factory is YAxis
 
 
 def test_image_data() -> None:
     item = next(iter(image_model.data.values()))
-    assert item.key == "data"
+    assert item.name == "data"
     assert item.type == {"dims": ("x", "y"), "dtype": "float"}
     assert item.factory is None
 
@@ -110,16 +110,16 @@ def test_color_data() -> None:
     items = iter(color_model.data.values())
 
     item = next(items)
-    assert item.key == "red"
+    assert item.name == "red"
     assert item.type == {"dims": ("x", "y"), "dtype": "float"}
     assert item.factory is Image
 
     item = next(items)
-    assert item.key == "green"
+    assert item.name == "green"
     assert item.type == {"dims": ("x", "y"), "dtype": "float"}
     assert item.factory is Image
 
     item = next(items)
-    assert item.key == "blue"
+    assert item.name == "blue"
     assert item.type == {"dims": ("x", "y"), "dtype": "float"}
     assert item.factory is Image

xarray_dataclasses/dataarray.py

@@ -117,15 +117,15 @@ def asdataarray(
     dataarray = dataoptions.factory(item(reference))
 
     for item in model.coord.values():
-        if item.key in dataarray.dims:
-            dataarray.coords[item.key] = item(dataarray)
+        if item.name in dataarray.dims:
+            dataarray.coords[item.name] = item(dataarray)
 
     for item in model.coord.values():
-        if item.key not in dataarray.dims:
-            dataarray.coords[item.key] = item(dataarray)
+        if item.name not in dataarray.dims:
+            dataarray.coords[item.name] = item(dataarray)
 
     for item in model.attr.values():
-        dataarray.attrs[item.key] = item()
+        dataarray.attrs[item.name] = item()
 
     if model.name:
         item = next(iter(model.name.values()))

xarray_dataclasses/datamodel.py

@@ -37,7 +37,7 @@
 class Data:
     """Field model for data-related fields."""
 
-    key: Hashable
+    name: Hashable
     """Name of the field."""
 
     value: Any
@@ -90,7 +90,7 @@ def from_field(cls, field: Field[Any], value: Any, of: bool) -> "Data":
 class General:
     """Field model for general fields."""
 
-    key: Hashable
+    name: Hashable
     """Name of the field."""
 
     value: Any

xarray_dataclasses/dataset.py

@@ -116,18 +116,18 @@ def asdataset(
     dataset = dataoptions.factory()
 
     for item in model.data.values():
-        dataset[item.key] = item(reference)
+        dataset[item.name] = item(reference)
 
     for item in model.coord.values():
-        if item.key in dataset.dims:
-            dataset.coords[item.key] = item(dataset)
+        if item.name in dataset.dims:
+            dataset.coords[item.name] = item(dataset)
 
     for item in model.coord.values():
-        if item.key not in dataset.dims:
-            dataset.coords[item.key] = item(dataset)
+        if item.name not in dataset.dims:
+            dataset.coords[item.name] = item(dataset)
 
     for item in model.attr.values():
-        dataset.attrs[item.key] = item()
+        dataset.attrs[item.name] = item()
 
     return dataset