Skip to content

🏷️ sparse: improved init stubs of sparse arrays with shape as positional argument. #704

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 6 commits into from
Jul 7, 2025
Merged

🏷️ sparse: improved init stubs of sparse arrays with shape as positional argument. #704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2fe7a0d
Improved init stubs of sparse arrays with shape as positional argument.
JulVandenBroeck Jul 4, 2025
0ec1442
Added DOK stubs + merged dtype=None and dtype=np.float64 cases
JulVandenBroeck Jul 5, 2025
b3d1ee0
Added more test cases for CSR
JulVandenBroeck Jul 5, 2025
f2d57e8
Fixed constructor stubs for positional and keyword dtypes (other than…
JulVandenBroeck Jul 6, 2025
c34349a
Added missing keyword separators
JulVandenBroeck Jul 6, 2025
7796ded
Cleaned up comments for overloads of sparse array constructors
JulVandenBroeck Jul 7, 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
89 changes: 77 additions & 12 deletions scipy-stubs/sparse/_bsr.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,19 +98,84 @@ class bsr_array(_bsr_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
*,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: None
@overload # 2-d shape-like, dtype: float64-like | None
def __init__(
self: bsr_array[np.float64],
/,
arg1: ToShape2D,
shape: None = None,
dtype: None = None,
shape: ToShape2D | None = None,
dtype: onp.AnyFloat64DType | None = None,
copy: bool = False,
*,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: bool-like (positional)
def __init__(
self: bsr_array[np.bool_],
/,
arg1: ToShape2D,
shape: ToShape2D | None,
dtype: onp.AnyBoolDType,
copy: bool = False,
*,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: bool-like (keyword)
def __init__(
self: bsr_array[np.bool_],
/,
arg1: ToShape2D,
shape: ToShape2D | None = None,
*,
dtype: onp.AnyBoolDType,
copy: bool = False,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: int-like (positional)
def __init__(
self: bsr_array[np.int64],
/,
arg1: ToShape2D,
shape: ToShape2D | None,
dtype: onp.AnyIntDType,
copy: bool = False,
blocksize: tuple[int, int] | None = None,
*,
maxprint: int | None = None,
) -> None: ...
@overload # matrix-like builtins.bool, dtype: type[bool] | None
@overload # 2-d shape-like, dtype: int-like (keyword)
def __init__(
self: bsr_array[np.int64],
/,
arg1: ToShape2D,
shape: ToShape2D | None = None,
*,
dtype: onp.AnyIntDType,
copy: bool = False,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: complex128-like (positional)
def __init__(
self: bsr_array[np.complex128],
/,
arg1: ToShape2D,
shape: ToShape2D | None,
dtype: onp.AnyComplex128DType,
copy: bool = False,
*,
maxprint: int | None = None,
) -> None: ...
@overload # 2-d shape-like, dtype: complex128-like (keyword)
def __init__(
self: bsr_array[np.complex128],
/,
arg1: ToShape2D,
shape: ToShape2D | None = None,
*,
dtype: onp.AnyComplex128DType,
copy: bool = False,
maxprint: int | None = None,
) -> None: ...
@overload # matrix-like builtins.bool, dtype: bool-like | None
def __init__(
self: bsr_array[np.bool_],
/,
Expand All @@ -122,7 +187,7 @@ class bsr_array(_bsr_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
*,
maxprint: int | None = None,
) -> None: ...
@overload # matrix-like builtins.int, dtype: type[int] | None
@overload # matrix-like builtins.int, dtype: int-like | None
def __init__(
self: bsr_array[np.int_],
/,
Expand All @@ -134,7 +199,7 @@ class bsr_array(_bsr_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
*,
maxprint: int | None = None,
) -> None: ...
@overload # matrix-like builtins.float, dtype: type[float] | None
@overload # matrix-like builtins.float, dtype: float64-like | None
def __init__(
self: bsr_array[np.float64],
/,
Expand All @@ -146,7 +211,7 @@ class bsr_array(_bsr_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
*,
maxprint: int | None = None,
) -> None: ...
@overload # matrix-like builtins.complex, dtype: type[complex] | None
@overload # matrix-like builtins.complex, dtype: complex128-like | None
def __init__(
self: bsr_array[np.complex128],
/,
Expand Down Expand Up @@ -236,7 +301,7 @@ class bsr_matrix(_bsr_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
*,
maxprint: int | None = None,
) -> None: ...
@overload # matrix-like builtins.bool, dtype: type[bool] | None
@overload # matrix-like builtins.bool, dtype: bool-like | None
def __init__(
self: bsr_matrix[np.bool_],
/,
Expand All @@ -248,7 +313,7 @@ class bsr_matrix(_bsr_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
*,
maxprint: int | None = None,
) -> None: ...
@overload # matrix-like builtins.int, dtype: type[int] | None
@overload # matrix-like builtins.int, dtype: int-like | None
def __init__(
self: bsr_matrix[np.int_],
/,
Expand All @@ -260,7 +325,7 @@ class bsr_matrix(_bsr_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
*,
maxprint: int | None = None,
) -> None: ...
@overload # matrix-like builtins.float, dtype: type[float] | None
@overload # matrix-like builtins.float, dtype: float64-like | None
def __init__(
self: bsr_matrix[np.float64],
/,
Expand All @@ -272,7 +337,7 @@ class bsr_matrix(_bsr_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
*,
maxprint: int | None = None,
) -> None: ...
@overload # matrix-like builtins.complex, dtype: type[complex] | None
@overload # matrix-like builtins.complex, dtype: complex128-like | None
def __init__(
self: bsr_matrix[np.complex128],
/,
Expand Down
Loading