Skip to content

Add warning for nan_as_null #228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 29, 2023
Merged

Add warning for nan_as_null #228

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions protocol/dataframe_protocol.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,14 +397,16 @@ def __dataframe__(
"""
Construct a new exchange object, potentially changing the parameters.

``nan_as_null`` is a keyword intended for the consumer to tell the
producer to overwrite null values in the data with ``NaN``.
It is intended for cases where the consumer does not support the bit
mask or byte mask that is the producer's native representation.
``nan_as_null`` is a DEPRECATED keyword that should not be used. See warning
below.
``allow_copy`` is a keyword that defines whether or not the library is
allowed to make a copy of the data. For example, copying data would be
necessary if a library supports strided buffers, given that this protocol
specifies contiguous buffers.

WARNING: the ``nan_as_null`` parameter will be removed from the API protocol.
Please avoid passing it as either a positional or keyword argument. Call this
method using ``.__dataframe__(allow_copy=...)``.
"""
pass

Expand Down