Migrate from isort/Black/Flake8 to Ruff for Code Formatting and Linting #5424
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
snejus
force-pushed
the
configure-ruff
branch
10 times, most recently
from
292996f to
52507cf
Compare
snejus
force-pushed
the
fix-lrclib-lyrics
branch
from
622ed3c to
3eb04ba
Compare
snejus
force-pushed
the
configure-ruff
branch
3 times, most recently
from
ef83264 to
9b6b1e9
Compare
snejus
force-pushed
the
fix-lrclib-lyrics
branch
from
3eb04ba to
4d481d7
Compare
snejus
force-pushed
the
configure-ruff
branch
2 times, most recently
from
d7c656b to
66bbd67
Compare
|
Since this PR depends on |
- Fix imports - Fix pytest issues - Do not assign lambda as variable - Use isinstance instead of type to check type - Rename ambiguously named variables - Name custom errors with Error suffix
* Replace `noqa` comments in `assert...` method definitions with a configuration option to ignore these names. * Use the `__all__` variable to specify importable items from the module, replacing `*` imports and `noqa` comments for unused imports. * Address issues with poorly named variables and methods by renaming them appropriately.
The variable in `test_ordered_enum` was flagged for naming issues, and I noticed that `OrderedEnum` is essentially `enum.IntEnum`. I guess `OrderedEnum` exists because it was created before `enum.IntEnum` was made available in Python 3.4. We do not need it anymore though, so it's now gone.
snejus
force-pushed
the
configure-ruff
branch
from
66bbd67 to
8e8f77d
Compare
Above does not apply anymore - I rebased it on |
bal-e
approved these changes
Sep 21, 2024
|
LGTM, @snejus! |
This commit introduces a `.git-blame-ignore-revs` file to the repository. The purpose of this file is to list specific commit hashes that should be ignored when using the `git blame` command. This is useful for ignoring commits that involve large-scale formatting changes, refactoring, or other non-functional changes that would otherwise clutter the blame history. I added a couple of previous commit hashes which reformatted the code. Configure this repository to use this file: git config --local blame.ignoreRevsFile .git-blame-ignore-revs
snejus
force-pushed
the
configure-ruff
branch
from
8e8f77d to
11fa6c7
Compare
|
Great, I have just updated the |
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.
Context
I noticed one of recently merged PRs used
unittestassertions that we are migrating from. Thus, I thought it would be a good idea to configure our linting to catch such issues in the future. Since I was here, I replaced our multiple linting and formatting tools with a single tool, Ruff, to simplify and speed up our development workflow.Summary
This PR migrates the codebase from using isort, Black and Flake8 to Ruff for code formatting and linting. The changes include updates to the GitHub Actions workflow, pre-commit configuration, and documentation to reflect the new tooling.
Changes
GitHub Actions Workflow
.github/workflows/lint.ymlto usepoetry install --only=lintandpoe lint --output-format=github.Pre-commit Configuration
.pre-commit-config.yaml.Documentation
CONTRIBUTING.rstto reflect the use of Ruff for formatting and linting.Poetry Configuration
poetry.lockandpyproject.toml.pyproject.toml.Setup Configuration
setup.cfg.Git blame
.git-blame-ignore-revsfile to keep git blame clean from formattingchanges. Configure your local
beetsrepository to use this file by running:$ git config --local blame.ignoreRevsFile .git-blame-ignore-revsBenefits
How to Test
Linting and Formatting
poe check-formatto check for formatting issues.poe formatto format the codebase.poe lintto check for linting issues.Pre-commit Hooks
pre-commit run --all-files.CI Pipeline
Notes
unittesttopytestare welcome.requests_mockand tested weekly in the integration test suite.References
This PR aims to streamline our development process by adopting Ruff, a modern and efficient tool for Python code formatting and linting.