Skip to content

GH-47696: [Docs] PyCapsule protocol implementation status#49550

Closed
Daedalus-Icarus wants to merge 4 commits into
apache:mainfrom
Daedalus-Icarus:feat/issue-47696
Closed

GH-47696: [Docs] PyCapsule protocol implementation status#49550
Daedalus-Icarus wants to merge 4 commits into
apache:mainfrom
Daedalus-Icarus:feat/issue-47696

Conversation

@Daedalus-Icarus

@Daedalus-Icarus Daedalus-Icarus commented Mar 18, 2026

Copy link
Copy Markdown

Rationale for this change

The Python docs explain the PyCapsule Interface but don't show which libraries in the ecosystem have adopted it. Issue #47696 requested adding an implementation status table based on the tracking in #39195.

What changes are included in this PR?

Added a table to docs/source/python/extending_types.rst listing 21 Python libraries that have implemented the PyCapsule Interface, with a link to the tracking issue for latest updates.

Are these changes tested?

Documentation-only change. Verified the Sphinx build succeeds with make python.

Are there any user-facing changes?

A new "PyCapsule Interface Implementation Status" table is now visible in the Python docs under the "Extending PyArrow" page.


Fixes #47696

@github-actions

Copy link
Copy Markdown

Thanks for opening a pull request!

If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose

Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project.

Then could you also rename the pull request title in the following format?

GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

or

MINOR: [${COMPONENT}] ${SUMMARY}

See also:

@Daedalus-Icarus

Copy link
Copy Markdown
Author

Hi @AlenkaF Could you review this PR and share any feedback? thank you.

@Daedalus-Icarus Daedalus-Icarus changed the title Docs:PyCapsule protocol implementation status MINOR: [Docs] PyCapsule protocol implementation status Mar 18, 2026

@raulcd raulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! Can you update the title of the PR to contain the GitHub issue instead of MINOR should be GH-47696, thanks!

Comment thread docs/source/python/extending_types.rst Outdated
@Daedalus-Icarus Daedalus-Icarus changed the title MINOR: [Docs] PyCapsule protocol implementation status GH-47696: [Docs] PyCapsule protocol implementation status Mar 19, 2026
@Daedalus-Icarus

Copy link
Copy Markdown
Author

Hi @raulcd I arranged them alphabetically. Thanks for your feedback. Could you please review again?

@AlenkaF

AlenkaF commented Mar 19, 2026

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: b56702d

Submitted crossbow builds: ursacomputing/crossbow @ actions-54bfe0b531

Task Status
preview-docs GitHub Actions

@AlenkaF AlenkaF left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!

As there is a status column it would make sense to also include projects that have an issue opened for the implementation of PyCapsule protocol, but haven't implemented it yet.

And just a thought: As we are talking about the implementations of the PyCapsule protocol, would it make sense to link not to the main docs or the GitHub repo of the project, but to the changelog or something similar? For example: https://github.com/apache/datafusion-python/blob/main/dev/changelog/pre-43.0.0.md#4100-2024-09-09

@Daedalus-Icarus

Copy link
Copy Markdown
Author

@AlenkaF Thank you for your feedback. That's good point. I have made the updates, could you please review it again?

@Daedalus-Icarus

Copy link
Copy Markdown
Author

@AlenkaF Are you not able to review this now? I am looking forward your reply.

@Daedalus-Icarus

Copy link
Copy Markdown
Author

@raulcd Could you please take a look at this and merge it? I think it is mergeable now....

@raulcd

raulcd commented Mar 25, 2026

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 4e0c15c

Submitted crossbow builds: ursacomputing/crossbow @ actions-9d0ccb9672

Task Status
preview-docs GitHub Actions

@raulcd raulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The table format doesn't look great in my opinion:

Image

I am unsure whether a simple check, as proposed on the comments, would look better. @AlenkaF what are your thoughts?
We use checks on other tables

Comment thread docs/source/python/extending_types.rst Outdated
* - Library
- Status
* - `altair <https://github.com/vega/altair/issues/3568>`__
- Not yet implemented

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Not yet implemented
-

Comment thread docs/source/python/extending_types.rst Outdated
* - `altair <https://github.com/vega/altair/issues/3568>`__
- Not yet implemented
* - `arro3 <https://github.com/kylebarron/arro3>`__
- Implemented

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Implemented
-

@raulcd

raulcd commented Mar 25, 2026

Copy link
Copy Markdown
Member

@github-actions github-actions Bot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels Mar 25, 2026
@AlenkaF

AlenkaF commented Mar 25, 2026

Copy link
Copy Markdown
Member

I am unsure whether a simple check, as proposed on the comments, would look better. @AlenkaF what are your thoughts?

Yes, I agree. check would look better.

As for the overall PR I am happy this is being worked on! But I think the list could benefit from a bit more effort. For example. Checking the first link in the rendered docs for altair package quickly shows me there is also an issue opened on the streamlit repository which is missing from the list and could also be added. Another example is arro3. Instead of linking the whole GitHub repo one could link the docs or implementation issue/pr in case that is more convenient.

It is correct that this list is based on the original comment, which is a good starting point. But I'd really like to see entries checked and updated as part of this PR.

@Daedalus-Icarus

Copy link
Copy Markdown
Author

@AlenkaF @raulcd Thank you for your feedback. Updated. Can you merge this now?

@raulcd

raulcd commented Mar 25, 2026

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

Copy link
Copy Markdown

Revision: 88b65ff

Submitted crossbow builds: ursacomputing/crossbow @ actions-aab8f108e2

Task Status
preview-docs GitHub Actions

@AlenkaF

AlenkaF commented Mar 25, 2026

Copy link
Copy Markdown
Member

It seems like the suggestions were applied literally rather than understood in context. Review cycle is becoming longer than it needs to be.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs][Python] PyCapsule protocol implementation status

3 participants