mirror of
https://github.com/xonsh/xonsh.git
synced 2025-03-04 16:34:47 +01:00
64efb3b3df
most of the rules are disabled since it will take longer to fix them all maybe in future version we can fix them one by one
99 lines
3.2 KiB
INI
99 lines
3.2 KiB
INI
# Use of pytest --flake8 is deprecated in favor of flake8 direct.
|
|
# Thus the developer's IDE can use the same lint config as CI.
|
|
# pytest-flake8 --ignore is an incompatible superset of flake8 --ignore, --per-file-ignores and --exclude
|
|
# and we don't want to maintain the same list in 2 formats.
|
|
[flake8]
|
|
max-line-length = 180
|
|
exclude =
|
|
__amalgam__.py,
|
|
tests/,
|
|
docs/,
|
|
*/vended_ptk/prompt_toolkit/,
|
|
*/vended_ptk/wcwidth/,
|
|
*/ply/,
|
|
parser*_table.py,
|
|
build/,
|
|
dist/,
|
|
setup.py,
|
|
.vscode/,
|
|
feedstock,
|
|
rever,
|
|
.venv*/,
|
|
# remove later
|
|
pygments_cache.py
|
|
# lint nits that are acceptable in Xonsh project:
|
|
ignore =
|
|
D100, # Missing docstring in public module
|
|
D101, # Missing docstring in public class
|
|
D102, # Missing docstring in public method
|
|
D103, # Missing docstring in public function
|
|
D104, # Missing docstring in public package
|
|
D105, # Missing docstring in magic method
|
|
D200, # One-line docstring should fit on one line with quotes
|
|
D202, # No blank lines allowed after function docstring
|
|
D205, # 1 blank line required between summary line and description
|
|
D207, # Docstring is under-indented
|
|
D208, # Docstring is over-indented
|
|
D209, # Multi-line docstring closing quotes should be on a separate line
|
|
D210, # No whitespaces allowed surrounding docstring text
|
|
D301, # Use r""" if any backslashes in a docstring
|
|
D400, # First line should end with a period
|
|
D401, # First line should be in imperative mood
|
|
D403, # First word of the first line should be properly capitalized
|
|
D404, # First word of the docstring should not be `This`
|
|
D406, # Section name should end with a newline
|
|
D409, # Section underline should match the length of its name
|
|
D411, # Missing blank line before section
|
|
D407, # Missing dashed underline after section
|
|
E122,
|
|
# E203 whitespace before ':'
|
|
E203,
|
|
E402,
|
|
# line break before binary operators is a good thing
|
|
W503,
|
|
# accept lambda assigned to a variable
|
|
E731,
|
|
# remove these later
|
|
# E741 - ambiguous variable name
|
|
E741,
|
|
# also acceptable in Xonsh project: reference to global names defined at runtime by black magic
|
|
builtins =
|
|
__xonsh__,
|
|
events,
|
|
aliases,
|
|
XonshError,
|
|
per-file-ignores =
|
|
# flake8 gives incorrect unused import errors, F401
|
|
tests/tools.py:E128,
|
|
xonsh/ast.py:F401,
|
|
xonsh/built_ins.py:F821 E721,
|
|
xonsh/built_ins.py:E721,
|
|
xonsh/commands_cache.py:F841,
|
|
xonsh/history.py:F821,
|
|
xonsh/jupyter_kernel.py:E203,
|
|
xonsh/platform.py:F401 E305,
|
|
xonsh/proc.py:E261 E265,
|
|
xonsh/ptk/key_bindings.py:F841,
|
|
xonsh/ptk/shell.py:E731,
|
|
xonsh/pyghooks.py:F821,
|
|
xonsh/readline_shell.py:F401,
|
|
xonsh/style_tools.py:F821 E305,
|
|
xonsh/timings.py:F401,
|
|
xonsh/tokenize.py:F821 F841,
|
|
xonsh/tools.py:E731 E305,
|
|
xonsh/xonfig.py:E731,
|
|
xontrib/vox.py:F821,
|
|
# remove these later
|
|
xonsh/color_tools.py:E305
|
|
xonsh/completers/_aliases.py:E305,
|
|
xonsh/completers/python.py:E722,
|
|
xonsh/inspectors.py:E722
|
|
xonsh/lexer.py:E741,
|
|
xonsh/parsers/context_check.py:E305,
|
|
xonsh/style_tools.py:E305,
|
|
xonsh/tools.py:E305,
|
|
xonsh/winutils.py:E305,
|
|
xonsh/xoreutils/*.py:E722 E305,
|
|
|
|
# pydocstyle plugin
|
|
docstring-convention=numpy
|