Skip to content

Commit 2fe7a0d

Browse files
JulVandenBroeckJulVandenBroeck
committed
Improved init stubs of sparse arrays with shape as positional argument.
1 parent c2a7b18 commit 2fe7a0d

File tree

7 files changed

+410
-7
lines changed

7 files changed

+410
-7
lines changed

‎scipy-stubs/sparse/_bsr.pyi

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,53 @@ class bsr_array(_bsr_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
103103
self: bsr_array[np.float64],
104104
/,
105105
arg1: ToShape2D,
106-
shape: None = None,
106+
shape: ToShape2D | None = None,
107107
dtype: None = None,
108108
copy: bool = False,
109-
blocksize: tuple[int, int] | None = None,
109+
*,
110+
maxprint: int | None = None,
111+
) -> None: ...
112+
@overload # 2-d shape-like, dtype: type[bool]
113+
def __init__(
114+
self: bsr_array[np.bool_],
115+
/,
116+
arg1: ToShape2D,
117+
shape: ToShape2D | None = None,
118+
dtype: onp.AnyBoolDType | None = None,
119+
copy: bool = False,
120+
*,
121+
maxprint: int | None = None,
122+
) -> None: ...
123+
@overload # 2-d shape-like, dtype: type[int]
124+
def __init__(
125+
self: bsr_array[np.int64],
126+
/,
127+
arg1: ToShape2D,
128+
shape: ToShape2D | None = None,
129+
dtype: onp.AnyIntDType | None = None,
130+
copy: bool = False,
131+
*,
132+
maxprint: int | None = None,
133+
) -> None: ...
134+
@overload # 2-d shape-like, dtype: type[float]
135+
def __init__(
136+
self: bsr_array[np.float64],
137+
/,
138+
arg1: ToShape2D,
139+
shape: ToShape2D | None = None,
140+
dtype: onp.AnyFloat64DType | None = None,
141+
copy: bool = False,
142+
*,
143+
maxprint: int | None = None,
144+
) -> None: ...
145+
@overload # 2-d shape-like, dtype: type[complex]
146+
def __init__(
147+
self: bsr_array[np.complex128],
148+
/,
149+
arg1: ToShape2D,
150+
shape: ToShape2D | None = None,
151+
dtype: onp.AnyComplex128DType | None = None,
152+
copy: bool = False,
110153
*,
111154
maxprint: int | None = None,
112155
) -> None: ...

‎scipy-stubs/sparse/_coo.pyi

