zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

flake8: only add E501 exemptions when absolutely necessary (#12755)

Browse Source 
E501 (line too long) exemptions are probably our most common ones -- we
add them for directives, URLs, hashes, etc. in packages.  But we
currently add them even when a line *doesn't* need them, which can mask
trailing whitespace errors.

This changes `spack flake8` so that it will only add E501 exemptions if
the line is *actually* too long.

Co-Authored-By: Adam J. Stewart <ajstewart426@gmail.com>
This commit is contained in:
Todd Gamblin 2019-09-07 23:58:12 -07:00 committed by GitHub
parent 48c3c833e8
commit 0ec80e8f16
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lib/spack/spack/cmd/flake8.py
View File

@ -36,6 +36,8 @@ def is_package(f):
#: List of directories to exclude from checks. #: List of directories to exclude from checks.
exclude_directories = [spack.paths.external_path] exclude_directories = [spack.paths.external_path]
#: max line length we're enforcing (note: this duplicates what's in .flake8)
max_line_length = 79
#: This is a dict that maps: #: This is a dict that maps:
#: filename pattern -> #: filename pattern ->
@ -151,7 +153,16 @@ def add_pattern_exemptions(line, codes):
return line + '\n' return line + '\n'
orig_len = len(line) orig_len = len(line)
exemptions = ','.join(sorted(set(codes))) codes = set(codes)
# don't add E501 unless the line is actually too long, as it can mask
# other errors like trailing whitespace
if orig_len <= max_line_length and "E501" in codes:
codes.remove("E501")
if not codes:
return line + "\n"
exemptions = ','.join(sorted(codes))
# append exemption to line # append exemption to line
if '# noqa: ' in line: if '# noqa: ' in line:
@ -160,7 +171,7 @@ def add_pattern_exemptions(line, codes):
line += ' # noqa: {0}'.format(exemptions) line += ' # noqa: {0}'.format(exemptions)
# if THIS made the line too long, add an exemption for that # if THIS made the line too long, add an exemption for that
if len(line) > 79 and orig_len <= 79: if len(line) > max_line_length and orig_len <= max_line_length:
line += ',E501' line += ',E501'
return line + '\n' return line + '\n'