summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorTom Scogland <scogland1@llnl.gov>2020-12-22 21:39:10 -0800
committerGitHub <noreply@github.com>2020-12-22 21:39:10 -0800
commit857749a9ba3619f8190cc8b817d66125cf846c94 (patch)
tree611e8e073fd715daba8b177dff61c3527cad74c5 /.github
parenta93f6ca619954e228767dc15e4b6bfd017845c0e (diff)
downloadspack-857749a9ba3619f8190cc8b817d66125cf846c94.tar.gz
spack-857749a9ba3619f8190cc8b817d66125cf846c94.tar.bz2
spack-857749a9ba3619f8190cc8b817d66125cf846c94.tar.xz
spack-857749a9ba3619f8190cc8b817d66125cf846c94.zip
add mypy to style checks; rename `spack flake8` to `spack style` (#20384)
I lost my mind a bit after getting the completion stuff working and decided to get Mypy working for spack as well. This adds a `.mypy.ini` that checks all of the spack and llnl modules, though not yet packages, and fixes all of the identified missing types and type issues for the spack library. In addition to these changes, this includes: * rename `spack flake8` to `spack style` Aliases flake8 to style, and just runs flake8 as before, but with a warning. The style command runs both `flake8` and `mypy`, in sequence. Added --no-<tool> options to turn off one or the other, they are on by default. Fixed two issues caught by the tools. * stub typing module for python2.x We don't support typing in Spack for python 2.x. To allow 2.x to support `import typing` and `from typing import ...` without a try/except dance to support old versions, this adds a stub module *just* for python 2.x. Doing it this way means we can only reliably use all type hints in python3.7+, and mypi.ini has been updated to reflect that. * add non-default black check to spack style This is a first step to requiring black. It doesn't enforce it by default, but it will check it if requested. Currently enforcing the line length of 79 since that's what flake8 requires, but it's a bit odd for a black formatted project to be quite that narrow. All settings are in the style command since spack has no pyproject.toml and I don't want to add one until more discussion happens. Also re-format `style.py` since it no longer passed the black style check with the new length. * use style check in github action Update the style and docs action to use `spack style`, adding in mypy and black to the action even if it isn't running black right now.
Diffstat (limited to '.github')
-rw-r--r--.github/workflows/macos_unit_tests.yaml2
-rw-r--r--.github/workflows/style_and_docs.yaml12
2 files changed, 7 insertions, 7 deletions
diff --git a/.github/workflows/macos_unit_tests.yaml b/.github/workflows/macos_unit_tests.yaml
index 29caaa2e08..e5918968d2 100644
--- a/.github/workflows/macos_unit_tests.yaml
+++ b/.github/workflows/macos_unit_tests.yaml
@@ -26,7 +26,7 @@ jobs:
run: |
pip install --upgrade pip six setuptools
pip install --upgrade codecov coverage
- pip install --upgrade flake8 pep8-naming
+ pip install --upgrade flake8 pep8-naming mypy
- name: Setup Homebrew packages
run: |
brew install dash fish gcc gnupg2 kcov
diff --git a/.github/workflows/style_and_docs.yaml b/.github/workflows/style_and_docs.yaml
index 5abedab784..5a940da99e 100644
--- a/.github/workflows/style_and_docs.yaml
+++ b/.github/workflows/style_and_docs.yaml
@@ -22,10 +22,10 @@ jobs:
pip install --upgrade pip
pip install --upgrade vermin
- name: Minimum Version (Spack's Core)
- run: vermin --backport argparse -t=2.6- -t=3.5- -v lib/spack/spack/ lib/spack/llnl/ bin/
+ run: vermin --backport argparse --backport typing -t=2.6- -t=3.5- -v lib/spack/spack/ lib/spack/llnl/ bin/
- name: Minimum Version (Repositories)
- run: vermin --backport argparse -t=2.6- -t=3.5- -v var/spack/repos
- flake8:
+ run: vermin --backport argparse --backport typing -t=2.6- -t=3.5- -v var/spack/repos
+ style:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
@@ -36,15 +36,15 @@ jobs:
python-version: 3.9
- name: Install Python packages
run: |
- pip install --upgrade pip six setuptools flake8
+ pip install --upgrade pip six setuptools flake8 mypy black
- name: Setup git configuration
run: |
# Need this for the git tests to succeed.
git --version
. .github/workflows/setup_git.sh
- - name: Run flake8 tests
+ - name: Run style tests
run: |
- share/spack/qa/run-flake8-tests
+ share/spack/qa/run-style-tests
documentation:
runs-on: ubuntu-latest
steps: