Improved stubs for block_array and bmat

Author: JulVandenBroeck

scipy-stubs/sparse/_construct.pyi

@@ -47,6 +47,7 @@ _Numeric: TypeAlias = npc.number | np.bool_
 
 _SpBase2D: TypeAlias = _spbase[_SCT, tuple[int, int]]
 _SpArray2D: TypeAlias = sparray[_SCT, tuple[int, int]]
+_SpMatrix: TypeAlias = spmatrix[_SCT]
 
 _BSRArray: TypeAlias = bsr_array[_SCT]
 _COOArray2D: TypeAlias = coo_array[_SCT, tuple[int, int]]
@@ -1386,19 +1387,19 @@ def kronsum(A: onp.ToComplex2D, B: onp.ToComplex2D, format: _Format | None = Non
 @overload  # sparray, format: <default>, dtype: <default>
 def hstack(blocks: Seq[_CanStack[_T]], format: None = None, dtype: None = None) -> _T: ...
 @overload  # sparray, format: "bsr", dtype: <default>
-def hstack(blocks: Seq[_SpArray[_SCT]], format: _FmtBSR, dtype: None = None) -> _BSRArray[_SCT]: ...
+def hstack(blocks: Seq[_SpArray2D[_SCT]], format: _FmtBSR, dtype: None = None) -> _BSRArray[_SCT]: ...
 @overload  # sparray, format: "coo", dtype: <default>
-def hstack(blocks: Seq[_SpArray[_SCT]], format: _FmtCOO, dtype: None = None) -> _COOArray2D[_SCT]: ...
+def hstack(blocks: Seq[_SpArray2D[_SCT]], format: _FmtCOO, dtype: None = None) -> _COOArray2D[_SCT]: ...
 @overload  # sparray, format: "csc", dtype: <default>
-def hstack(blocks: Seq[_SpArray[_SCT]], format: _FmtCSC, dtype: None = None) -> _CSCArray[_SCT]: ...
+def hstack(blocks: Seq[_SpArray2D[_SCT]], format: _FmtCSC, dtype: None = None) -> _CSCArray[_SCT]: ...
 @overload  # sparray, format: "csr", dtype: <default>
-def hstack(blocks: Seq[_SpArray[_SCT]], format: _FmtCSR, dtype: None = None) -> _CSRArray2D[_SCT]: ...
+def hstack(blocks: Seq[_SpArray2D[_SCT]], format: _FmtCSR, dtype: None = None) -> _CSRArray2D[_SCT]: ...
 @overload  # sparray, format: "dia", dtype: <default>
-def hstack(blocks: Seq[_SpArray[_SCT]], format: _FmtDIA, dtype: None = None) -> _DIAArray[_SCT]: ...
+def hstack(blocks: Seq[_SpArray2D[_SCT]], format: _FmtDIA, dtype: None = None) -> _DIAArray[_SCT]: ...
 @overload  # sparray, format: "dok", dtype: <default>
-def hstack(blocks: Seq[_SpArray[_SCT]], format: _FmtDOK, dtype: None = None) -> _DOKArray2D[_SCT]: ...
+def hstack(blocks: Seq[_SpArray2D[_SCT]], format: _FmtDOK, dtype: None = None) -> _DOKArray2D[_SCT]: ...
 @overload  # sparray, format: "lil", dtype: <default>
-def hstack(blocks: Seq[_SpArray[_SCT]], format: _FmtLIL, dtype: None = None) -> _LILArray[_SCT]: ...
+def hstack(blocks: Seq[_SpArray2D[_SCT]], format: _FmtLIL, dtype: None = None) -> _LILArray[_SCT]: ...
 
 #
 @overload  # sparray, format: <default>, dtype: bool-like
@@ -1517,19 +1518,19 @@ def hstack(blocks: Seq[_spbase], format: _Format, dtype: npt.DTypeLike | None =
 @overload  # sparray, format: <default>, dtype: <default>
 def vstack(blocks: Seq[_CanStack[_T]], format: None = None, dtype: None = None) -> _T: ...
 @overload  # sparray, format: "bsr", dtype: <default>
-def vstack(blocks: Seq[_SpArray[_SCT]], format: _FmtBSR, dtype: None = None) -> _BSRArray[_SCT]: ...
+def vstack(blocks: Seq[_SpArray2D[_SCT]], format: _FmtBSR, dtype: None = None) -> _BSRArray[_SCT]: ...
 @overload  # sparray, format: "coo", dtype: <default>
-def vstack(blocks: Seq[_SpArray[_SCT]], format: _FmtCOO, dtype: None = None) -> _COOArray2D[_SCT]: ...
+def vstack(blocks: Seq[_SpArray2D[_SCT]], format: _FmtCOO, dtype: None = None) -> _COOArray2D[_SCT]: ...
 @overload  # sparray, format: "csc", dtype: <default>
-def vstack(blocks: Seq[_SpArray[_SCT]], format: _FmtCSC, dtype: None = None) -> _CSCArray[_SCT]: ...
+def vstack(blocks: Seq[_SpArray2D[_SCT]], format: _FmtCSC, dtype: None = None) -> _CSCArray[_SCT]: ...
 @overload  # sparray, format: "csr", dtype: <default>
-def vstack(blocks: Seq[_SpArray[_SCT]], format: _FmtCSR, dtype: None = None) -> _CSRArray2D[_SCT]: ...
+def vstack(blocks: Seq[_SpArray2D[_SCT]], format: _FmtCSR, dtype: None = None) -> _CSRArray2D[_SCT]: ...
 @overload  # sparray, format: "dia", dtype: <default>
-def vstack(blocks: Seq[_SpArray[_SCT]], format: _FmtDIA, dtype: None = None) -> _DIAArray[_SCT]: ...
+def vstack(blocks: Seq[_SpArray2D[_SCT]], format: _FmtDIA, dtype: None = None) -> _DIAArray[_SCT]: ...
 @overload  # sparray, format: "dok", dtype: <default>
-def vstack(blocks: Seq[_SpArray[_SCT]], format: _FmtDOK, dtype: None = None) -> _DOKArray2D[_SCT]: ...
+def vstack(blocks: Seq[_SpArray2D[_SCT]], format: _FmtDOK, dtype: None = None) -> _DOKArray2D[_SCT]: ...
 @overload  # sparray, format: "lil", dtype: <default>
-def vstack(blocks: Seq[_SpArray[_SCT]], format: _FmtLIL, dtype: None = None) -> _LILArray[_SCT]: ...
+def vstack(blocks: Seq[_SpArray2D[_SCT]], format: _FmtLIL, dtype: None = None) -> _LILArray[_SCT]: ...
 
 #
 @overload  # sparray, format: <default>, dtype: bool-like