Undefined type annotations in _helpers.py

[adonath]

My VScode with ruff extension showed that the Device and Array annotations in common/_helpers.py are undefined:

And from a quick look I think this is true. Maybe adopt ruff as a default linter / .pre-commit hook?

[adonath]

Here is a full list of further issues marked by ruff:

array_api_compat/__init__.py:22:1: F403 `from .common import *` used; unable to detect undefined names
array_api_compat/common/__init__.py:1:1: F403 `from ._helpers import *` used; unable to detect undefined names
array_api_compat/common/_aliases.py:9:58: F401 [*] `typing.List` imported but unused
array_api_compat/common/_aliases.py:283:33: F821 Undefined name `np`
array_api_compat/common/_helpers.py:147:16: F821 Undefined name `Array`
array_api_compat/common/_helpers.py:147:31: F821 Undefined name `Device`
array_api_compat/common/_helpers.py:213:9: F821 Undefined name `Array`
array_api_compat/common/_helpers.py:213:26: F821 Undefined name `Device`
array_api_compat/common/_helpers.py:213:50: F821 Undefined name `Optional`
array_api_compat/common/_helpers.py:213:59: F821 Undefined name `Union`
array_api_compat/common/_helpers.py:213:70: F821 Undefined name `Any`
array_api_compat/common/_helpers.py:214:7: F821 Undefined name `Array`
array_api_compat/common/_linalg.py:5:43: F401 [*] `typing.Sequence` imported but unused
array_api_compat/cupy/__init__.py:1:1: F403 `from cupy import *` used; unable to detect undefined names
array_api_compat/cupy/__init__.py:4:18: F401 [*] `cupy.abs` imported but unused
array_api_compat/cupy/__init__.py:4:23: F401 [*] `cupy.max` imported but unused
array_api_compat/cupy/__init__.py:4:28: F401 [*] `cupy.min` imported but unused
array_api_compat/cupy/__init__.py:4:33: F401 [*] `cupy.round` imported but unused
array_api_compat/cupy/__init__.py:7:1: F403 `from ._aliases import *` used; unable to detect undefined names
array_api_compat/cupy/__init__.py:12:1: E402 Module level import not at top of file
array_api_compat/cupy/__init__.py:12:21: F401 [*] `.linalg.matrix_transpose` imported but unused
array_api_compat/cupy/__init__.py:12:39: F401 [*] `.linalg.vecdot` imported but unused
array_api_compat/cupy/__init__.py:14:1: E402 Module level import not at top of file
array_api_compat/cupy/__init__.py:14:1: F403 `from ..common._helpers import *` used; unable to detect undefined names
array_api_compat/cupy/_aliases.py:13:1: E402 Module level import not at top of file
array_api_compat/cupy/linalg.py:1:1: F403 `from cupy.linalg import *` used; unable to detect undefined names
array_api_compat/cupy/linalg.py:11:1: E402 Module level import not at top of file
array_api_compat/cupy/linalg.py:12:1: E402 Module level import not at top of file
array_api_compat/cupy/linalg.py:13:1: E402 Module level import not at top of file
array_api_compat/cupy/linalg.py:13:24: F401 [*] `._aliases.matmul` imported but unused
array_api_compat/cupy/linalg.py:13:32: F401 [*] `._aliases.matrix_transpose` imported but unused
array_api_compat/cupy/linalg.py:13:50: F401 [*] `._aliases.tensordot` imported but unused
array_api_compat/cupy/linalg.py:13:61: F401 [*] `._aliases.vecdot` imported but unused
array_api_compat/cupy/linalg.py:15:1: E402 Module level import not at top of file
array_api_compat/numpy/__init__.py:1:1: F403 `from numpy import *` used; unable to detect undefined names
array_api_compat/numpy/__init__.py:4:19: F401 [*] `numpy.abs` imported but unused
array_api_compat/numpy/__init__.py:4:24: F401 [*] `numpy.max` imported but unused
array_api_compat/numpy/__init__.py:4:29: F401 [*] `numpy.min` imported but unused
array_api_compat/numpy/__init__.py:4:34: F401 [*] `numpy.round` imported but unused
array_api_compat/numpy/__init__.py:7:1: F403 `from ._aliases import *` used; unable to detect undefined names
array_api_compat/numpy/__init__.py:18:1: E402 Module level import not at top of file
array_api_compat/numpy/__init__.py:18:21: F401 [*] `.linalg.matrix_transpose` imported but unused
array_api_compat/numpy/__init__.py:18:39: F401 [*] `.linalg.vecdot` imported but unused
array_api_compat/numpy/__init__.py:20:1: E402 Module level import not at top of file
array_api_compat/numpy/__init__.py:20:1: F403 `from ..common._helpers import *` used; unable to detect undefined names
array_api_compat/numpy/_aliases.py:13:1: E402 Module level import not at top of file
array_api_compat/numpy/linalg.py:1:1: F403 `from numpy.linalg import *` used; unable to detect undefined names
array_api_compat/numpy/linalg.py:6:24: F401 [*] `._aliases.matmul` imported but unused
array_api_compat/numpy/linalg.py:6:32: F401 [*] `._aliases.matrix_transpose` imported but unused
array_api_compat/numpy/linalg.py:6:50: F401 [*] `._aliases.tensordot` imported but unused
array_api_compat/numpy/linalg.py:6:61: F401 [*] `._aliases.vecdot` imported but unused
array_api_compat/torch/__init__.py:1:1: F403 `from torch import *` used; unable to detect undefined names
array_api_compat/torch/__init__.py:15:1: E402 Module level import not at top of file
array_api_compat/torch/__init__.py:15:1: F403 `from ._aliases import *` used; unable to detect undefined names
array_api_compat/torch/__init__.py:20:1: E402 Module level import not at top of file
array_api_compat/torch/__init__.py:20:1: F403 `from ..common._helpers import *` used; unable to detect undefined names
array_api_compat/torch/linalg.py:8:1: F403 `from torch.linalg import *` used; unable to detect undefined names
array_api_compat/torch/linalg.py:16:1: E402 Module level import not at top of file
array_api_compat/torch/linalg.py:17:1: E402 Module level import not at top of file

[adonath]

I'd be happy to open a PR for this. I could either:

• Define a CI that runs ruff as a check
• Add a pre-commit hook running ruff
• Something else?

[asmeurer]

All the "imported but unused" and "import *" warnings are intentional, because we are manually exporting/rexporting names to the compat namespaces. We can add some linting, but we will need a lot of ignores, maybe even ignoring those checks entirely, at least for certain files.

The typing things should be fixed. I haven't checked if the typing stuff here works at all, so there's probably a lot more work that should be done there. The types in the signatures are copied from the spec, but I don't know if the aliases like "Device" actually work or not. No one has complained about it yet, though, so either it's fine or people are just ignoring the types for this library.

At any rate, feel free to open a PR and we can discuss this more.

[adonath]

Resolved via #82.

[NeilGirdhar]

@asmeurer If you instead add your imported names to __all__, you won't get the linter errors.