🐛 sparse: add __len__ to _spbase (kinda)

Author: jorenham

scipy-stubs/sparse/_base.pyi

@@ -179,6 +179,9 @@ class _spbase(Generic[_SCT_co, _ShapeT_co]):
     #
     def __bool__(self, /) -> bool: ...
 
+    # only `dok_*` doesn't raise `TypeError` when passed to `len`
+    def __len__(self: dok_array[Any, Any] | dok_matrix[Any], /) -> int: ...  # pyright: ignore[reportGeneralTypeIssues]
+
     #
     @overload  # 1-d {csr,dok}_array
     def __iter__(self: csr_array[_SCT, _1D] | dok_array[_SCT, _1D], /) -> Iterator[_SCT]: ...

scipy-stubs/sparse/_dok.pyi

@@ -143,6 +143,10 @@ class _dok_base(_spbase[_SCT, _ShapeT_co], IndexMixin[_SCT, _ShapeT_co], dict[Sh
     @override
     def todok(self, /, copy: bool = False) -> Self: ...
 
+    #
+    @override
+    def __len__(self, /) -> int: ...
+
     #
     @overload
     def __delitem__(self: _dok_base[Any, _2D], key: _ToKey2D, /) -> None: ...
@@ -185,59 +189,69 @@ class _dok_base(_spbase[_SCT, _ShapeT_co], IndexMixin[_SCT, _ShapeT_co], dict[Sh
 
     #
     @overload
-    def get(self: _dok_base[Any, _2D], key: _ToKey2D, /, default: _T) -> _SCT | _T: ...
+    def get(self: _dok_base[Any, _2D], /, key: _ToKey2D, default: _T) -> _SCT | _T: ...
     @overload
-    def get(self: _dok_base[Any, _2D], key: _ToKey2D, /, default: float = 0.0) -> _SCT | float: ...
+    def get(self: _dok_base[Any, _2D], /, key: _ToKey2D, default: float = 0.0) -> _SCT | float: ...
     @overload
-    def get(self: _dok_base[Any, _1D], key: _ToKey1D, /, default: _T) -> _SCT | _T: ...
+    def get(self: _dok_base[Any, _1D], /, key: _ToKey1D, default: _T) -> _SCT | _T: ...
     @overload
-    def get(self: _dok_base[Any, _1D], key: _ToKey1D, /, default: float = 0.0) -> _SCT | float: ...
+    def get(self: _dok_base[Any, _1D], /, key: _ToKey1D, default: float = 0.0) -> _SCT | float: ...
     @overload
-    def get(self, key: _ToKey1D | _ToKey2D, /, default: _T) -> _SCT | _T: ...
+    def get(self, /, key: _ToKey1D | _ToKey2D, default: _T) -> _SCT | _T: ...
     @overload
-    def get(self, key: _ToKey1D | _ToKey2D, /, default: float = 0.0) -> _SCT | float: ...
+    def get(self, /, key: _ToKey1D | _ToKey2D, default: float = 0.0) -> _SCT | float: ...
 
     #
     def conjtransp(self, /) -> Self: ...
 
     #
     @overload
     @classmethod
-    def fromkeys(cls: type[_dok_base[_SCT, _2D]], ks: _ToKeys2D, v: _SCT, /) -> _dok_base[_SCT, _2D]: ...
+    def fromkeys(cls: type[_dok_base[_SCT, _2D]], iterable: _ToKeys2D, v: _SCT, /) -> _dok_base[_SCT, _2D]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[_dok_base[_SCT, _1D]], ks: _ToKeys1D, v: _SCT, /) -> _dok_base[_SCT, _1D]: ...
+    def fromkeys(cls: type[_dok_base[_SCT, _1D]], iterable: _ToKeys1D, v: _SCT, /) -> _dok_base[_SCT, _1D]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[_dok_base[np.bool_, _2D]], ks: _ToKeys2D, v: onp.ToBool, /) -> _dok_base[np.bool_, _2D]: ...
+    def fromkeys(cls: type[_dok_base[np.bool_, _2D]], iterable: _ToKeys2D, v: onp.ToBool, /) -> _dok_base[np.bool_, _2D]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[_dok_base[np.bool_, _1D]], ks: _ToKeys1D, v: onp.ToBool, /) -> _dok_base[np.bool_, _1D]: ...
+    def fromkeys(cls: type[_dok_base[np.bool_, _1D]], iterable: _ToKeys1D, v: onp.ToBool, /) -> _dok_base[np.bool_, _1D]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[_dok_base[np.int_, _2D]], ks: _ToKeys2D, v: opt.JustInt = 1, /) -> _dok_base[np.int_, _2D]: ...
+    def fromkeys(cls: type[_dok_base[np.int_, _2D]], iterable: _ToKeys2D, v: opt.JustInt = 1, /) -> _dok_base[np.int_, _2D]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[_dok_base[np.int_, _1D]], ks: _ToKeys1D, v: opt.JustInt = 1, /) -> _dok_base[np.int_, _1D]: ...
+    def fromkeys(cls: type[_dok_base[np.int_, _1D]], iterable: _ToKeys1D, v: opt.JustInt = 1, /) -> _dok_base[np.int_, _1D]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[_dok_base[np.float64, _2D]], ks: _ToKeys2D, v: opt.JustFloat, /) -> _dok_base[np.float64, _2D]: ...
+    def fromkeys(
+        cls: type[_dok_base[np.float64, _2D]],
+        iterable: _ToKeys2D,
+        v: opt.JustFloat,
+        /,
+    ) -> _dok_base[np.float64, _2D]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[_dok_base[np.float64, _1D]], ks: _ToKeys1D, v: opt.JustFloat, /) -> _dok_base[np.float64, _1D]: ...
+    def fromkeys(
+        cls: type[_dok_base[np.float64, _1D]],
+        iterable: _ToKeys1D,
+        v: opt.JustFloat,
+        /,
+    ) -> _dok_base[np.float64, _1D]: ...
     @overload
     @classmethod
     def fromkeys(
         cls: type[_dok_base[np.complex128, _2D]],
-        ks: _ToKeys2D,
+        iterable: _ToKeys2D,
         v: opt.JustComplex,
         /,
     ) -> _dok_base[np.complex128, _2D]: ...
     @overload
     @classmethod
     def fromkeys(
         cls: type[_dok_base[np.complex128, _1D]],
-        ks: _ToKeys1D,
+        iterable: _ToKeys1D,
         v: opt.JustComplex,
         /,
     ) -> _dok_base[np.complex128, _1D]: ...
