Replace black and pyproject.toml with ruff format and ruff.toml
#1188
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
quis
changed the title
ruff.tomlblack and pyproject.toml with ruff format and ruff.toml
leohemsted
reviewed
Jan 23, 2025
| @@ -7,5 +7,4 @@ pytest-testmon==2.1.1 | |||
| requests-mock==1.12.1 | |||
| freezegun==1.5.1 | |||
|
|
|||
| black==24.10.0 # Also update `.pre-commit-config.yaml` if this changes | |||
| ruff==0.8.2 # Also update `.pre-commit-config.yaml` if this changes | |||
There was a problem hiding this comment.
while we're changing our formatter, is it worth updating to ruff 0.9.x? (which changes formatter rules slightly, including "Improved compatibility with Black’s style guide")
There was a problem hiding this comment.
Preserving the source formatting for these cases means that the longstanding formatter incompatibility with our ISC001 rule is now resolved. Users will no longer see a warning if they have both the formatter and this lint rule enabled in their Ruff configuration.
There was a problem hiding this comment.
Good idea, have made the bump in 122d4fd and rebased
This will let us use `pyproject.toml` for stuff that is specific to utils (like dependencies) and we can stop copying it into each app.
This is where the apps should look for their linter config now.
This is no longer used anywhere
It’s faster and means we have one fewer dependencies.
We were only using it for black config. We are no longer using black.
leohemsted
approved these changes
Jan 23, 2025
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 will let us use
pyproject.tomlfor stuff that is specific to utils (like dependencies) and we can stop copying it into each app.We can then delete the duplicate copy of
pyproject.tomlwe had to create in #1187ruff formatis faster thanblackand means we need one fewer dependency.While ruff aims for 99.9% compatibility with black our codebase is big enough to hit a couple of the differences, hence some slight changes to Python code, and the need to consider this a breaking change for consuming apps.