hlrs-software-stack/spack
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

style: fix spurious mypy errors from numpy (#34732)

Browse source 
Spack imports `pytest`, which *can* import `numpy`. Recent versions of `numpy` require
Python 3.8 or higher, and they use 3.8 type annotations in their type stubs (`.pyi`
files). At the same time, we tell `mypy` to target Python 3.7, as we still support older
versions of Python.

What all this means is that if you run `mypy` on `spack`, `mypy` will follow all the
static import statements, and it ends up giving you this error when it finds numpy stuff
that is newer than the target Python version:

```
==> Running mypy checks
src/spack/var/spack/environments/default/.spack-env/._view/4g7jd4ibkg4gopv4rosq3kn2vsxrxm2f/lib/python3.11/site-packages/numpy/__init__.pyi:638: error: Positional-only parameters are only supported in Python 3.8 and greater  [syntax]
Found 1 error in 1 file (errors prevented further checking)
  mypy found errors
```

We can fix this by telling `mypy` to skip all imports of `numpy` in `pyproject.toml`:

```toml
   [[tool.mypy.overrides]]
   module = 'numpy'
   follow_imports = 'skip'
   follow_imports_for_stubs = true
```

- [x] don't follow imports from `numpy` in `mypy`
- [x] get rid of old rule not to follow `jinja2` imports, as we now require Python 3
This commit is contained in:
Todd Gamblin 2022-12-31 17:05:17 -08:00 committed by GitHub
parent 7a92579480
commit ca265ea0c2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
pyproject.toml
View file

@ -141,11 +141,14 @@ ignore_missing_imports = true
ignore_errors = true ignore_errors = true
ignore_missing_imports = true ignore_missing_imports = true
# jinja has syntax in it that requires python3 and causes a parse error # pytest (which we depend on) optionally imports numpy, which requires Python 3.8 in
# skip importing it # recent versions. mypy still imports its .pyi file, which has positional-only
# arguments, which don't work in 3.7, which causes mypy to bail out early if you have
# numpy installed.
[[tool.mypy.overrides]] [[tool.mypy.overrides]]
module = 'jinja2' module = 'numpy'
follow_imports = 'skip' follow_imports = 'skip'
follow_imports_for_stubs = true
[tool.pyright] [tool.pyright]
useLibraryCodeForTypes = true useLibraryCodeForTypes = true