-
Notifications
You must be signed in to change notification settings - Fork 18
Use ruff for formatting and document code quality #729
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
Merged
Conversation
This file contains hidden or 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #729 +/- ##
==========================================
- Coverage 62.50% 62.49% -0.01%
==========================================
Files 70 70
Lines 6232 6231 -1
Branches 506 506
==========================================
- Hits 3895 3894 -1
Misses 2179 2179
Partials 158 158 ☔ View full report in Codecov by Sentry. |
Psycojoker
reviewed
Dec 12, 2024
Psycojoker
approved these changes
Dec 12, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Co-authored-by: Bram <cortex@worlddomination.be>
For some reason isort was detecting the "packaging" module as first party and not std
98d5088
to
1d4fc69
Compare
hoh
reviewed
Dec 13, 2024
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.
Switch to ruff for formatting (not linting) instead of black.
Self proofreading checklist
packaging/Makefile
Changes
To clarify, ruff has two mode:
ruff format
orhatch fmt --formatter
, which is more or less equivalent toblack
ruff --fix
orruff check fix
orhatch fmt --linter
, which check the code style more comprehensively and which fixes can't always be automated.The builtin command
hatch fmt
launch both. But in aleph-vm we usehatch linting:fmt
(orlinting:style
) that do a whole bunch additional checks (yaml, pyproject.toml, etc..)This PR remove
black
execution from the fmt/style scripts in hatch but keep it configured and installed for now (so we can double check and to ease transition)The ruff configuration is also modified so it match what isort do. We still use isort as
ruff format
doesn't match that capability (but ruff lint does)Did a ruff check on tests (lint)
How to test
No expected behaviural chnage in the program run.
Notes