@@ -248,68 +262,83 @@ class dok_array(_dok_base[_SCT, _ShapeT_co], sparray, Generic[_SCT, _ShapeT_co])
     # https://github.com/python/typing/issues/548
     @overload
     @classmethod
-    def fromkeys(cls: type[dok_array[_SCT, _2D]], ks: _ToKeys2D, v: _SCT, /) -> dok_array[_SCT, _2D]: ...
+    def fromkeys(cls: type[dok_array[_SCT, _2D]], iterable: _ToKeys2D, v: _SCT, /) -> dok_array[_SCT, _2D]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[dok_array[_SCT, _1D]], ks: _ToKeys1D, v: _SCT, /) -> dok_array[_SCT, _1D]: ...
+    def fromkeys(cls: type[dok_array[_SCT, _1D]], iterable: _ToKeys1D, v: _SCT, /) -> dok_array[_SCT, _1D]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[dok_array[np.bool_, _2D]], ks: _ToKeys2D, v: onp.ToBool, /) -> dok_array[np.bool_, _2D]: ...
+    def fromkeys(cls: type[dok_array[np.bool_, _2D]], iterable: _ToKeys2D, v: onp.ToBool, /) -> dok_array[np.bool_, _2D]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[dok_array[np.bool_, _1D]], ks: _ToKeys1D, v: onp.ToBool, /) -> dok_array[np.bool_, _1D]: ...
+    def fromkeys(cls: type[dok_array[np.bool_, _1D]], iterable: _ToKeys1D, v: onp.ToBool, /) -> dok_array[np.bool_, _1D]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[dok_array[np.int_, _2D]], ks: _ToKeys2D, v: opt.JustInt = 1, /) -> dok_array[np.int_, _2D]: ...
+    def fromkeys(cls: type[dok_array[np.int_, _2D]], iterable: _ToKeys2D, v: opt.JustInt = 1, /) -> dok_array[np.int_, _2D]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[dok_array[np.int_, _1D]], ks: _ToKeys1D, v: opt.JustInt = 1, /) -> dok_array[np.int_, _1D]: ...
+    def fromkeys(cls: type[dok_array[np.int_, _1D]], iterable: _ToKeys1D, v: opt.JustInt = 1, /) -> dok_array[np.int_, _1D]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[dok_array[np.float64, _2D]], ks: _ToKeys2D, v: opt.JustFloat, /) -> dok_array[np.float64, _2D]: ...
+    def fromkeys(
+        cls: type[dok_array[np.float64, _2D]],
+        iterable: _ToKeys2D,
+        v: opt.JustFloat,
+        /,
+    ) -> dok_array[np.float64, _2D]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[dok_array[np.float64, _1D]], ks: _ToKeys1D, v: opt.JustFloat, /) -> dok_array[np.float64, _1D]: ...
+    def fromkeys(
+        cls: type[dok_array[np.float64, _1D]],
+        iterable: _ToKeys1D,
+        v: opt.JustFloat,
+        /,
+    ) -> dok_array[np.float64, _1D]: ...
     @overload
     @classmethod
     def fromkeys(
         cls: type[dok_array[np.complex128, _2D]],
-        ks: _ToKeys2D,
+        iterable: _ToKeys2D,
         v: opt.JustComplex,
         /,
     ) -> dok_array[np.complex128, _2D]: ...
     @overload
     @classmethod
     def fromkeys(
         cls: type[dok_array[np.complex128, _1D]],
-        ks: _ToKeys1D,
+        iterable: _ToKeys1D,
         v: opt.JustComplex,
         /,
     ) -> dok_array[np.complex128, _1D]: ...
 
 #
 class dok_matrix(_dok_base[_SCT, _2D], spmatrix[_SCT], Generic[_SCT]):
     @override
