TYP: Force matrix shape type to be 2D

Author: Jacob-Stevens-Haas

.gitignore

@@ -1,6 +1,5 @@
 # Editor temporary/working/backup files #
 #########################################
-env/
 .#*
 [#]*#
 *~

doc/release/upcoming_changes/26081.improvement.rst

@@ -5,6 +5,7 @@ with this change.  It is a generic type with type parameters for
 the shape and the data type.  Previously, the shape type parameter could be
 any value.  This change restricts it to a tuple of ints, as one would expect
 from using ``ndarray.shape``.  Further, the shape-type parameter has been
-changed from invariant to covariant.  This change also applies to subpytes of
-``ndarray``, e.g. ``np.ma.MaskedArray``.  See the `typing docs <https://typing.readthedocs.io/en/latest/reference/generics.html#variance-of-generic-types>`_
+changed from invariant to covariant.  This change also applies to the subtypes
+of ``ndarray``, e.g. ``numpy.ma.MaskedArray``.  See the
+`typing docs <https://typing.readthedocs.io/en/latest/reference/generics.html#variance-of-generic-types>`_
 for more information.

numpy/__init__.pyi

@@ -1502,6 +1502,7 @@ _FlexDType = TypeVar("_FlexDType", bound=dtype[flexible])
 
 _ShapeType_co = TypeVar("_ShapeType_co", covariant=True, bound=tuple[int, ...])
 _ShapeType2 = TypeVar("_ShapeType2", bound=tuple[int, ...])
+_Shape2DType_co = TypeVar("_Shape2DType_co", covariant=True, bound=tuple[int, int])
 _NumberType = TypeVar("_NumberType", bound=number[Any])
 
 if sys.version_info >= (3, 12):
@@ -3925,7 +3926,9 @@ class poly1d:
         k: None | _ArrayLikeComplex_co | _ArrayLikeObject_co = ...,
     ) -> poly1d: ...
 
-class matrix(ndarray[_ShapeType_co, _DType_co]):
+
+
+class matrix(ndarray[_Shape2DType_co, _DType_co]):
     __array_priority__: ClassVar[float]
     def __new__(
         subtype,
@@ -3961,13 +3964,13 @@ class matrix(ndarray[_ShapeType_co, _DType_co]):
     @overload
     def __getitem__(self: NDArray[void], key: str, /) -> matrix[Any, dtype[Any]]: ...
     @overload
-    def __getitem__(self: NDArray[void], key: list[str], /) -> matrix[_ShapeType_co, dtype[void]]: ...
+    def __getitem__(self: NDArray[void], key: list[str], /) -> matrix[_Shape2DType_co, dtype[void]]: ...
 
     def __mul__(self, other: ArrayLike, /) -> matrix[Any, Any]: ...
     def __rmul__(self, other: ArrayLike, /) -> matrix[Any, Any]: ...
-    def __imul__(self, other: ArrayLike, /) -> matrix[_ShapeType_co, _DType_co]: ...
+    def __imul__(self, other: ArrayLike, /) -> matrix[_Shape2DType_co, _DType_co]: ...
     def __pow__(self, other: ArrayLike, /) -> matrix[Any, Any]: ...
-    def __ipow__(self, other: ArrayLike, /) -> matrix[_ShapeType_co, _DType_co]: ...
+    def __ipow__(self, other: ArrayLike, /) -> matrix[_Shape2DType_co, _DType_co]: ...
 
     @overload
     def sum(self, axis: None = ..., dtype: DTypeLike = ..., out: None = ...) -> Any: ...
@@ -4063,14 +4066,14 @@ class matrix(ndarray[_ShapeType_co, _DType_co]):
     @property
     def I(self) -> matrix[Any, Any]: ...
     @property
-    def A(self) -> ndarray[_ShapeType_co, _DType_co]: ...
+    def A(self) -> ndarray[_Shape2DType_co, _DType_co]: ...
     @property
     def A1(self) -> ndarray[Any, _DType_co]: ...
     @property
     def H(self) -> matrix[Any, _DType_co]: ...
     def getT(self) -> matrix[Any, _DType_co]: ...
     def getI(self) -> matrix[Any, Any]: ...
-    def getA(self) -> ndarray[_ShapeType_co, _DType_co]: ...
+    def getA(self) -> ndarray[_Shape2DType_co, _DType_co]: ...
     def getA1(self) -> ndarray[Any, _DType_co]: ...
     def getH(self) -> matrix[Any, _DType_co]: ...