Overhaul test_all

Author: crusaderky

array_api_compat/common/_aliases.py

@@ -720,8 +720,6 @@ def iinfo(type_: DType | Array, /, xp: Namespace) -> Any:
     "finfo",
     "iinfo",
 ]
-_all_ignore = ["inspect", "array_namespace", "NamedTuple"]
-
 
 def __dir__() -> list[str]:
     return __all__

array_api_compat/common/_helpers.py

@@ -1042,7 +1042,5 @@ def is_lazy_array(x: object) -> bool:
     "to_device",
 ]
 
-_all_ignore = ["sys", "math", "inspect", "warnings"]
-
 def __dir__() -> list[str]:
     return __all__

array_api_compat/common/_linalg.py

@@ -225,8 +225,6 @@ def trace(
            'matrix_transpose', 'svdvals', 'vecdot', 'vector_norm', 'diagonal',
            'trace']
 
-_all_ignore = ['math', 'normalize_axis_tuple', 'get_xp', 'np', 'isdtype']
-
 
 def __dir__() -> list[str]:
     return __all__

array_api_compat/cupy/_aliases.py

@@ -160,5 +160,3 @@ def count_nonzero(
                               'atan2', 'atanh', 'bitwise_left_shift',
                               'bitwise_invert', 'bitwise_right_shift',
                               'bool', 'concat', 'count_nonzero', 'pow', 'sign']
-
-_all_ignore = ['cp', 'get_xp']

array_api_compat/cupy/_typing.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 __all__ = ["Array", "DType", "Device"]
-_all_ignore = ["cp"]
 
 from typing import TYPE_CHECKING
 

array_api_compat/dask/array/_aliases.py

@@ -369,8 +369,6 @@ def count_nonzero(
     "bitwise_left_shift", "bitwise_right_shift", "bitwise_invert",
 ]  # fmt: skip
 __all__ += _aliases.__all__
-_all_ignore = ["array_namespace", "get_xp", "da", "np"]
-
 
 def __dir__() -> list[str]:
     return __all__

array_api_compat/dask/array/fft.py

@@ -18,4 +18,6 @@
 rfftfreq = get_xp(da)(_fft.rfftfreq)
 
 __all__ = fft_all + ["fftfreq", "rfftfreq"]
-_all_ignore = ["da", "fft_all", "get_xp", "warnings"]
+
+def __dir__() -> list[str]:
+    return __all__

array_api_compat/dask/array/linalg.py

@@ -69,4 +69,5 @@ def svdvals(x: _Array) -> _Array:
                         "cholesky", "matrix_rank", "matrix_norm", "svdvals",
                         "vector_norm", "diagonal"]
 
-_all_ignore = ['get_xp', 'da', 'linalg_all', 'warnings']
+def __dir__() -> list[str]:
+    return __all__

array_api_compat/numpy/_aliases.py

