mypy passing

Signed-off-by: nstarman <nstarkman@protonmail.com>

Author: nstarman

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: "v1.0.0"
+    hooks:
+      - id: mypy
+        additional_dependencies: [typing_extensions>=4.4.0]
+        args:
+          - --ignore-missing-imports

pyproject.toml

@@ -17,3 +17,12 @@ Homepage = "https://data-apis.org/"
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
+
+
+[tool.mypy]
+python_version = "3.9"
+mypy_path = "$MYPY_CONFIG_FILE_DIR/src/array_api_stubs/_draft/"
+files = [
+    "src/array_api_stubs/_draft/**/*.py"
+]
+follow_imports = "silent"

src/array_api_stubs/_draft/array_object.py

@@ -2,17 +2,18 @@
 
 from typing import TYPE_CHECKING, Protocol, TypeVar
 
-from ._types import (
-    dtype as Dtype,
-    device as Device,
-    Any,
-    PyCapsule,
-    Enum,
-    ellipsis,
-)
+if TYPE_CHECKING:
+    from ._types import (
+        device as Device,
+        Any,
+        PyCapsule,
+        Enum,
+        ellipsis,
+    )
+    from .data_types import DType
 
-Self = TypeVar("Self", bound="Array")
-# NOTE: when working with py3.11+ this can be ``typing.Self``.
+array = TypeVar("array", bound="Array")
+# NOTE: when working with py3.11+ this can be ``typing.array``.
 
 
 class Array(Protocol):
@@ -21,7 +22,7 @@ def __init__(self) -> None:
         ...
 
     @property
-    def dtype(self) -> Dtype:
+    def dtype(self) -> DType:
         """
         Data type of the array elements.
 
@@ -45,7 +46,7 @@ def device(self) -> Device:
         ...
 
     @property
-    def mT(self: Self) -> Self:
+    def mT(self: array) -> array:
         """
         Transpose of a matrix (or a stack of matrices).
 
@@ -109,7 +110,7 @@ def size(self) -> int | None:
         ...
 
     @property
-    def T(self: Self) -> Self:
+    def T(self: array) -> array:
         """
         Transpose of the array.
 
@@ -126,7 +127,7 @@ def T(self: Self) -> Self:
         """
         ...
 
-    def __abs__(self: Self, /) -> Self:
+    def __abs__(self: array, /) -> array:
         """
         Calculates the absolute value for each element of an array instance.
 
@@ -156,7 +157,7 @@ def __abs__(self: Self, /) -> Self:
         """
         ...
 
-    def __add__(self: Self, other: int | float | Self, /) -> Self:
+    def __add__(self: array, other: int | float | array, /) -> array:
         """
         Calculates the sum for each element of an array instance with the respective element of the array ``other``.
 
@@ -183,7 +184,7 @@ def __add__(self: Self, other: int | float | Self, /) -> Self:
         """
         ...
 
-    def __and__(self: Self, other: int | bool | Self, /) -> Self:
+    def __and__(self: array, other: int | bool | array, /) -> array:
         """
         Evaluates ``self_i & other_i`` for each element of an array instance with the respective element of the array ``other``.
 
@@ -394,7 +395,7 @@ def __dlpack_device__(self, /) -> tuple[Enum, int]:
     # Note that __eq__ returns an array while `object.__eq__` returns a bool.
     # Hence Mypy will complain that this violates the Liskov substitution
     # principle - ignore that.
-    def __eq__(self: Self, other: int | float | bool | Self, /) -> Self:  # xtype: ignore
+    def __eq__(self: array, other: int | float | bool | array, /) -> array:  # type: ignore[override]
         r"""
         Computes the truth value of ``self_i == other_i`` for each element of an array instance with the respective element of the array ``other``.
 
@@ -448,7 +449,7 @@ def __float__(self, /) -> float:
         """
         ...
 
-    def __floordiv__(self: Self, other: int | float | Self, /) -> Self:
+    def __floordiv__(self: array, other: int | float | array, /) -> array:
         """
         Evaluates ``self_i // other_i`` for each element of an array instance with the respective element of the array ``other``.
 
@@ -473,7 +474,7 @@ def __floordiv__(self: Self, other: int | float | Self, /) -> Self:
         """
         ...
 
-    def __ge__(self: Self, other: int | float | Self, /) -> Self:
+    def __ge__(self: array, other: int | float | array, /) -> array:
         """
         Computes the truth value of ``self_i >= other_i`` for each element of an array instance with the respective element of the array ``other``.
 
