diff options
Diffstat (limited to 'lib/spack/spack/cmd/flake8.py')
| -rw-r--r-- | lib/spack/spack/cmd/flake8.py | 198 |
1 files changed, 10 insertions, 188 deletions
diff --git a/lib/spack/spack/cmd/flake8.py b/lib/spack/spack/cmd/flake8.py index ce6dbfed20..5d2d97143e 100644 --- a/lib/spack/spack/cmd/flake8.py +++ b/lib/spack/spack/cmd/flake8.py @@ -5,200 +5,22 @@ from __future__ import print_function -try: - from itertools import zip_longest # novm -except ImportError: - from itertools import izip_longest # novm +import llnl.util.tty as tty - zip_longest = izip_longest +import spack.cmd.style -import re -import os -import sys -import argparse -from llnl.util.filesystem import working_dir - -import spack.paths -from spack.util.executable import which - - -description = "runs source code style checks on Spack. requires flake8" -section = "developer" -level = "long" - - -def grouper(iterable, n, fillvalue=None): - "Collect data into fixed-length chunks or blocks" - # grouper('ABCDEFG', 3, 'x') --> ABC DEF Gxx" - args = [iter(iterable)] * n - return zip_longest(*args, fillvalue=fillvalue) - - -def is_package(f): - """Whether flake8 should consider a file as a core file or a package. - - We run flake8 with different exceptions for the core and for - packages, since we allow `from spack import *` and poking globals - into packages. - """ - return f.startswith("var/spack/repos/") or "docs/tutorial/examples" in f - - -#: List of directories to exclude from checks. -exclude_directories = [spack.paths.external_path] - -#: max line length we're enforcing (note: this duplicates what's in .flake8) -max_line_length = 79 - - -def changed_files(base=None, untracked=True, all_files=False): - """Get list of changed files in the Spack repository.""" - - git = which("git", required=True) - - if base is None: - base = os.environ.get("TRAVIS_BRANCH", "develop") - - range = "{0}...".format(base) - - git_args = [ - # Add changed files committed since branching off of develop - ["diff", "--name-only", "--diff-filter=ACMR", range], - # Add changed files that have been staged but not yet committed - ["diff", "--name-only", "--diff-filter=ACMR", "--cached"], - # Add changed files that are unstaged - ["diff", "--name-only", "--diff-filter=ACMR"], - ] - - # Add new files that are untracked - if untracked: - git_args.append(["ls-files", "--exclude-standard", "--other"]) - - # add everything if the user asked for it - if all_files: - git_args.append(["ls-files", "--exclude-standard"]) - - excludes = [os.path.realpath(f) for f in exclude_directories] - changed = set() - - for arg_list in git_args: - files = git(*arg_list, output=str).split("\n") - - for f in files: - # Ignore non-Python files - if not (f.endswith(".py") or f == "bin/spack"): - continue - - # Ignore files in the exclude locations - if any(os.path.realpath(f).startswith(e) for e in excludes): - continue - - changed.add(f) - - return sorted(changed) +description = "alias for spack style (deprecated)" +section = spack.cmd.style.section +level = spack.cmd.style.level def setup_parser(subparser): - subparser.add_argument( - "-b", - "--base", - action="store", - default=None, - help="select base branch for collecting list of modified files", - ) - subparser.add_argument( - "-a", - "--all", - action="store_true", - help="check all files, not just changed files", - ) - subparser.add_argument( - "-o", - "--output", - action="store_true", - help="send filtered files to stdout as well as temp files", - ) - subparser.add_argument( - "-r", - "--root-relative", - action="store_true", - default=False, - help="print root-relative paths (default: cwd-relative)", - ) - subparser.add_argument( - "-U", - "--no-untracked", - dest="untracked", - action="store_false", - default=True, - help="exclude untracked files from checks", - ) - subparser.add_argument( - "files", nargs=argparse.REMAINDER, help="specific files to check" - ) + spack.cmd.style.setup_parser(subparser) def flake8(parser, args): - file_list = args.files - if file_list: - - def prefix_relative(path): - return os.path.relpath( - os.path.abspath(os.path.realpath(path)), spack.paths.prefix - ) - - file_list = [prefix_relative(p) for p in file_list] - - returncode = 0 - with working_dir(spack.paths.prefix): - if not file_list: - file_list = changed_files(args.base, args.untracked, args.all) - - print("=======================================================") - print("flake8: running flake8 code checks on spack.") - print() - print("Modified files:") - for filename in file_list: - print(" {0}".format(filename.strip())) - print("=======================================================") - - output = "" - # run in chunks of 100 at a time to avoid line length limit - # filename parameter in config *does not work* for this reliably - for chunk in grouper(file_list, 100): - flake8_cmd = which("flake8", required=True) - chunk = filter(lambda e: e is not None, chunk) - - output = flake8_cmd( - # use .flake8 implicitly to work around bug in flake8 upstream - # append-config is ignored if `--config` is explicitly listed - # see: https://gitlab.com/pycqa/flake8/-/issues/455 - # "--config=.flake8", - *chunk, - fail_on_error=False, - output=str - ) - returncode |= flake8_cmd.returncode - - if args.root_relative: - # print results relative to repo root. - print(output) - else: - # print results relative to current working directory - def cwd_relative(path): - return "{0}: [".format( - os.path.relpath( - os.path.join(spack.paths.prefix, path.group(1)), - os.getcwd(), - ) - ) - - for line in output.split("\n"): - print(re.sub(r"^(.*): \[", cwd_relative, line)) - - if returncode != 0: - print("Flake8 found errors.") - sys.exit(1) - else: - print("Flake8 checks were clean.") + tty.warn( + "spack flake8 is deprecated", "please use `spack style` to run style checks" + ) + return spack.cmd.style.style(parser, args) |