fix: array to Array

Co-authored-by: Nathaniel Starkman <[email protected]>

Author: 34j

.pre-commit-config.yaml

@@ -48,11 +48,29 @@ repos:
     rev: 23.7.0
     hooks:
       - id: black
+
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.13.0
+    rev: "v1.0.0"
     hooks:
       - id: mypy
-        additional_dependencies: []
-        args: [--ignore-missing-imports, .]
-        pass_filenames: false
-        exclude: "src/array_api_stubs/.*"
+        additional_dependencies: [typing_extensions>=4.4.0]
+        args:
+          - --ignore-missing-imports
+          - --config=pyproject.toml
+        files: ".*(_draft.*)$"
+        exclude: |
+          (?x)^(
+              .*creation_functions.py|
+              .*data_type_functions.py|
+              .*elementwise_functions.py|
+              .*fft.py|
+              .*indexing_functions.py|
+              .*linalg.py|
+              .*linear_algebra_functions.py|
+              .*manipulation_functions.py|
+              .*searching_functions.py|
+              .*set_functions.py|
+              .*sorting_functions.py|
+              .*statistical_functions.py|
+              .*utility_functions.py|
+          )$

pyproject.toml

@@ -34,14 +34,10 @@ build-backend = "setuptools.build_meta"
 line-length = 88
 
 [tool.mypy]
-exclude = [
-    "docs/.*",
-    "spec/.*",
-    "venv/.*",
-    ".venv/.*",
-    "src/array_api_stubs/_2021_12/.*",
-    "src/array_api_stubs/_2022_12/.*",
-    "src/array_api_stubs/_2023_12/.*",
-    "src/_array_api_conf.py"
+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"
 disable_error_code = "empty-body,type-var"

src/_array_api_conf.py

@@ -66,7 +66,9 @@
 ]
 nitpick_ignore_regex = [
     ("py:class", ".*array"),
+    ("py:class", ".*Array"),
     ("py:class", ".*device"),
+    ("py:class", ".*Device"),
     ("py:class", ".*dtype"),
     ("py:class", ".*NestedSequence"),
     ("py:class", ".*SupportsBufferProtocol"),
@@ -84,6 +86,7 @@
     "array": "array",
     "Device": "device",
     "Dtype": "dtype",
+    "DType": "dtype",
 }
 
 # Make autosummary show the signatures of functions in the tables using actual

src/array_api_stubs/_draft/_types.py

@@ -31,7 +31,6 @@
     "Info",
 ]
 
-from dataclasses import dataclass
 from typing import (
     Any,
     List,
@@ -45,12 +44,13 @@
     Protocol,
 )
 from enum import Enum
+from .data_types import DType
 
 array = TypeVar("array", bound="_array")
 device = TypeVar("device")
-dtype = TypeVar("dtype")
-Device = TypeVar("Device")
-Dtype = TypeVar("Dtype")
+dtype = TypeVar("dtype", bound=DType)
+device_ = TypeVar("device_")  # only used in this file
+dtype_ = TypeVar("dtype_", bound=DType)  # only used in this file
 SupportsDLPack = TypeVar("SupportsDLPack")
 SupportsBufferProtocol = TypeVar("SupportsBufferProtocol")
 PyCapsule = TypeVar("PyCapsule")
@@ -149,12 +149,12 @@ def dtypes(
 )
 
 
-class _array(Protocol[array, Dtype, Device, PyCapsule]):  # type: ignore
+class _array(Protocol[array, dtype_, device_, PyCapsule]):  # type: ignore
     def __init__(self: array) -> None:
         """Initialize the attributes for the array object class."""
 
     @property
-    def dtype(self: array) -> Dtype:
+    def dtype(self: array) -> dtype_:
         """
         Data type of the array elements.
 
@@ -165,7 +165,7 @@ def dtype(self: array) -> Dtype:
         """
 
     @property
-    def device(self: array) -> Device:
+    def device(self: array) -> device_:
         """
         Hardware device the array data resides on.
 
@@ -1344,7 +1344,7 @@ def __xor__(self: array, other: Union[int, bool, array], /) -> array:
         """
 
     def to_device(
-        self: array, device: Device, /, *, stream: Optional[Union[int, Any]] = None
+        self: array, device: device_, /, *, stream: Optional[Union[int, Any]] = None
     ) -> array:
         """
         Copy the array from the device on which it currently resides to the specified ``device``.

src/array_api_stubs/_draft/data_types.py

@@ -1,22 +1,24 @@
-__all__ = ["__eq__"]
+from __future__ import annotations
 
+__all__ = ["DType"]
 
-from ._types import dtype
 
+from typing import Protocol
 
-def __eq__(self: dtype, other: dtype, /) -> bool:
-    """
-    Computes the truth value of ``self == other`` in order to test for data type object equality.
 
-    Parameters
-    ----------
-    self: dtype
-        data type instance. May be any supported data type.
-    other: dtype
-        other data type instance. May be any supported data type.
-
-    Returns
-    -------
-    out: bool
-        a boolean indicating whether the data type objects are equal.
-    """
+class DType(Protocol):
+    def __eq__(self, other: DType, /) -> bool:
+        """
+        Computes the truth value of ``self == other`` in order to test for data type object equality.
+        Parameters
+        ----------
+        self: dtype
+            data type instance. May be any supported data type.
+        other: dtype
+            other data type instance. May be any supported data type.
+        Returns
+        -------
+        out: bool
+            a boolean indicating whether the data type objects are equal.
+        """
+        ...