Add Python linting and reformatting #26
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
I chose the same `pyproject.toml` configuration as the `sherlockml` library, for consistency.
Black and Flake8 diverge on what PEP 8 compliance means. This is detailed in the Black readme: https://github.com/ambv/black To allow the two to work together, we have to silence some Flake8 errors.
pbugnion
force-pushed
the
python-linting-reformatting
branch
from
9adb044
to
75b07eb
Compare
|
I've fixed the flake8 incompatibilities. |
tcbegley
reviewed
Oct 26, 2018
tcbegley
pushed a commit
that referenced
this pull request
Nov 28, 2020
Add Python linting and reformatting
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.
This PR adds flake8 and black to the build pipeline. Black enforces a consistent code style, and flake8 catches common errors like unused imports or unused variables.
I have used the same black configuration as sherlockml for consistency across ASI.
The only complexity is that flake8 needs to ignore specific components files in the documentation: the ones that require
appto be injected when the code is executed. For now, this is justcollapse.This also adds a very basic check for syntax errors in the source code for all the versions of Python which I presume we want to target. Since Dash supports Python 2, the cost to supporting it seems minimal.