Skip to content

✨ lib._twodim_base_impl: shape-typing #782

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
jorenham merged 9 commits into from
Dec 27, 2025
Merged

✨ lib._twodim_base_impl: shape-typing #782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5dec9a6
✨ `histogram2d` shape-typing
jorenham Dec 27, 2025
3f59cca
✨ `fliplr` and `flipud` shape-typing
jorenham Dec 27, 2025
e5f5209
✨ `diag` shape-typing
jorenham Dec 27, 2025
f1440b7
✨ `diagflat` shape-typing
jorenham Dec 27, 2025
2972bf0
✨ `tri` shape-typing
jorenham Dec 27, 2025
5fb4e50
✨ `vander` shape-typing
jorenham Dec 27, 2025
8145ae6
♻️ `vander` narrow return dtype
jorenham Dec 27, 2025
0a3cab0
👽️ `histogram2d` sync with upstream
jorenham Dec 27, 2025
0d86d8f
✅ update `lib._twodim_base_impl` type-tests
jorenham Dec 27, 2025
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
88 changes: 36 additions & 52 deletions src/numpy-stubs/@test/static/accept/twodim_base.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
from typing import assert_type
from typing import Any, TypeAlias, assert_type
from typing_extensions import TypeVar

import _numtype as _nt
import numpy as np

_ScalarT = TypeVar("_ScalarT", bound=np.generic)

_Histogram2D: TypeAlias = tuple[_nt.Array2D[np.float64], _nt.Array1D[_ScalarT], _nt.Array1D[_ScalarT]]

def func1(ar: _nt.Array[_ScalarT], a: int) -> _nt.Array[_ScalarT]: ...
def func2(ar: _nt.Array[np.number], a: str) -> _nt.Array[np.float64]: ...

Expand All @@ -19,6 +21,8 @@ AR_O: _nt.Array[np.object_]
AR_LIKE_b: list[bool]
AR_LIKE_c: list[complex]

###

assert_type(np.fliplr(AR_b), _nt.Array[np.bool])
assert_type(np.fliplr(AR_LIKE_b), _nt.Array)

Expand All @@ -30,63 +34,43 @@ assert_type(np.eye(10, M=20, dtype=np.int64), _nt.Array[np.int64])
assert_type(np.eye(10, k=2, dtype=int), _nt.Array)

assert_type(np.diag(AR_b), _nt.Array[np.bool])
assert_type(np.diag(AR_LIKE_b, k=0), _nt.Array)
assert_type(np.diag(AR_LIKE_b, k=0), _nt.Array2D)

assert_type(np.diagflat(AR_b), _nt.Array[np.bool])
assert_type(np.diagflat(AR_LIKE_b, k=0), _nt.Array)
assert_type(np.diagflat(AR_b), _nt.Array2D[np.bool])
assert_type(np.diagflat(AR_LIKE_b, k=0), _nt.Array2D)

assert_type(np.tri(10), _nt.Array[np.float64])
assert_type(np.tri(10, M=20, dtype=np.int64), _nt.Array[np.int64])
assert_type(np.tri(10, k=2, dtype=int), _nt.Array)
assert_type(np.tri(10), _nt.Array2D[np.float64])
assert_type(np.tri(10, M=20, dtype=np.int64), _nt.Array2D[np.int64])
assert_type(np.tri(10, k=2, dtype=int), _nt.Array2D)

assert_type(np.tril(AR_b), _nt.Array[np.bool])
assert_type(np.tril(AR_LIKE_b, k=0), _nt.Array[np.bool])

assert_type(np.triu(AR_b), _nt.Array[np.bool])
assert_type(np.triu(AR_LIKE_b, k=0), _nt.Array[np.bool])

assert_type(np.vander(AR_b), _nt.Array[np.intp])
assert_type(np.vander(AR_u), _nt.Array[np.signedinteger])
assert_type(np.vander(AR_i, N=2), _nt.Array[np.signedinteger])
assert_type(np.vander(AR_f, increasing=True), _nt.Array[np.floating])
assert_type(np.vander(AR_c), _nt.Array[np.complexfloating])
assert_type(np.vander(AR_O), _nt.Array[np.object_])