@@ -157,7 +157,7 @@ def count_nonzero(
 else:
     unstack = get_xp(np)(_aliases.unstack)
 
-__all__ = [
+__all__ = _aliases.__all__ + [
     "__array_namespace_info__",
     "asarray",
     "astype",
@@ -176,8 +176,6 @@ def count_nonzero(
     "count_nonzero",
     "pow",
 ]
-__all__ += _aliases.__all__
-_all_ignore = ["np", "get_xp"]
 
 
 def __dir__() -> list[str]:

array_api_compat/numpy/_typing.py

@@ -23,7 +23,6 @@
     Array: TypeAlias = np.ndarray
 
 __all__ = ["Array", "DType", "Device"]
-_all_ignore = ["np"]
 
 
 def __dir__() -> list[str]:

array_api_compat/numpy/fft.py

@@ -1,5 +1,4 @@
 import numpy as np
-from numpy.fft import __all__ as fft_all
 from numpy.fft import fft2, ifft2, irfft2, rfft2
 
 from .._internal import get_xp
@@ -21,15 +20,7 @@
 ifftshift = get_xp(np)(_fft.ifftshift)
 
 
-__all__ = ["rfft2", "irfft2", "fft2", "ifft2"]
-__all__ += _fft.__all__
-
+__all__ = _fft.__all__ + ["rfft2", "irfft2", "fft2", "ifft2"]
 
 def __dir__() -> list[str]:
     return __all__
-
-
-del get_xp
-del np
-del fft_all
-del _fft

array_api_compat/numpy/linalg.py

@@ -120,7 +120,7 @@ def solve(x1: Array, x2: Array, /) -> Array:
     vector_norm = get_xp(np)(_linalg.vector_norm)
 
 
-__all__ = [
+__all__ = _linalg.__all__ + [
     "LinAlgError",
     "cond",
     "det",
@@ -132,12 +132,11 @@ def solve(x1: Array, x2: Array, /) -> Array:
     "matrix_power",
     "multi_dot",
     "norm",
+    "solve", 
     "tensorinv",
     "tensorsolve",
+    "vector_norm",
 ]
-__all__ += _linalg.__all__
-__all__ += ["solve", "vector_norm"]
-
 
 def __dir__() -> list[str]:
     return __all__

array_api_compat/torch/_aliases.py

@@ -841,5 +841,3 @@ def sign(x: Array, /) -> Array:
            'unique_all', 'unique_counts', 'unique_inverse', 'unique_values',
            'matmul', 'matrix_transpose', 'vecdot', 'tensordot', 'isdtype',
            'take', 'take_along_axis', 'sign', 'finfo', 'iinfo', 'repeat']
-
-_all_ignore = ['torch', 'get_xp']

array_api_compat/torch/fft.py

@@ -81,5 +81,3 @@ def ifftshift(
     "fftshift",
     "ifftshift",
 ]
-
-_all_ignore = ['torch']

array_api_compat/torch/linalg.py

@@ -113,9 +113,5 @@ def vector_norm(
 __all__ = linalg_all + ['outer', 'matmul', 'matrix_transpose', 'tensordot',
                         'cross', 'vecdot', 'solve', 'trace', 'vector_norm']
 
-_all_ignore = ['torch_linalg', 'sum']
-
-del linalg_all
-
 def __dir__() -> list[str]:
     return __all__

tests/test_all.py

@@ -1,63 +1,259 @@
-"""
-Test that files that define __all__ aren't missing any exports.
+"""Test exported names"""
 
-You can add names that shouldn't be exported to _all_ignore, like
+import builtins
 
-_all_ignore = ['sys']
+import numpy as np
+import pytest
 
-This is preferable to del-ing the names as this will break any name that is
-used inside of a function. Note that names starting with an underscore are automatically ignored.
-"""
+from ._helpers import wrapped_libraries
 
+NAMES = {
+    "": [
+        # Inspection
+        "__array_api_version__",
+        "__array_namespace_info__",
+        # Constants
+        "e",
+        "inf",
+        "nan",
+        "newaxis",
+        "pi",
+        # Creation functions
+        "arange",
+        "asarray",
+        "empty",
+        "empty_like",
+        "eye",
+        "from_dlpack",
+        "full",
+        "full_like",
+        "linspace",
+        "meshgrid",
+        "ones",
+        "ones_like",
+        "tril",
+        "triu",
+        "zeros",
+        "zeros_like",
+        # Data Type Functions
+        "astype",
+        "can_cast",
+        "finfo",
+        "iinfo",
+        "isdtype",
+        "result_type",
+        # Data Types
+        "bool",
+        "int8",
+        "int16",
+        "int32",
+        "int64",
+        "uint8",
+        "uint16",
+        "uint32",
+        "uint64",
+        "float32",
+        "float64",
+        "complex64",
+        "complex128",
+        # Elementwise Functions
+        "abs",
+        "acos",
+        "acosh",
+        "add",
+        "asin",
+        "asinh",
+        "atan",
+        "atan2",
+        "atanh",
+        "bitwise_and",
+        "bitwise_left_shift",
+        "bitwise_invert",
+        "bitwise_or",
+        "bitwise_right_shift",
+        "bitwise_xor",
+        "ceil",
+        "clip",
+        "conj",
+        "copysign",
+        "cos",
+        "cosh",
+        "divide",
+        "equal",
+        "exp",
+        "expm1",
+        "floor",
+        "floor_divide",
+        "greater",
+        "greater_equal",
+        "hypot",
+        "imag",
+        "isfinite",
+        "isinf",
+        "isnan",
+        "less",
+        "less_equal",
+        "log",
+        "log1p",
+        "log2",
+        "log10",
+        "logaddexp",
+        "logical_and",
+        "logical_not",
+        "logical_or",
+        "logical_xor",
+        "maximum",
+        "minimum",
+        "multiply",
+        "negative",
+        "nextafter",
+        "not_equal",
+        "positive",
+        "pow",
+        "real",
+        "reciprocal",
+        "remainder",
+        "round",
+        "sign",
+        "signbit",
+        "sin",
+        "sinh",
+        "square",
+        "sqrt",
+        "subtract",
+        "tan",
+        "tanh",
+        "trunc",
+        # Indexing Functions
+        "take",
+        "take_along_axis",
+        # Linear Algebra Functions
+        "matmul",
+        "matrix_transpose",
+        "tensordot",
+        "vecdot",
+        # Manipulation Functions
+        "broadcast_arrays",
+        "broadcast_to",
+        "concat",
+        "expand_dims",
+        "flip",
+        "moveaxis",
+        "permute_dims",
+        "repeat",
+        "reshape",
+        "roll",
+        "squeeze",
+        "stack",
+        "tile",
+        "unstack",
+        # Searching Functions
+        "argmax",
+        "argmin",
+        "count_nonzero",
+        "nonzero",
+        "searchsorted",
+        "where",
+        # Set functions
+        "unique_all",
+        "unique_counts",
+        "unique_inverse",
+        "unique_values",
+        # Sorting Functions
+        "argsort",
+        "sort",
+        # Statistical Functions
+        "cumulative_prod",
+        "cumulative_sum",
+        "max",
+        "mean",
+        "min",
+        "prod",
+        "std",
+        "sum",
+        "var",
+        # Utility Functions
+        "all",
+        "any",
+        "diff",
+    ],
+    "fft": [
+        "fft",
+        "ifft",
+        "fftn",
+        "ifftn",
+        "rfft",
+        "irfft",
+        "rfftn",
+        "irfftn",
+        "hfft",
+        "ihfft",
+        "fftfreq",
+        "rfftfreq",
+        "fftshift",
+        "ifftshift",
+    ],
+    "linalg": [
+        "cholesky",
+        "cross",
+        "det",
+        "diagonal",
+        "eigh",
+        "eigvalsh",
+        "inv",
+        "matmul",
+        "matrix_norm",
+        "matrix_power",
+        "matrix_rank",
+        "matrix_transpose",
+        "outer",
+        "pinv",
+        "qr",
+        "slogdet",
+        "solve",
+        "svd",
+        "svdvals",
+        "tensordot",
+        "trace",
+        "vecdot",
+        "vector_norm",
+    ],
+}
 
-import sys
+XFAILS = {
+    ("numpy", ""): ["from_dlpack"] if np.__version__ < "1.23" else [],
+    ("dask.array", ""): ["from_dlpack", "take_along_axis"],
+    ("dask.array", "linalg"): [
+        "cross",
+        "det",
+        "eigh",
+        "eigvalsh",
+        "matrix_power",
+        "pinv",
+        "slogdet",
+    ],
+}
 
-from ._helpers import import_, wrapped_libraries
 
-import pytest
-import typing
-
-TYPING_NAMES = frozenset((
-    "Array",
-    "Device",
-    "DType",
-    "Namespace",
-    "NestedSequence",
-    "SupportsBufferProtocol",
-))
-
-@pytest.mark.parametrize("library", ["common"] + wrapped_libraries)
-def test_all(library):
-    if library == "common":
-        import array_api_compat.common  # noqa: F401
-    else:
-        import_(library, wrapper=True)
-
-    # NB: iterate over a copy to avoid a "dictionary size changed" error
-    for mod_name in sys.modules.copy():
-        if not mod_name.startswith('array_api_compat.' + library):
-            continue
-
-        module = sys.modules[mod_name]
-
-        # TODO: We should define __all__ in the __init__.py files and test it
-        # there too.
-        if not hasattr(module, '__all__'):
-            continue
-
-        dir_names = [n for n in dir(module) if not n.startswith('_')]
-        if '__array_namespace_info__' in dir(module):
-            dir_names.append('__array_namespace_info__')
-        ignore_all_names = set(getattr(module, '_all_ignore', ()))
-        ignore_all_names |= set(dir(typing))
-        ignore_all_names |= {"annotations"}
-        if not module.__name__.endswith("._typing"):
-            ignore_all_names |= TYPING_NAMES
-        dir_names = set(dir_names) - set(ignore_all_names)
-        all_names = module.__all__
-
-        if set(dir_names) != set(all_names):
-            extra_dir = set(dir_names) - set(all_names)
-            extra_all = set(all_names) - set(dir_names)
-            assert not extra_dir, f"Some dir() names not included in __all__ for {mod_name}: {extra_dir}"
-            assert not extra_all, f"Some __all__ names not in dir() for {mod_name}: {extra_all}"
+@pytest.mark.parametrize("module", list(NAMES))
+@pytest.mark.parametrize("library", wrapped_libraries)
+def test_dir(library, module):
+    """Test that dir() isn't missing any exports."""
+    xp = pytest.importorskip(f"array_api_compat.{library}")
+    mod = getattr(xp, module) if module else xp
+    missing = set(NAMES[module]) - set(dir(mod))
+    xfail = set(XFAILS.get((library, module), []))
+    xpass = xfail - missing
+    fails = missing - xfail
+    assert not xpass, "Names in XFAILS are defined: %s" % xpass
+    assert not fails, "Missing exports: %s" % fails
+
+
+@pytest.mark.parametrize(
+    "name", [name for name in NAMES[""] if hasattr(builtins, name)]
+)
+@pytest.mark.parametrize("library", wrapped_libraries)
+def test_builtins_collision(library, name):
+    """Test that xp.bool is not accidentally builtins.bool, etc."""
+    xp = pytest.importorskip(f"array_api_compat.{library}")
+    assert getattr(xp, name) is not getattr(builtins, name)