Skip to content

Replace int with SupportsIndex in indexing methods hints #766

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

Open
honno wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Replace int with SupportsIndex in indexing methods hints #766

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3c9c047
Replace `int` with `SupportsIndex` in indexing methods hints
honno Mar 21, 2024
18910c0
Add `int` alongside `SupportIndex` in indexing type hints
honno Mar 22, 2024
ef9c4c1
Add space before `__setitem__()` note in docstring
honno Mar 22, 2024
986ba27
Clarify when `__index__()` is applicable for arrays-as-keys in indexing
honno Mar 27, 2024
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
21 changes: 16 additions & 5 deletions src/array_api_stubs/_draft/array_object.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

__all__ = ["array"]

from typing import SupportsIndex
from ._types import (
array,
dtype as Dtype,
Expand Down Expand Up @@ -604,11 +605,11 @@ def __ge__(self: array, other: Union[int, float, array], /) -> array:
def __getitem__(
self: array,
key: Union[
int,
SupportsIndex,
Comment thread
honno marked this conversation as resolved.
Outdated
slice,
ellipsis,
None,
Tuple[Union[int, slice, ellipsis, None], ...],
Tuple[Union[SupportsIndex, slice, ellipsis, None], ...],
array,
],
/,
Expand All @@ -620,9 +621,13 @@ def __getitem__(
----------
self: array
array instance.
key: Union[int, slice, ellipsis, None, Tuple[Union[int, slice, ellipsis, None], ...], array]
key: Union[SupportsIndex, slice, ellipsis, None, Tuple[Union[SupportsIndex, slice, ellipsis, None], ...], array]
index key.


.. note::
``key`` can only be an array if it is valid for boolean array indexing, or supports ``__index__()``.
Copy link
Copy Markdown
Member

@asmeurer asmeurer Mar 25, 2024

Choose a reason for hiding this comment

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

Presumably somewhere else we say it should support __index__ if and only if it is a 0-D integer array. Maybe it would be clearer to just say that directly here.

Copy link
Copy Markdown
Member Author

@honno honno Mar 27, 2024

Choose a reason for hiding this comment

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

Yep that'd help, let me know on the wording from my latest commit.


Returns
-------
out: array
Expand Down Expand Up @@ -1077,7 +1082,11 @@ def __rshift__(self: array, other: Union[int, array], /) -> array:
def __setitem__(
self: array,
key: Union[
int, slice, ellipsis, Tuple[Union[int, slice, ellipsis], ...], array
SupportsIndex,
slice,
ellipsis,
Tuple[Union[SupportsIndex, slice, ellipsis], ...],
array,
],
value: Union[int, float, bool, array],
/,
Expand All @@ -1089,11 +1098,13 @@ def __setitem__(
----------
self: array
array instance.
key: Union[int, slice, ellipsis, Tuple[Union[int, slice, ellipsis], ...], array]
key: Union[SupportsIndex, slice, ellipsis, Tuple[Union[SupportsIndex, slice, ellipsis], ...], array]
index key.
value: Union[int, float, bool, array]
value(s) to set. Must be compatible with ``self[key]`` (see :ref:`broadcasting`).

.. note::
``key`` can only be an array if it is valid for boolean array indexing, or supports ``__index__()``.
Comment thread
honno marked this conversation as resolved.
Outdated

.. note::

Expand Down