apache / apache/arrow

[Python] [Docs] Mention the C Data/Stream Interface in PyArrow Extending

Open
#33,567 1 comment 0 reactions 0 assignees View on GitHub
Component: Documentation Type: task
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 18h
Merged PRs (30d)
91

Description

The [Arrow C Data/Stream Interface](https://arrow.apache.org/docs/format/CDataInterface.html) is a relatively lightweight option for developers that want to expose Arrow Arrays to Python users.

It is not mentioned as a recommendation in the documentation on [using pyarrow from C++ code\|[https://arrow.apache.org/docs/python/integration/extending.html].]

The existing recommendation mentioned is [wrapping and unwrapping\|[https://arrow.apache.org/docs/python/integration/extending.html#wrapping-and-unwrapping].]

I propose adding a section to this page. I would be happy to take that on, if others agree that is a good idea.

**Reporter**: [Anja Boskovic](https://issues.apache.org/jira/browse/ARROW-18404) / @anjakefala
**Assignee**: [Anja Boskovic](https://issues.apache.org/jira/browse/ARROW-18404) / @anjakefala

**Note**: *This issue was originally created as [ARROW-18404](https://issues.apache.org/jira/browse/ARROW-18404). Please see the [migration documentation](https://github.com/apache/arrow/issues/14542) for further details.*

Contributor guide

Open the contributing guide

Research direction

Start with docs/python/integration/extending.html, especially the existing “wrapping and unwrapping” section, and read the linked Arrow C Data/Stream Interface documentation. Add a section recommending the interface for exposing Arrow Arrays to Python users, with scope and wording consistent with the page.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, cpp, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.