-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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.
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
GH-38325: [Python] Expand the Arrow PyCapsule Interface with C Device Data support #40708
Merged
jorisvandenbossche
merged 12 commits into
apache:main
from
jorisvandenbossche:38325-capsule-device-spec
Jun 26, 2024
Merged
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
6c2eaa6
GH-38325: [Python] Expand the Arrow PyCapsule Interface with C Device…
jorisvandenbossche 4e6f140
add section on guidelines around device support
jorisvandenbossche be14cf7
Apply suggestions from code review
jorisvandenbossche 3235c7c
Merge remote-tracking branch 'upstream/main' into 38325-capsule-devic…
jorisvandenbossche 5ac1858
remove type hints in main spec
jorisvandenbossche e40e3ec
Merge remote-tracking branch 'upstream/main' into 38325-capsule-devic…
jorisvandenbossche 0e94a00
add kwargs handling for potential future keywords
jorisvandenbossche 4c5c8b5
clarify CPU-only version of the protocol in case of non-CPU data
jorisvandenbossche 4949f88
Update docs/source/format/CDataInterface/PyCapsuleInterface.rst
jorisvandenbossche fded4d4
Update docs/source/format/CDataInterface/PyCapsuleInterface.rst
jorisvandenbossche a1ae082
fix typo and use CPU-only instead of standard
jorisvandenbossche 182910e
Merge remote-tracking branch 'upstream/main' into 38325-capsule-devic…
jorisvandenbossche File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see we already did it above, but it's not useful to add machine-oriented type annotations to a human-readable doc. The parameter types are described explicitly below.
The HTML rendering is not terrible but it's not great either, as the signature looks crowded: https://arrow.apache.org/docs/format/CDataInterface/PyCapsuleInterface.html#arrowarray-export
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cc @wjones127
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fine removing them. In general, I like having the type hints as they make signatures easy to understand from my human perspective. They can be less ambiguous than a description of a type. But given we don't have a
PyCapsule
type, I agree they don't add much value here.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We also still have the type hints version in the https://arrow.apache.org/docs/format/CDataInterface/PyCapsuleInterface.html#protocol-typehints section a bit below
Will remove them here.