#237 Add api module

Author: astropenguin

xarray_dataclasses/__init__.py

@@ -1,19 +1,27 @@
 __all__ = [
     # submodules
+    "api",
     "typing",
     # aliases
     "Attr",
     "Coord",
     "Data",
     "Multiple",
     "Tag",
+    "asarray",
+    "asdataarray",
+    "asdataset",
+    "asset",
+    "asxarray",
 ]
 __version__ = "2.0.0"
 
 
 # submodules
+from . import api
 from . import typing
 
 
 # aliases
+from .api import *
 from .typing import *

xarray_dataclasses/api.py

@@ -0,0 +1,62 @@
+__all__ = ["asarray", "asdataarray", "asdataset", "asset", "asxarray"]
+
+
+# standard library
+from typing import Any, Callable, overload
+
+
+# dependencies
+from xarray import DataArray, Dataset
+from .typing import P, DataClass, DataClassOf, TArray, TSet, TXarray
+
+
+@overload
+def asarray(obj: DataClass[P], /, *, factory: Callable[..., TArray]) -> TArray: ...
+
+
+@overload
+def asarray(obj: DataClassOf[TArray, P], /) -> TArray: ...
+
+
+@overload
+def asarray(obj: DataClass[P], /) -> DataArray: ...
+
+
+def asarray(obj: Any, /, *, factory: Any = None) -> Any:
+    pass
+
+
+@overload
+def asset(obj: DataClass[P], /, *, factory: Callable[..., TSet]) -> TSet: ...
+
+
+@overload
+def asset(obj: DataClassOf[TSet, P], /) -> TSet: ...
+
+
+@overload
+def asset(obj: DataClass[P], /) -> Dataset: ...
+
+
+def asset(obj: Any, /, *, factory: Any = None) -> Any:
+    pass
+
+
+@overload
+def asxarray(obj: DataClass[P], /, *, factory: Callable[..., TXarray]) -> TXarray: ...
+
+
+@overload
+def asxarray(obj: DataClassOf[TXarray, P], /) -> TXarray: ...
+
+
+def asxarray(obj: Any, /, *, factory: Any = None) -> Any:
+    pass
+
+
+# function aliases
+asdataarray = asarray
+"""Alias of ``api.asdataarray``."""
+
+asdataset = asset
+"""Alias of ``api.asset``."""