#157 Rename type hint (DataType → AnyXarray)

Author: astropenguin

xarray_dataclasses/dataarray.py

@@ -28,7 +28,7 @@
 # submodules
 from .datamodel import DataModel
 from .dataoptions import DataOptions
-from .typing import AnyArray, AnyField, DataClass, DataType, Order, Shape, Sizes
+from .typing import AnyArray, AnyField, AnyXarray, DataClass, Order, Shape, Sizes
 
 
 # type hints
@@ -50,7 +50,7 @@ def __init__(self, *args: PInit.args, **kwargs: PInit.kwargs) -> None:
 @overload
 def asdataarray(
     dataclass: OptionedClass[PInit, TDataArray],
-    reference: Optional[DataType] = None,
+    reference: Optional[AnyXarray] = None,
     dataoptions: None = None,
 ) -> TDataArray:
     ...
@@ -59,7 +59,7 @@ def asdataarray(
 @overload
 def asdataarray(
     dataclass: DataClass[PInit],
-    reference: Optional[DataType] = None,
+    reference: Optional[AnyXarray] = None,
     dataoptions: None = None,
 ) -> xr.DataArray:
     ...
@@ -68,15 +68,15 @@ def asdataarray(
 @overload
 def asdataarray(
     dataclass: Any,
-    reference: Optional[DataType] = None,
+    reference: Optional[AnyXarray] = None,
     dataoptions: DataOptions[TDataArray] = DataOptions(xr.DataArray),
 ) -> TDataArray:
     ...
 
 
 def asdataarray(
     dataclass: Any,
-    reference: Optional[DataType] = None,
+    reference: Optional[AnyXarray] = None,
     dataoptions: Any = None,
 ) -> Any:
     """Create a DataArray object from a dataclass object.

xarray_dataclasses/datamodel.py

@@ -18,7 +18,7 @@
     AnyDType,
     AnyField,
     DataClass,
-    DataType,
+    AnyXarray,
     Dims,
     FType,
     get_annotated,
@@ -120,7 +120,7 @@ def __post_init__(self) -> None:
         if model.names:
             setattr(self, "name", model.names[0].value)
 
-    def __call__(self, reference: Optional[DataType] = None) -> xr.DataArray:
+    def __call__(self, reference: Optional[AnyXarray] = None) -> xr.DataArray:
         """Create a DataArray object according to the entry."""
         from .dataarray import asdataarray
 
@@ -240,7 +240,7 @@ def get_typedarray(
     data: Any,
     dims: Dims,
     dtype: Optional[AnyDType],
-    reference: Optional[DataType] = None,
+    reference: Optional[AnyXarray] = None,
 ) -> xr.DataArray:
     """Create a DataArray object with given dims and dtype.
 

xarray_dataclasses/dataoptions.py

@@ -8,17 +8,17 @@
 
 
 # submodules
-from .typing import DataType
+from .typing import AnyXarray
 
 
 # type hints
-TDataType = TypeVar("TDataType", bound=DataType)
+TAnyXarray = TypeVar("TAnyXarray", bound=AnyXarray)
 
 
 # dataclasses
 @dataclass(frozen=True)
-class DataOptions(Generic[TDataType]):
+class DataOptions(Generic[TAnyXarray]):
     """Options for DataArray or Dataset creation."""
 
-    factory: Callable[..., TDataType]
+    factory: Callable[..., TAnyXarray]
     """Factory function for DataArray or Dataset."""

xarray_dataclasses/dataset.py

@@ -18,7 +18,7 @@
 # submodules
 from .datamodel import DataModel
 from .dataoptions import DataOptions
-from .typing import AnyArray, AnyField, DataClass, DataType, Order, Shape, Sizes
+from .typing import AnyArray, AnyField, AnyXarray, DataClass, Order, Shape, Sizes
 
 
 # type hints
@@ -40,7 +40,7 @@ def __init__(self, *args: PInit.args, **kwargs: PInit.kwargs) -> None:
 @overload
 def asdataset(
     dataclass: OptionedClass[PInit, TDataset],
-    reference: Optional[DataType] = None,
+    reference: Optional[AnyXarray] = None,
     dataoptions: None = None,
 ) -> TDataset:
     ...
@@ -49,7 +49,7 @@ def asdataset(
 @overload
 def asdataset(
     dataclass: DataClass[PInit],
-    reference: Optional[DataType] = None,
+    reference: Optional[AnyXarray] = None,
     dataoptions: None = None,
 ) -> xr.Dataset:
     ...
@@ -58,15 +58,15 @@ def asdataset(
 @overload
 def asdataset(
     dataclass: Any,
-    reference: Optional[DataType] = None,
+    reference: Optional[AnyXarray] = None,
     dataoptions: DataOptions[TDataset] = DataOptions(xr.Dataset),
 ) -> TDataset:
     ...
 
 
 def asdataset(
     dataclass: Any,
-    reference: Optional[DataType] = None,
+    reference: Optional[AnyXarray] = None,
     dataoptions: Any = None,
 ) -> Any:
     """Create a Dataset object from a dataclass object.

xarray_dataclasses/typing.py

@@ -64,9 +64,8 @@
 AnyArray: TypeAlias = "np.ndarray[Any, Any]"
 AnyDType: TypeAlias = "np.dtype[Any]"
 AnyField: TypeAlias = "Field[Any]"
-DataType = Union[xr.DataArray, xr.Dataset]
+AnyXarray = Union[xr.DataArray, xr.Dataset]
 Dims = Tuple[str, ...]
-Dtype = Optional[str]
 Order = Literal["C", "F"]
 Shape = Union[Sequence[int], int]
 Sizes = Dict[str, int]