Lines changed: 134 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ class coo_array(_coo_base[_ScalarT_co, _ShapeT_co], sparray[_ScalarT_co, _ShapeT
155155
/,
156156
arg1: ToShape1D,
157157
shape: ToShape1D | None = None,
158-
dtype: onp.AnyFloat64DType | None = None,
158+
dtype: None = None,
159159
copy: bool = False,
160160
*,
161161
maxprint: int | None = None,
@@ -166,12 +166,111 @@ class coo_array(_coo_base[_ScalarT_co, _ShapeT_co], sparray[_ScalarT_co, _ShapeT
166166
/,
167167
arg1: ToShape2D,
168168
shape: ToShape2D | None = None,
169-
dtype: onp.AnyFloat64DType | None = None,
169+
dtype: None = None,
170170
copy: bool = False,
171171
*,
172172
maxprint: int | None = None,
173173
) -> None: ...
174174
@overload # >2-d shape-like, dtype: None
175+
def __init__(
176+
self: coo_array[np.float64, onp.AtLeast3D],
177+
/,
178+
arg1: ToShapeMin3D,
179+
shape: ToShapeMin3D | None = None,
180+
dtype: None = None,
181+
copy: bool = False,
182+
*,
183+
maxprint: int | None = None,
184+
) -> None: ...
185+
@overload # 1-d shape-like, dtype: type[bool]
186+
def __init__(
187+
self: coo_array[np.bool_, tuple[int]],
188+
/,
189+
arg1: ToShape1D,
190+
shape: ToShape1D | None = None,
191+
dtype: onp.AnyBoolDType | None = None,
192+
copy: bool = False,
193+
*,
194+
maxprint: int | None = None,
195+
) -> None: ...
196+
@overload # 2-d shape-like, dtype: type[bool]
197+
def __init__(
198+
self: coo_array[np.bool_, tuple[int, int]],
199+
/,
200+
arg1: ToShape2D,
201+
shape: ToShape2D | None = None,
202+
dtype: onp.AnyBoolDType | None = None,
203+
copy: bool = False,
204+
*,
205+
maxprint: int | None = None,
206+
) -> None: ...
207+
@overload # >2-d shape-like, dtype: type[bool]
208+
def __init__(
209+
self: coo_array[np.bool_, onp.AtLeast3D],
210+
/,
211+
arg1: ToShapeMin3D,
212+
shape: ToShapeMin3D | None = None,
213+
dtype: onp.AnyBoolDType | None = None,
214+
copy: bool = False,
215+
*,
216+
maxprint: int | None = None,
217+
) -> None: ...
218+
@overload # 1-d shape-like, dtype: type[int]
219+
def __init__(
220+
self: coo_array[np.int64, tuple[int]],
221+
/,
222+
arg1: ToShape1D,
223+
shape: ToShape1D | None = None,
224+
dtype: onp.AnyIntDType | None = None,
225+
copy: bool = False,
226+
*,
227+
maxprint: int | None = None,
228+
) -> None: ...
229+
@overload # 2-d shape-like, dtype: type[int]
230+
def __init__(
231+
self: coo_array[np.int64, tuple[int, int]],
232+
/,
233+
arg1: ToShape2D,
234+
shape: ToShape2D | None = None,
235+
dtype: onp.AnyIntDType | None = None,
236+
copy: bool = False,
237+
*,
238+
maxprint: int | None = None,
239+
) -> None: ...
240+
@overload # >2-d shape-like, dtype: type[int]
241+
def __init__(
242+
self: coo_array[np.int64, onp.AtLeast3D],
243+
/,
244+
arg1: ToShapeMin3D,
245+
shape: ToShapeMin3D | None = None,
246+
dtype: onp.AnyIntDType | None = None,
247+
copy: bool = False,
248+
*,
249+
maxprint: int | None = None,
250+
) -> None: ...
251+
@overload # 1-d shape-like, dtype: type[float]
252+
def __init__(
253+
self: coo_array[np.float64, tuple[int]],
254+
/,
255+
arg1: ToShape1D,
256+
shape: ToShape1D | None = None,
257+
dtype: onp.AnyFloat64DType | None = None,
258+
copy: bool = False,
259+
*,
260+
maxprint: int | None = None,
261+
) -> None: ...
262+
@overload # 2-d shape-like, dtype: type[float]
263+
def __init__(
264+
self: coo_array[np.float64, tuple[int, int]],
265+
/,
266+
arg1: ToShape2D,
267+
shape: ToShape2D | None = None,
268+
dtype: onp.AnyFloat64DType | None = None,
269+
copy: bool = False,
270+
*,
271+
maxprint: int | None = None,
272+
) -> None: ...
273+
@overload # >2-d shape-like, dtype: type[float]
175274
def __init__(
176275
self: coo_array[np.float64, onp.AtLeast3D],
177276
/,
@@ -182,6 +281,39 @@ class coo_array(_coo_base[_ScalarT_co, _ShapeT_co], sparray[_ScalarT_co, _ShapeT
182281
*,
183282
maxprint: int | None = None,
184283
) -> None: ...
284+
@overload # 1-d shape-like, dtype: type[complex]
285+
def __init__(
286+
self: coo_array[np.complex128, tuple[int]],
287+
/,
288+
arg1: ToShape1D,
289+
shape: ToShape1D | None = None,
290+
dtype: onp.AnyComplex128DType | None = None,
291+
copy: bool = False,
292+
*,
293+
maxprint: int | None = None,
294+
) -> None: ...
295+
@overload # 2-d shape-like, dtype: type[complex]
296+
def __init__(
297+
self: coo_array[np.complex128, tuple[int, int]],
298+
/,
299+
arg1: ToShape2D,
300+
shape: ToShape2D | None = None,
301+
dtype: onp.AnyComplex128DType | None = None,
302+
copy: bool = False,
303+
*,
304+
maxprint: int | None = None,
305+
) -> None: ...
306+
@overload # >2-d shape-like, dtype: type[complex]
307+
def __init__(
308+
self: coo_array[np.complex128, onp.AtLeast3D],
309+
/,
310+
arg1: ToShapeMin3D,
311+
shape: ToShapeMin3D | None = None,
312+
dtype: onp.AnyComplex64DType | None = None,
313+
copy: bool = False,
314+
*,
315+
maxprint: int | None = None,
316+
) -> None: ...
185317
@overload # vector-like builtins.bool, dtype: type[bool] | None
186318
def __init__(
187319
self: coo_array[np.bool_, tuple[int]],

‎scipy-stubs/sparse/_csc.pyi

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,39 @@ class csc_array(_csc_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
7878
maxprint: int | None = None,
7979
) -> None: ...
8080
@overload # 2-d shape-like, dtype: None
81+
def __init__(
82+
self: csc_array[np.float64],
83+
/,
84+
arg1: ToShape2D,
85+
shape: ToShape2D | None = None,
86+
dtype: None = None,
87+
copy: bool = False,
88+
*,
89+
maxprint: int | None = None,
90+
) -> None: ...
91+
@overload # 2-d shape-like, dtype: type[bool]
92+
def __init__(
93+
self: csc_array[np.bool_],
94+
/,
95+
arg1: ToShape2D,
96+
shape: ToShape2D | None = None,
97+
dtype: onp.AnyBoolDType | None = None,
98+
copy: bool = False,
99+
*,
100+
maxprint: int | None = None,
101+
) -> None: ...
102+
@overload # 2-d shape-like, dtype: type[int]
103+
def __init__(
104+
self: csc_array[np.int64],
105+
/,
106+
arg1: ToShape2D,
107+
shape: ToShape2D | None = None,
108+
dtype: onp.AnyIntDType | None = None,
109+
copy: bool = False,
110+
*,
111+
maxprint: int | None = None,
112+
) -> None: ...
113+
@overload # 2-d shape-like, dtype: type[float]
81114
def __init__(
82115
self: csc_array[np.float64],
83116
/,
@@ -88,6 +121,17 @@ class csc_array(_csc_base[_ScalarT_co], sparray[_ScalarT_co, tuple[int, int]], G
88121
*,
89122
maxprint: int | None = None,
90123
) -> None: ...
124+
@overload # 2-d shape-like, dtype: type[complex]
125+
def __init__(
126+
self: csc_array[np.complex128],
127+
/,
128+
arg1: ToShape2D,
129+
shape: ToShape2D | None = None,
130+
dtype: onp.AnyComplex128DType | None = None,
131+
copy: bool = False,
132+
*,
133+
maxprint: int | None = None,
134+
) -> None: ...
91135
@overload # 2-d array-like bool, dtype: type[bool] | None
92136
def __init__(
93137
self: csc_array[np.bool_],

‎scipy-stubs/sparse/_csr.pyi

Lines changed: 89 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,12 +126,78 @@ class csr_array(_csr_base[_ScalarT_co, _ShapeT_co], sparray[_ScalarT_co, _ShapeT
126126
/,
127127
arg1: ToShape1D,
128128
shape: ToShape1D | None = None,
129-
dtype: onp.AnyFloat64DType | None = None,
129+
dtype: None = None,
130130
copy: bool = False,
131131
*,
132132
maxprint: int | None = None,
133133
) -> None: ...
134134
@overload # 2-d shape-like, dtype: None
135+
def __init__(
136+
self: csr_array[np.float64, tuple[int, int]],
137+
/,
138+
arg1: ToShape2D,
139+
shape: ToShape2D | None = None,
140+
dtype: None = None,
141+
copy: bool = False,
142+
*,
143+
maxprint: int | None = None,
144+
) -> None: ...
145+
@overload # 1-d shape-like, dtype: type[bool]
146+
def __init__(
147+
self: csr_array[np.bool_, tuple[int]],
148+
/,
149+
arg1: ToShape1D,
150+
shape: ToShape1D | None = None,
151+
dtype: onp.AnyBoolDType | None = None,
152+
copy: bool = False,
153+
*,
154+
maxprint: int | None = None,
155+
) -> None: ...
156+
@overload # 2-d shape-like, dtype: type[bool]
157+
def __init__(
158+
self: csr_array[np.bool_, tuple[int, int]],
159+
/,
160+
arg1: ToShape2D,
161+
shape: ToShape2D | None = None,
162+
dtype: onp.AnyBoolDType | None = None,
163+
copy: bool = False,
164+
*,
165+
maxprint: int | None = None,
166+
) -> None: ...
167+
@overload # 1-d shape-like, dtype: type[int]
168+
def __init__(
169+
self: csr_array[np.int64, tuple[int]],
170+
/,
171+
arg1: ToShape1D,
172+
shape: ToShape1D | None = None,
173+
dtype: onp.AnyIntDType | None = None,
174+
copy: bool = False,
175+
*,
176+
maxprint: int | None = None,
177+
) -> None: ...
178+
@overload # 2-d shape-like, dtype: type[int]
179+
def __init__(
180+
self: csr_array[np.int64, tuple[int, int]],
181+
/,
182+
arg1: ToShape2D,
183+
shape: ToShape2D | None = None,
184+
dtype: onp.AnyIntDType | None = None,
185+
copy: bool = False,
186+
*,
187+
maxprint: int | None = None,
188+
) -> None: ...
189+
@overload # 1-d shape-like, dtype: type[float]
190+
def __init__(
191+
self: csr_array[np.float64, tuple[int]],
192+
/,
193+
arg1: ToShape1D,
194+
shape: ToShape1D | None = None,
195+
dtype: onp.AnyFloat64DType | None = None,
196+
copy: bool = False,
197+
*,
198+
maxprint: int | None = None,
199+
) -> None: ...
200+
@overload # 2-d shape-like, dtype: type[float]
135201
def __init__(
136202
self: csr_array[np.float64, tuple[int, int]],
137203
/,
@@ -142,6 +208,28 @@ class csr_array(_csr_base[_ScalarT_co, _ShapeT_co], sparray[_ScalarT_co, _ShapeT
142208
*,
143209
maxprint: int | None = None,
144210
) -> None: ...
211+
@overload # 1-d shape-like, dtype: type[complex]
212+
def __init__(
213+
self: csr_array[np.complex128, tuple[int]],
214+
/,
215+
arg1: ToShape1D,
216+
shape: ToShape1D | None = None,
217+
dtype: onp.AnyComplex128DType | None = None,
218+
copy: bool = False,
219+
*,
220+
maxprint: int | None = None,
221+
) -> None: ...
222+
@overload # 2-d shape-like, dtype: type[complex]
223+
def __init__(
224+
self: csr_array[np.complex128, tuple[int, int]],
225+
/,
226+
arg1: ToShape2D,
227+
shape: ToShape2D | None = None,
228+
dtype: onp.AnyComplex128DType | None = None,
229+
copy: bool = False,
230+
*,
231+
maxprint: int | None = None,
232+
) -> None: ...
145233
@overload # 1-d array-like bool, dtype: type[bool] | None
146234
def __init__(
147235
self: csr_array[np.bool_, tuple[int]],

0 commit comments

Comments
 (0)