@@ -499,10 +500,10 @@ def __ge__(self: Self, other: int | float | Self, /) -> Self:
         ...
 
     def __getitem__(
-        self: Self,
-        key: int | slice | ellipsis | tuple[int | slice | ellipsis, ...] | Self,
+        self: array,
+        key: int | slice | ellipsis | tuple[int | slice | ellipsis, ...] | array,
         /,
-    ) -> Self:
+    ) -> array:
         """
         Returns ``self[key]``.
 
@@ -520,7 +521,7 @@ def __getitem__(
         """
         ...
 
-    def __gt__(self: Self, other: int | float | Self, /) -> Self:
+    def __gt__(self: array, other: int | float | array, /) -> array:
         """
         Computes the truth value of ``self_i > other_i`` for each element of an array instance with the respective element of the array ``other``.
 
@@ -605,7 +606,7 @@ def __int__(self, /) -> int:
         """
         ...
 
-    def __invert__(self: Self, /) -> Self:
+    def __invert__(self: array, /) -> array:
         """
         Evaluates ``~self_i`` for each element of an array instance.
 
@@ -625,7 +626,7 @@ def __invert__(self: Self, /) -> Self:
         """
         ...
 
-    def __le__(self: Self, other: int | float | Self, /) -> Self:
+    def __le__(self: array, other: int | float | array, /) -> array:
         """
         Computes the truth value of ``self_i <= other_i`` for each element of an array instance with the respective element of the array ``other``.
 
@@ -650,7 +651,7 @@ def __le__(self: Self, other: int | float | Self, /) -> Self:
         """
         ...
 
-    def __lshift__(self: Self, other: int | Self, /) -> Self:
+    def __lshift__(self: array, other: int | array, /) -> array:
         """
         Evaluates ``self_i << other_i`` for each element of an array instance with the respective element  of the array ``other``.
 
@@ -672,7 +673,7 @@ def __lshift__(self: Self, other: int | Self, /) -> Self:
         """
         ...
 
-    def __lt__(self: Self, other: int | float | Self, /) -> Self:
+    def __lt__(self: array, other: int | float | array, /) -> array:
         """
         Computes the truth value of ``self_i < other_i`` for each element of an array instance with the respective element of the array ``other``.
 
@@ -697,7 +698,7 @@ def __lt__(self: Self, other: int | float | Self, /) -> Self:
         """
         ...
 
-    def __matmul__(self: Self, other: Self, /) -> Self:
+    def __matmul__(self: array, other: array, /) -> array:
         """
         Computes the matrix product.
 
@@ -746,7 +747,7 @@ def __matmul__(self: Self, other: Self, /) -> Self:
         """
         ...
 
-    def __mod__(self: Self, other: int | float | Self, /) -> Self:
+    def __mod__(self: array, other: int | float | array, /) -> array:
         """
         Evaluates ``self_i % other_i`` for each element of an array instance with the respective element of the array ``other``.
 
@@ -771,7 +772,7 @@ def __mod__(self: Self, other: int | float | Self, /) -> Self:
         """
         ...
 
-    def __mul__(self: Self, other: int | float | Self, /) -> Self:
+    def __mul__(self: array, other: int | float | array, /) -> array:
         r"""
         Calculates the product for each element of an array instance with the respective element of the array ``other``.
 
@@ -802,7 +803,7 @@ def __mul__(self: Self, other: int | float | Self, /) -> Self:
         ...
 
     # See note above __eq__ method for explanation of the `type: ignore`
-    def __ne__(self: Self, other: int | float | bool | Self, /) -> Self:  # type: ignore
+    def __ne__(self: array, other: int | float | bool | array, /) -> array:  # type: ignore[override]
         """
         Computes the truth value of ``self_i != other_i`` for each element of an array instance with the respective element of the array ``other``.
 
@@ -830,7 +831,7 @@ def __ne__(self: Self, other: int | float | bool | Self, /) -> Self:  # type: ig
         """
         ...
 
-    def __neg__(self: Self, /) -> Self:
+    def __neg__(self: array, /) -> array:
         """
         Evaluates ``-self_i`` for each element of an array instance.
 
@@ -861,7 +862,7 @@ def __neg__(self: Self, /) -> Self:
         """
         ...
 
-    def __or__(self: Self, other: int | bool | Self, /) -> Self:
+    def __or__(self: array, other: int | bool | array, /) -> array:
         """
         Evaluates ``self_i | other_i`` for each element of an array instance with the respective element of the array ``other``.
 
