Run Black, flake8, and isort via tox.ini #294
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
Only a few corrections were made, one of which was a rather subtle shadowing of the json module import in a loop variable. The variable was renamed to better describe what it contains.
m-linner-ericsson
approved these changes
Jan 26, 2022
e-backmark-ericsson
pushed a commit
to e-backmark-ericsson/eiffel
that referenced
this pull request
Apr 13, 2022
We add three commonly used linters and code formatters; Black, flake8, and isort. Together they make sure all Python code is consistently formatted and has a reasonably consistent style in other aspects. All code has been adjusted to satisfy these programs. Of the flake8 corrections made, one was a rather subtle shadowing of the json module import in a loop variable. The variable was renamed to better describe what it contains.
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.
Applicable Issues
Fixes #291
Description of the Change
We add three commonly used linters and code formatters; Black, flake8, and isort. Together they make sure all Python code is consistently formatted and has a reasonably consistent style in other aspects. All code has been adjusted to satisfy these program. This has been in one commit per linter so I recommend the PR is reviewed commit by commit.
Note that the commit that introduces Black doesn't use its default line length of 88 characters but rather the more traditional limit of 79 characters. This resulted in a number of odd linebreaks so I added an extra commit at that top of the stack that flipped to Black's default. That resulted in fewer linebreaks and is arguably an improvement. I personally don't mind a line length limit higher than 80 characters but if that's what you prefer I can just chop off the last commit. See Black's rationale for its 88 character limit for some background.
Alternate Designs
None, but see line length discussion above.
Benefits
Easier for developers to produce consistent code. Less work for reviewers.
Possible Drawbacks
None, unless you have very particular opinions about code style and formatting.
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
Signed-off-by: Magnus Bäck <magnus.back@axis.com>