-    def get(self, key: _ToKey2D, /, default: onp.ToComplex = 0.0) -> _SCT: ...
+    def get(self, /, key: _ToKey2D, default: onp.ToComplex = 0.0) -> _SCT: ...
     @override
     def setdefault(self, key: _ToKey2D, default: onp.ToComplex | None = None, /) -> _SCT: ...
 
     #
     @overload
     @classmethod
-    def fromkeys(cls, ks: _ToKeys2D, v: _SCT, /) -> Self: ...
+    def fromkeys(cls, iterable: _ToKeys2D, v: _SCT, /) -> Self: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[dok_matrix[np.bool_]], ks: _ToKeys2D, v: onp.ToBool, /) -> dok_matrix[np.bool_]: ...
+    def fromkeys(cls: type[dok_matrix[np.bool_]], iterable: _ToKeys2D, v: onp.ToBool, /) -> dok_matrix[np.bool_]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[dok_matrix[np.int_]], ks: _ToKeys2D, v: opt.JustInt = 1, /) -> dok_matrix[np.int_]: ...
+    def fromkeys(cls: type[dok_matrix[np.int_]], iterable: _ToKeys2D, v: opt.JustInt = 1, /) -> dok_matrix[np.int_]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[dok_matrix[np.float64]], ks: _ToKeys2D, v: opt.JustFloat, /) -> dok_matrix[np.float64]: ...
+    def fromkeys(cls: type[dok_matrix[np.float64]], iterable: _ToKeys2D, v: opt.JustFloat, /) -> dok_matrix[np.float64]: ...
     @overload
     @classmethod
-    def fromkeys(cls: type[dok_matrix[np.complex128]], ks: _ToKeys2D, v: opt.JustComplex, /) -> dok_matrix[np.complex128]: ...
+    def fromkeys(
+        cls: type[dok_matrix[np.complex128]],
+        iterable: _ToKeys2D,
+        v: opt.JustComplex,
+        /,
+    ) -> dok_matrix[np.complex128]: ...
 
 #
 def isspmatrix_dok(x: object) -> TypeIs[dok_matrix]: ...