stinodego commented on issue #37598:
URL: https://github.com/apache/arrow/issues/37598#issuecomment-1709550852
> One thought that comes to mind is that this should be made more explicit
in the __dataframe__ protocol spec. Is there and issue opened as I haven't
found one?
There is no issue on this. I thought about opening one, but I would say that
the text for the `get_buffers` method is quite clear already (see below). And
`from_dataframe` is not explicitly part of the API, so there is no real
documentation on how that should work.
```
def get_buffers(self) -> ColumnBuffers:
"""
Return a dictionary containing the underlying buffers.
The returned dictionary has the following contents:
- "data": a two-element tuple whose first element is a buffer
containing the data and whose second element is the
data
buffer's associated dtype.
- "validity": a two-element tuple whose first element is a buffer
containing mask values indicating missing data and
whose second element is the mask value buffer's
associated dtype. None if the null representation
is
not a bit or byte mask.
- "offsets": a two-element tuple whose first element is a buffer
containing the offset values for variable-size
binary
data (e.g., variable-length strings) and whose
second
element is the offsets buffer's associated dtype.
None
if the data buffer does not have an associated
offsets
buffer.
"""
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
