Repository navigation
Description
In pyarrow we differentiate between missing (null) values, which we define with a bitmask, and NaN float values.
From the dataframe interchange protocol specification we have understood that one can use NaN to indicate missing values but that does not need to be the case (one can use NaN as a valid value)
dataframe-api/protocol/dataframe_protocol.py
Lines 195 to 213 in 4f7c1e0
| @property | |
| def describe_null(self) -> Tuple[int, Any]: | |
| """ | |
| Return the missing value (or "null") representation the column dtype | |
| uses, as a tuple ``(kind, value)``. | |
| Kind: | |
| - 0 : non-nullable | |
| - 1 : NaN/NaT | |
| - 2 : sentinel value | |
| - 3 : bit mask | |
| - 4 : byte mask | |
| Value : if kind is "sentinel value", the actual value. If kind is a bit | |
| mask or a byte mask, the value (0 or 1) indicating a missing value. None | |
| otherwise. | |
| """ | |
| pass |
There will be disceptancy between pyarrow and pandas, for example, where NaN will be turned into missing value. But we do not think it would be correct for pyarrow to change the null_count property as the information about the difference would be lost for the libraries that would benefit from it. Also the bitmask information and the information in the null_count would need to be made equal.
Is there a way a library could keep the behaviour of not treating NaNs as nulls?
(Connected issue in the arrow repo apache/arrow#34774)
Activity
kkraus14 commentedon Mar 31, 2023
My understanding here is that if PyArrow was exporting the dataframe protocol, it would use option 3 indicating that a bit mask is used for null values, which means that
NaNvalues should be treated as a valid values.rgommers commentedon Mar 31, 2023
Thanks for opening this issue @AlenkaF. I agree with your request and with @kkraus14, that was the intent and that is exactly why we spent so much time on allowing different ways to encode nulls and have
describe_null.We discussed this yesterday, and it seems that something got lost in translation in the protocol test suite, and in a discussion on a Vaex PR. @honno took the action to investigate.
Indeed - @jorisvandenbossche indicated that this is expected; roundtripping with Pandas will lose the
nan/NAdistinction, but that is what it is due to a pandas design choice, and does not meannanandNAaren't separately treated by the protocol.AlenkaF commentedon Apr 2, 2023
Great to hear 👍
Thank you so much for the quick response and share of thoughts!
Will close the open issue on Arrow side (apache/arrow#34774) and am looking forward to changes on the protocol spec and test suite.