Add flake8 linter & fix conflict between isort and black #653
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
Member
Ana06
commented
Feb 4, 2025
Ana06
commented
- Add max length of an import line to isort to avoid conflicts with black.
- Add flake8 linter to CI to improve code quality and maintainability.
- Fix flake8 offenses identified by the linter.
- Standardizee the formatting of multiline strings across all scripts, ensuring consistency and improved readability.
Add max length of an import line to isort to avoid conflicts with black.
| - name: Run isort | ||
| run: isort --check --diff . | ||
| run: isort --check --diff --line-length 120 . |
There was a problem hiding this comment.
why is it 120 here and 150 above?
There was a problem hiding this comment.
black does not complain about strings or fix long string, while flake8 does complain. A lower max line in flake8 generates the following offences. I feel fixing this offenses is more annoying that helpful as the strings become more difficult to read.
$ flake8 --max-line-length 120
./virtualbox/vbox-adapter-check.py:97:121: E501 line too long (136 > 120 characters)
./virtualbox/vbox-adapter-check.py:101:121: E501 line too long (128 > 120 characters)
./virtualbox/vbox-adapter-check.py:127:121: E501 line too long (145 > 120 characters)
./virtualbox/vbox-adapter-check.py:131:121: E501 line too long (124 > 120 characters)
./virtualbox/vbox-clean-snapshots.py:24:121: E501 line too long (141 > 120 characters)
./virtualbox/vbox-clean-snapshots.py:29:121: E501 line too long (150 > 120 characters)
./virtualbox/vbox-clean-snapshots.py:32:121: E501 line too long (141 > 120 characters)
./virtualbox/vbox-clean-snapshots.py:35:121: E501 line too long (135 > 120 characters)
./virtualbox/vbox-clean-snapshots.py:38:121: E501 line too long (137 > 120 characters)
./virtualbox/vbox-clean-snapshots.py:58:121: E501 line too long (131 > 120 characters)
./virtualbox/vbox-clean-snapshots.py:114:121: E501 line too long (123 > 120 characters)
./virtualbox/vbox-export-snapshots.py:29:121: E501 line too long (134 > 120 characters)
@williballenthin do you think is it ok to leave these 2 different max and add a clarifying comment?
There was a problem hiding this comment.
doesn't bother me, just wondering. thanks!
There was a problem hiding this comment.
Thanks for the review @williballenthin!
williballenthin
approved these changes
Feb 4, 2025
This commit adds flake8 to the continuous integration (CI) pipeline. flake8 will now run on every push and pull request, helping to enforce code style consistency and identify potential issues early. This will improve code quality and maintainability.
This commit addresses flake8 offenses identified by the linter. It also standardizes the formatting of multiline strings across all scripts, ensuring consistency and improved readability.
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.