Skip to content

API: Specify that DLPack should use BufferError #498

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 14, 2022
Merged

API: Specify that DLPack should use BufferError #498

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1021e26
API: Specify that DLPack should use BufferError
seberg Oct 20, 2022
3c91ce2
Fix duplicated word
kgryte Nov 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions spec/API_specification/array_api/array_object.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,15 @@ def __dlpack__(self: array, /, *, stream: Optional[Union[int, Any]] = None) -> P
-------
capsule: PyCapsule
a DLPack capsule for the array. See :ref:`data-interchange` for details.

Raises
------
BufferError
Implementations should raise ``BufferError`` when the data cannot
be exported as DLPack (e.g., incompatible dtype or strides). Other
errors are raised when export fails for other reasons (e.g., incorrect
arguments passed or out of memory).

"""

def __dlpack_device__(self: array, /) -> Tuple[Enum, int]:
Expand Down