File tree 1 file changed +17
-0
lines changed 1 file changed +17
-0
lines changed Original file line number Diff line number Diff line change @@ -819,10 +819,27 @@ def __dataframe__(
819
819
"""
820
820
Return the dataframe exchange object implementing the exchange protocol.
821
821
822
+ Parameters
823
+ ----------
824
+ nan_as_null : bool, default False
825
+ Whether to tell the DataFrame to overwrite null values in the data
826
+ with ``NaN`` (or ``NaT``).
827
+ allow_copy : bool, default True
828
+ Whether to allow memory copying when exporting. If set to False
829
+ it would cause non-zero-copy exports to fail.
830
+
831
+ Returns
832
+ -------
833
+ DataFrame exchange object
834
+ The object which consuming library can use to ingress the dataframe.
835
+
822
836
Notes
823
837
-----
824
838
Details on the exchange protocol:
825
839
https://data-apis.org/dataframe-protocol/latest/index.html
840
+
841
+ `nan_as_null` currently has no effect; once support for nullable extension
842
+ dtypes is added, this value should be propagated to columns.
826
843
"""
827
844
828
845
from pandas .core .exchange .dataframe import PandasDataFrameXchg
You can’t perform that action at this time.
0 commit comments