extending

narwhals-dev · Mar 17, 2024 · 64a4093 · 64a4093
1 parent 11ef9b6
commit 64a4093
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/docs/extending.md b/docs/extending.md
@@ -0,0 +1,2 @@
+# How Narwhals can support your dataframe as well!
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,6 +8,7 @@ nav:
     - basics/dataframe.md
     - basics/column.md
     - basics/complete_example.md
+  - Extending: extending.md
   - API Reference: reference.md
 theme:
   name: material

diff --git a/narwhals/dataframe.py b/narwhals/dataframe.py
@@ -177,6 +177,9 @@ def __init__(
         ):  # pragma: no cover
             self._dataframe = PandasDataFrame(df, implementation="cudf")
             self._implementation = "cudf"
+        elif hasattr(df, "__narwhals_dataframe__"):
+            self._dataframe = df.__narwhals_dataframe__()
+            self._implementation = "custom"
         else:
             msg = f"Expected pandas-like dataframe, Polars dataframe, or Polars lazyframe, got: {type(df)}"
             raise TypeError(msg)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# How Narwhals can support your dataframe as well!