New test for method

Author: FBumann

tests/test_accessor.py

@@ -9,6 +9,32 @@
 import xarray as xr
 
 import xarray_plotly  # noqa: F401 - registers accessor
+from xarray_plotly import xpx
+
+
+class TestXpxFunction:
+    """Tests for the xpx() function."""
+
+    def test_xpx_returns_accessor(self) -> None:
+        """Test that xpx() returns a DataArrayPlotlyAccessor."""
+        da = xr.DataArray(np.random.rand(10), dims=["time"])
+        accessor = xpx(da)
+        assert hasattr(accessor, "line")
+        assert hasattr(accessor, "bar")
+        assert hasattr(accessor, "scatter")
+
+    def test_xpx_equivalent_to_accessor(self) -> None:
+        """Test that xpx(da).line() works the same as da.plotly.line()."""
+        da = xr.DataArray(
+            np.random.rand(10, 3),
+            dims=["time", "city"],
+            coords={"time": np.arange(10), "city": ["A", "B", "C"]},
+            name="test",
+        )
+        fig1 = xpx(da).line()
+        fig2 = da.plotly.line()
+        assert isinstance(fig1, go.Figure)
+        assert isinstance(fig2, go.Figure)
 
 
 class TestDataArrayPxplot:

xarray_plotly/__init__.py

@@ -1,28 +1,28 @@
 """
-xarray_plotly: Interactive Plotly Express plotting accessor for xarray.
+xarray_plotly: Interactive Plotly Express plotting for xarray.
 
-This package provides a `plotly` accessor for xarray DataArray objects that
-enables interactive plotting using Plotly Express.
+This package provides interactive plotting for xarray DataArray objects
+using Plotly Express.
 
 Examples
 --------
 >>> import xarray as xr
 >>> import numpy as np
->>> import xarray_plotly  # registers the accessor
+>>> from xarray_plotly import xpx
 
 >>> da = xr.DataArray(
 ...     np.random.rand(10, 3, 2),
 ...     dims=["time", "city", "scenario"],
 ... )
 
 >>> # Auto-assignment: time->x, city->color, scenario->facet_col
->>> fig = da.plotly.line()
+>>> fig = xpx(da).line()
 
 >>> # Explicit assignment
->>> fig = da.plotly.line(x="time", color="scenario", facet_col="city")
+>>> fig = xpx(da).line(x="time", color="scenario", facet_col="city")
 
 >>> # Skip a slot
->>> fig = da.plotly.line(color=None)  # time->x, city->facet_col, scenario->facet_row
+>>> fig = xpx(da).line(color=None)  # time->x, city->facet_col, scenario->facet_row
 """
 
 from importlib.metadata import version