mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-11-25 22:29:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Formatter: Add EmptyWithDanglingComments helper (#5951)

Browse source 
**Summary** Add a `EmptyWithDanglingComments` format helper that formats
comments inside empty parentheses, brackets or curly braces. Previously,
this was implemented separately, and partially incorrectly, for each use
case.

Empty `()`, `[]` and `{}` are special because there can be dangling
comments, and they can be in
two positions:
```python
x = [  # end-of-line
    # own line
]
```
These comments are dangling because they can't be assigned to any
element inside as they would
in all other cases.

**Test Plan** Added a regression test.

145 (from previously 149) instances of unstable formatting remaining.

```
$ cargo run --bin ruff_dev --release -- format-dev --stability-check --error-file formatter-ecosystem-errors.txt --multi-project target/checkouts > formatter-ecosystem-progress.txt
$ rg "Unstable formatting" target/formatter-ecosystem-errors.txt | wc -l
145
```
This commit is contained in:
konsti 2023-07-23 14:32:16 +02:00 • committed by GitHub
parent f886b58c92
commit 46f8961292
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 94 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

3
crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/dict.py vendored
View file

@ -56,3 +56,6 @@ a = {
# comment
3: True,
}
x={ # dangling end of line comment
}

3
crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/delete.py vendored
View file

@ -70,3 +70,6 @@ del (
# Deleted
) # Completed
# Done
del ( # dangling end of line comment
)