lint: Use standard setup.cfg configuration for pycodestyle.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
This commit is contained in:
Anders Kaseorg 2020-07-13 16:43:53 -07:00 committed by Tim Abbott
parent 79b1bf56ab
commit ab647abad3
3 changed files with 76 additions and 76 deletions

71
setup.cfg Normal file
View File

@ -0,0 +1,71 @@
[pycodestyle]
ignore =
# Each of these rules are ignored for the explained reason.
# "multiple spaces before operator"
# There are several typos here, but also several instances that are
# being used for alignment in dict keys/values using the `dict`
# constructor. We could fix the alignment cases by switching to the `{}`
# constructor, but it makes fixing this rule a little less
# straightforward.
E221,
# 'missing whitespace around arithmetic operator'
# This should possibly be cleaned up, though changing some of
# these may make the code less readable.
E226,
# New rules in pycodestyle 2.4.0 that we haven't decided whether to comply with yet
E252, W504,
# "multiple spaces after ':'"
# This is the `{}` analogue of E221, and these are similarly being used
# for alignment.
E241,
# "unexpected spaces around keyword / parameter equals"
# Many of these should be fixed, but many are also being used for
# alignment/making the code easier to read.
E251,
# "block comment should start with '#'"
# These serve to show which lines should be changed in files customized
# by the user. We could probably resolve one of E265 or E266 by
# standardizing on a single style for lines that the user might want to
# change.
E265,
# "too many leading '#' for block comment"
# Most of these are there for valid reasons.
E266,
# "expected 2 blank lines after class or function definition"
# Zulip only uses 1 blank line after class/function
# definitions; the PEP-8 recommendation results in super sparse code.
E302, E305,
# "module level import not at top of file"
# Most of these are there for valid reasons, though there might be a
# few that could be eliminated.
E402,
# "line too long"
# Zulip is a bit less strict about line length, and has its
# own check for this (see max_length)
E501,
# "do not assign a lambda expression, use a def"
# Fixing these would probably reduce readability in most cases.
E731,
# "line break before binary operator"
# This is a bug in the `pep8`/`pycodestyle` tool -- it's completely backward.
# See https://github.com/PyCQA/pycodestyle/issues/498 .
W503,
# This number will probably be used for the corrected, inverse version of
# W503 when that's added: https://github.com/PyCQA/pycodestyle/pull/502
# Once that fix lands and we update to a version of pycodestyle that has it,
# we'll want the rule; but we might have to briefly ignore it while we fix
# existing code.
# W504,

View File

@ -136,13 +136,13 @@ def run() -> None:
@linter_config.lint @linter_config.lint
def pep8_1of2() -> int: def pep8_1of2() -> int:
"""Standard Python style linter on 50% of files (config: tools/linter_lib/pep8.py)""" """Standard Python style linter on 50% of files (config: setup.cfg)"""
failed = check_pep8(list(python_part1)) failed = check_pep8(list(python_part1))
return 1 if failed else 0 return 1 if failed else 0
@linter_config.lint @linter_config.lint
def pep8_2of2() -> int: def pep8_2of2() -> int:
"""Standard Python style linter on other 50% of files (config: tools/linter_lib/pep8.py)""" """Standard Python style linter on other 50% of files (config: setup.cfg)"""
failed = check_pep8(list(python_part2)) failed = check_pep8(list(python_part2))
return 1 if failed else 0 return 1 if failed else 0

View File

@ -1,79 +1,8 @@
from typing import List from typing import List
from zulint.linters import run_pycodestyle from zulint.linters import run_command
from zulint.printer import colors
def check_pep8(files: List[str]) -> bool: def check_pep8(files: List[str]) -> bool:
ignored_rules = [ return run_command("pep8", next(colors), ["pycodestyle", "--", *files]) != 0
# Each of these rules are ignored for the explained reason.
# "multiple spaces before operator"
# There are several typos here, but also several instances that are
# being used for alignment in dict keys/values using the `dict`
# constructor. We could fix the alignment cases by switching to the `{}`
# constructor, but it makes fixing this rule a little less
# straightforward.
'E221',
# 'missing whitespace around arithmetic operator'
# This should possibly be cleaned up, though changing some of
# these may make the code less readable.
'E226',
# New rules in pycodestyle 2.4.0 that we haven't decided whether to comply with yet
'E252', 'W504',
# "multiple spaces after ':'"
# This is the `{}` analogue of E221, and these are similarly being used
# for alignment.
'E241',
# "unexpected spaces around keyword / parameter equals"
# Many of these should be fixed, but many are also being used for
# alignment/making the code easier to read.
'E251',
# "block comment should start with '#'"
# These serve to show which lines should be changed in files customized
# by the user. We could probably resolve one of E265 or E266 by
# standardizing on a single style for lines that the user might want to
# change.
'E265',
# "too many leading '#' for block comment"
# Most of these are there for valid reasons.
'E266',
# "expected 2 blank lines after class or function definition"
# Zulip only uses 1 blank line after class/function
# definitions; the PEP-8 recommendation results in super sparse code.
'E302', 'E305',
# "module level import not at top of file"
# Most of these are there for valid reasons, though there might be a
# few that could be eliminated.
'E402',
# "line too long"
# Zulip is a bit less strict about line length, and has its
# own check for this (see max_length)
'E501',
# "do not assign a lambda expression, use a def"
# Fixing these would probably reduce readability in most cases.
'E731',
# "line break before binary operator"
# This is a bug in the `pep8`/`pycodestyle` tool -- it's completely backward.
# See https://github.com/PyCQA/pycodestyle/issues/498 .
'W503',
# This number will probably be used for the corrected, inverse version of
# W503 when that's added: https://github.com/PyCQA/pycodestyle/pull/502
# Once that fix lands and we update to a version of pycodestyle that has it,
# we'll want the rule; but we might have to briefly ignore it while we fix
# existing code.
# 'W504',
]
return run_pycodestyle(files, ignored_rules)