Replace pylint for flake8 extensions #285
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Replace pylint for flake8 extensions on environment.yml and env/requirements-style.txt.
In numerical computations we usually use single variable names, and flake8-variables-names complains a lot about them (VNE001) so it would be better to ignore it. The VNE003 complains if we are using builtins as variable names, but this is already covered by flake8-builtins. The VNE002 doesn't introduce significant importance to our projects, in fact we might use some of the words they complain about with good reason.
Its complains are too opinionated. For example it complains when defining a dictionary with dict(x=x, y=y). Sometimes we like it better for readability. The same goes for list() and tuple().
Install this extension through pip on the environment.yml because it's not available through conda yet.
6 tasks
leouieda
added a commit
to fatiando/verde
that referenced
this pull request
Dec 14, 2021
Following fatiando/harmonica#285, replace pylint with a bunch of new flake8 plugins. They cover most of the checks that were performed before, add a few new ones, and are less troublesome to maintain and silence when necessary. Fixes the formatting issues raised after applying the changes: making tutorials/examples fit 79 char comments/docstrings, silence a few issues because of scikit-learn style code, reorder imports because of isort. I also combined the CI checks into only 2: "format" and "style". If formatting is broken, we don't need to know which one is complaining, just run make format. And style is now only flake8 anyway.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ditch
pylintfrom requirements, remove it configuration file and remove any# pylint: disablecomment on source files. Add a fewflake8extensions tosubstitute the good features of
pylint. Addisortas dependency and run iton the
make formattarget. Runisortso the imports statements arecorrectly set. Make some small refactors to tackle some complains on the new
flake8extensions.Fixes #284
Reminders:
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rstand the base__init__.pyfile for the package.AUTHORS.mdfile (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.