Skip to content

Commit ad7f2bd

Browse files
authored
🏷️ sparse: improved init stubs of sparse arrays with shape as positional argument. (#704)
2 parents 7ecc041 + 7796ded commit ad7f2bd

File tree

8 files changed

+844
-85
lines changed

8 files changed

+844
-85
lines changed

scipy-stubs/sparse/_bsr.pyi

Lines changed: 77 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -98,19 +98,84 @@ class bsr_array(_bsr_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
9898
*,
9999
maxprint: int | None = None,
100100
) -> None: ...
101-
@overload # 2-d shape-like, dtype: None
101+
@overload # 2-d shape-like, dtype: float64-like | None
102102
def __init__(
103103
self: bsr_array[np.float64],
104104
/,
105105
arg1: ToShape2D,
106-
shape: None = None,
107-
dtype: None = None,
106+
shape: ToShape2D | None = None,
107+
dtype: onp.AnyFloat64DType | None = None,
108+
copy: bool = False,
109+
*,
110+
maxprint: int | None = None,
111+
) -> None: ...
112+
@overload # 2-d shape-like, dtype: bool-like (positional)
113+
def __init__(
114+
self: bsr_array[np.bool_],
115+
/,
116+
arg1: ToShape2D,
117+
shape: ToShape2D | None,
118+
dtype: onp.AnyBoolDType,
119+
copy: bool = False,
120+
*,
121+
maxprint: int | None = None,
122+
) -> None: ...
123+
@overload # 2-d shape-like, dtype: bool-like (keyword)
124+
def __init__(
125+
self: bsr_array[np.bool_],
126+
/,
127+
arg1: ToShape2D,
128+
shape: ToShape2D | None = None,
129+
*,
130+
dtype: onp.AnyBoolDType,
131+
copy: bool = False,
132+
maxprint: int | None = None,
133+
) -> None: ...
134+
@overload # 2-d shape-like, dtype: int-like (positional)
135+
def __init__(
136+
self: bsr_array[np.int64],
137+
/,
138+
arg1: ToShape2D,
139+
shape: ToShape2D | None,
140+
dtype: onp.AnyIntDType,
108141
copy: bool = False,
109-
blocksize: tuple[int, int] | None = None,
110142
*,
111143
maxprint: int | None = None,
112144
) -> None: ...
113-
@overload # matrix-like builtins.bool, dtype: type[bool] | None
145+
@overload # 2-d shape-like, dtype: int-like (keyword)
146+
def __init__(
147+
self: bsr_array[np.int64],
148+
/,
149+
arg1: ToShape2D,
150+
shape: ToShape2D | None = None,
151+
*,
152+
dtype: onp.AnyIntDType,
153+
copy: bool = False,
154+
maxprint: int | None = None,
155+
) -> None: ...
156+
@overload # 2-d shape-like, dtype: complex128-like (positional)
157+
def __init__(
158+
self: bsr_array[np.complex128],
159+
/,
160+
arg1: ToShape2D,
161+
shape: ToShape2D | None,
162+
dtype: onp.AnyComplex128DType,
163+
copy: bool = False,
164+
*,
165+
maxprint: int | None = None,
166+
) -> None: ...
167+
@overload # 2-d shape-like, dtype: complex128-like (keyword)
168+
def __init__(
169+
self: bsr_array[np.complex128],
170+
/,
171+
arg1: ToShape2D,
172+
shape: ToShape2D | None = None,
173+
*,
174+
dtype: onp.AnyComplex128DType,
175+
copy: bool = False,
176+
maxprint: int | None = None,
177+
) -> None: ...
178+
@overload # matrix-like builtins.bool, dtype: bool-like | None
114179
def __init__(
115180
self: bsr_array[np.bool_],
116181
/,
@@ -122,7 +187,7 @@ class bsr_array(_bsr_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
122187
*,
123188
maxprint: int | None = None,
124189
) -> None: ...
125-
@overload # matrix-like builtins.int, dtype: type[int] | None
190+
@overload # matrix-like builtins.int, dtype: int-like | None
126191
def __init__(
127192
self: bsr_array[np.int_],
128193
/,
@@ -134,7 +199,7 @@ class bsr_array(_bsr_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
134199
*,
135200
maxprint: int | None = None,
136201
) -> None: ...
137-
@overload # matrix-like builtins.float, dtype: type[float] | None
202+
@overload # matrix-like builtins.float, dtype: float64-like | None
138203
def __init__(
139204
self: bsr_array[np.float64],
140205
/,
@@ -146,7 +211,7 @@ class bsr_array(_bsr_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
146211
*,
147212
maxprint: int | None = None,
148213
) -> None: ...
149-
@overload # matrix-like builtins.complex, dtype: type[complex] | None
214+
@overload # matrix-like builtins.complex, dtype: complex128-like | None
150215
def __init__(
151216
self: bsr_array[np.complex128],
152217
/,
@@ -236,7 +301,7 @@ class bsr_matrix(_bsr_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
236301
*,
237302
maxprint: int | None = None,
238303
) -> None: ...
239-
@overload # matrix-like builtins.bool, dtype: type[bool] | None
304+
@overload # matrix-like builtins.bool, dtype: bool-like | None
240305
def __init__(
241306
self: bsr_matrix[np.bool_],
242307
/,
@@ -248,7 +313,7 @@ class bsr_matrix(_bsr_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
248313
*,
249314
maxprint: int | None = None,
250315
) -> None: ...
251-
@overload # matrix-like builtins.int, dtype: type[int] | None
316+
@overload # matrix-like builtins.int, dtype: int-like | None
252317
def __init__(
253318
self: bsr_matrix[np.int_],
254319
/,
@@ -260,7 +325,7 @@ class bsr_matrix(_bsr_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
260325
*,
261326
maxprint: int | None = None,
262327
) -> None: ...
263-
@overload # matrix-like builtins.float, dtype: type[float] | None
328+
@overload # matrix-like builtins.float, dtype: float64-like | None
264329
def __init__(
265330
self: bsr_matrix[np.float64],
266331
/,
@@ -272,7 +337,7 @@ class bsr_matrix(_bsr_base[_ScalarT_co], spmatrix[_ScalarT_co], Generic[_ScalarT
272337
*,
273338
maxprint: int | None = None,
274339
) -> None: ...
275-
@overload # matrix-like builtins.complex, dtype: type[complex] | None
340+
@overload # matrix-like builtins.complex, dtype: complex128-like | None
276341
def __init__(
277342
self: bsr_matrix[np.complex128],
278343
/,

0 commit comments

Comments
 (0)