assert_type(
np.histogram2d(AR_LIKE_c, AR_LIKE_c),
tuple[_nt.Array[np.float64], _nt.Array[np.complex128 | np.float64], _nt.Array[np.complex128 | np.float64]],
)
assert_type(np.histogram2d(AR_i, AR_b), tuple[_nt.Array[np.float64], _nt.Array[np.float64], _nt.Array[np.float64]])
assert_type(np.histogram2d(AR_f, AR_i), tuple[_nt.Array[np.float64], _nt.Array[np.float64], _nt.Array[np.float64]])
assert_type(np.histogram2d(AR_i, AR_f), tuple[_nt.Array[np.float64], _nt.Array[np.float64], _nt.Array[np.float64]])
assert_type(
np.histogram2d(AR_f, AR_c, weights=AR_LIKE_b),
tuple[_nt.Array[np.float64], _nt.Array[np.complex128], _nt.Array[np.complex128]],
)
assert_type(
np.histogram2d(AR_f, AR_c, bins=8), tuple[_nt.Array[np.float64], _nt.Array[np.complex128], _nt.Array[np.complex128]]
)
assert_type(
np.histogram2d(AR_c, AR_f, bins=(8, 5)),
tuple[_nt.Array[np.float64], _nt.Array[np.complex128], _nt.Array[np.complex128]],
)
assert_type(
np.histogram2d(AR_c, AR_i, bins=AR_u), tuple[_nt.Array[np.float64], _nt.Array[np.uint64], _nt.Array[np.uint64]]
)
assert_type(
np.histogram2d(AR_c, AR_c, bins=(AR_u, AR_u)),
tuple[_nt.Array[np.float64], _nt.Array[np.uint64], _nt.Array[np.uint64]],
)
assert_type(
np.histogram2d(AR_c, AR_c, bins=(AR_b, 8)),
tuple[_nt.Array[np.float64], _nt.Array[np.bool | np.complex128], _nt.Array[np.bool | np.complex128]],
)

assert_type(np.mask_indices(10, func1), tuple[_nt.Array[np.intp], _nt.Array[np.intp]])
assert_type(np.mask_indices(8, func2, "0"), tuple[_nt.Array[np.intp], _nt.Array[np.intp]])

assert_type(np.tril_indices(10), tuple[_nt.Array[np.intp], _nt.Array[np.intp]])
assert_type(np.triu_indices(10), tuple[_nt.Array[np.intp], _nt.Array[np.intp]])

assert_type(np.tril_indices_from(AR_b), tuple[_nt.Array[np.intp], _nt.Array[np.intp]])
assert_type(np.triu_indices_from(AR_b), tuple[_nt.Array[np.intp], _nt.Array[np.intp]])
assert_type(np.vander(AR_b), _nt.Array2D[np.intp])
assert_type(np.vander(AR_u), _nt.Array2D[np.int_])
assert_type(np.vander(AR_i, N=2), _nt.Array2D[np.int_])
assert_type(np.vander(AR_f, increasing=True), _nt.Array2D[np.float64])
assert_type(np.vander(AR_c), _nt.Array2D[np.complex128])
assert_type(np.vander(AR_O), _nt.Array2D[np.object_])

assert_type(np.histogram2d(AR_LIKE_c, AR_LIKE_c), _Histogram2D[np.complex128 | Any])
assert_type(np.histogram2d(AR_f, AR_i), _Histogram2D[np.float64])
assert_type(np.histogram2d(AR_i, AR_f), _Histogram2D[np.float64])
assert_type(np.histogram2d(AR_f, AR_c, weights=AR_LIKE_b), _Histogram2D[np.complex128])
assert_type(np.histogram2d(AR_f, AR_c, bins=8), _Histogram2D[np.complex128])
assert_type(np.histogram2d(AR_c, AR_f, bins=(8, 5)), _Histogram2D[np.complex128])
assert_type(np.histogram2d(AR_c, AR_i, bins=AR_u), _Histogram2D[np.uint64])
assert_type(np.histogram2d(AR_c, AR_c, bins=(AR_u, AR_u)), _Histogram2D[np.uint64])
assert_type(np.histogram2d(AR_c, AR_c, bins=(AR_b, 8)), _Histogram2D[np.bool | np.complex128])

assert_type(np.mask_indices(10, func1), tuple[_nt.Array1D[np.intp], _nt.Array1D[np.intp]])
assert_type(np.mask_indices(8, func2, "0"), tuple[_nt.Array1D[np.intp], _nt.Array1D[np.intp]])

assert_type(np.tril_indices(10), tuple[_nt.Array1D[np.intp], _nt.Array1D[np.intp]])
assert_type(np.triu_indices(10), tuple[_nt.Array1D[np.intp], _nt.Array1D[np.intp]])

assert_type(np.tril_indices_from(AR_b), tuple[_nt.Array1D[np.intp], _nt.Array1D[np.intp]])
assert_type(np.triu_indices_from(AR_b), tuple[_nt.Array1D[np.intp], _nt.Array1D[np.intp]])
Loading