-
Notifications
You must be signed in to change notification settings - Fork 66
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Replace pylint with flake8 plugins #284
Comments
Maybe this one as well: https://github.com/PyCQA/flake8-bugbear |
After the 2021-11-19 Development Call we decided not to include any flake8 extension that isn't available through conda. |
We've been using
pylint
for a long time to help us improve the quality of our code.Nevertheless, it's not new that meeting all its requirements is a very demanding task: some of its complains are very useful (unused imports, unused variables, too long functions, etc), but there are a lot more that we usually decide to ignore. The amount of ignored complains is not small: I think we need to add
pylint: disable=...
comments on every PR we open. See #283 as a recent example.So it might be better to go with a better alternative: one that is faster to run, less strict and that allows us to control which types of check we want to run and which don't.
A good alternative would be to use
flake8
extensions that take care of specific checks.I'll leave a list of possible candidates, so feel free to add any extensions you think useful:
Discarded:
darglint: checks whether a docstring's description matches the actual function/method implementationflake8-tidy-imports: write tidier imports.flake8-isort: Useisort
to check if the imports on your python files are sorted the way you expect.isort
, but we don't need to list all its complains, we just want it to solve them)flake8-black: Runblack --check
from withinflake8
ecosystem.flake8-isort
)flake8-functions-names: provide better naming for functions.flake8-requirements: checks/validates package import requirements. It reports missing and/or not used project direct dependencies.flake8-eradicate: find commented out (or so called "dead") code.flake8-unused-argumentsThe awesome-flake8-extensions is a good place for looking for
flake8
extensions.The text was updated successfully, but these errors were encountered: