Switch from black to ruff format
#4559
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
It gives a warning when running the Ruff formatter. This rule can cause the linter and formatter to conflict, meaning you need to rerun `ruff check --fix` again after `ruff format`. See astral-sh/ruff#8272 (comment)
`outputs/` was the only Black exclusion not being excluded for Ruff, so also add that exclusion there.
This also removes several transitive dependencies.
StevenMaude
force-pushed
the
steve/switch-from-black-to-ruff-format
branch
from
ea905d0
to
79eb8a5
Compare
Jongmassey
approved these changes
Aug 27, 2024
iaindillingham
approved these changes
Aug 28, 2024
Comment on lines
177
to
+178
| $BIN/ruff check --fix . | ||
| $BIN/ruff format . |
There was a problem hiding this comment.
What does check --fix do that format doesn't do?
There was a problem hiding this comment.
ruff check runs the linter and fixes any automatically fixable issues it finds (example: removing unused imports), but ruff check doesn't run the formatter.
It's planned for ruff to eventually unify the two, which will reduce this to a single command instead.
There was a problem hiding this comment.
I need to read up on the difference between linting and formatting!
| @@ -121,6 +109,7 @@ exclude = [ | |||
| "docs", | |||
| "htmlcov", | |||
| "node_modules", | |||
| "outputs", | |||
There was a problem hiding this comment.
Unless I've missed something, static is already included below.
outputs was the only entry for the Black excludes, that wasn't listed already in Ruff's excludes.
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.
Fixes #4542.
ruff formatis considerably faster thanblack, while maintaining almost entirely the same formatting output. After deleting the cache for both and running against job-server commit 241415f:(Note: the Ruff warning is fixed in this PR; it's because the configuration's not updated on the
mainbranch where I ran the above.)As a bonus, this also removes several additional development dependencies.