@@ -883,7 +884,7 @@ def __or__(self: Self, other: int | bool | Self, /) -> Self:
         """
         ...
 
-    def __pos__(self: Self, /) -> Self:
+    def __pos__(self: array, /) -> array:
         """
         Evaluates ``+self_i`` for each element of an array instance.
 
@@ -908,7 +909,7 @@ def __pos__(self: Self, /) -> Self:
         """
         ...
 
-    def __pow__(self: Self, other: int | float | Self, /) -> Self:
+    def __pow__(self: array, other: int | float | array, /) -> array:
         r"""
         Calculates an implementation-dependent approximation of exponentiation by raising each element (the base) of an array instance to the power of ``other_i`` (the exponent), where ``other_i`` is the corresponding element of the array ``other``.
 
@@ -940,7 +941,7 @@ def __pow__(self: Self, other: int | float | Self, /) -> Self:
         """
         ...
 
-    def __rshift__(self: Self, other: int | Self, /) -> Self:
+    def __rshift__(self: array, other: int | array, /) -> array:
         """
         Evaluates ``self_i >> other_i`` for each element of an array instance with the respective element of the array ``other``.
 
@@ -963,9 +964,9 @@ def __rshift__(self: Self, other: int | Self, /) -> Self:
         ...
 
     def __setitem__(
-        self: Self,
-        key: int | slice | ellipsis | tuple[int | slice | ellipsis, ...] | Self,
-        value: int | float | bool | Self,
+        self: array,
+        key: int | slice | ellipsis | tuple[int | slice | ellipsis, ...] | array,
+        value: int | float | bool | array,
         /,
     ) -> None:
         """
@@ -991,7 +992,7 @@ def __setitem__(
         """
         ...
 
-    def __sub__(self: Self, other: int | float | Self, /) -> Self:
+    def __sub__(self: array, other: int | float | array, /) -> array:
         """
         Calculates the difference for each element of an array instance with the respective element of the array ``other``.
 
@@ -1020,7 +1021,7 @@ def __sub__(self: Self, other: int | float | Self, /) -> Self:
         """
         ...
 
-    def __truediv__(self: Self, other: int | float | Self, /) -> Self:
+    def __truediv__(self: array, other: int | float | array, /) -> array:
         r"""
         Evaluates ``self_i / other_i`` for each element of an array instance with the respective element of the array ``other``.
 
@@ -1052,7 +1053,7 @@ def __truediv__(self: Self, other: int | float | Self, /) -> Self:
         """
         ...
 
-    def __xor__(self: Self, other: int | bool | Self, /) -> Self:
+    def __xor__(self: array, other: int | bool | array, /) -> array:
         """
         Evaluates ``self_i ^ other_i`` for each element of an array instance with the respective element of the array ``other``.
 
@@ -1075,8 +1076,8 @@ def __xor__(self: Self, other: int | bool | Self, /) -> Self:
         ...
 
     def to_device(
-        self: Self, device: Device, /, *, stream: int | Any | None = None
-    ) -> Self:
+        self: array, device: Device, /, *, stream: int | Any | None = None
+    ) -> array:
         """
         Copy the array from the device on which it currently resides to the specified ``device``.
 
@@ -1101,6 +1102,4 @@ def to_device(
         ...
 
 
-array = Array
-
-__all__ = ["array"]
+__all__ = ["Array"]

src/array_api_stubs/_draft/linalg.py

@@ -272,7 +272,7 @@ def matrix_norm(
     /,
     *,
     keepdims: bool = False,
-    ord: Optional[Union[int, float, Literal[inf, -inf, "fro", "nuc"]]] = "fro",
+    ord: Optional[Union[int, float, Literal[inf, -inf, "fro", "nuc"]]] = "fro",  # type: ignore
 ) -> array:
     """
     Computes the matrix norm of a matrix (or a stack of matrices) ``x``.
@@ -765,7 +765,7 @@ def vector_norm(
     *,
     axis: Optional[Union[int, Tuple[int, ...]]] = None,
     keepdims: bool = False,
-    ord: Union[int, float, Literal[inf, -inf]] = 2,
+    ord: Union[int, float, Literal[inf, -inf]] = 2,  # type: ignore
 ) -> array:
     r"""
     Computes the vector norm of a vector (or batch of vectors) ``x``.