Fix black & isort incompability (again) & standardize linter line-length arguments #655
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
Configure isort to use the black profile (`--profile black`) to ensure
consistent formatting of long import lines. This prevents conflicts
between isort and black, which would otherwise format these lines
differently. Example:
`isort --line-length 120` (without `--profile black`):
```
from vboxcommon import (ensure_hostonlyif_exists, ensure_vm_running, ensure_vm_shutdown, get_vm_uuid, restore_snapshot,
run_vboxmanage)
```
`black --line-length=120`:
```
from vboxcommon import (
ensure_hostonlyif_exists,
ensure_vm_running,
ensure_vm_shutdown,
get_vm_uuid,
restore_snapshot,
run_vboxmanage,
)
```
Consistently use the `--<argument_name>=<number>` format for the maximum line length argument across all linters.
williballenthin
approved these changes
Feb 5, 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.
In ba2e1ef I set a consistent maximum line length in isort and black to try to address the conflicts when formatting long import lines But it is insufficient because isort and black format these lines differently. This PR resolves the issue by configuring isort to use the black profile (
--profile black). This ensures consistent formatting and avoid conflicts.Additionally, this PR standardizes the way the maximum line length argument is passed to all linters, using the
--<argument_name>=<number>format consistently.Incompatibility example
isort --line-length 120(without--profile black)black --line-length=120