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

Fix subscript comment placement with parenthesized value (#10496)

Browse source 
## Summary

This is a follow up on https://github.com/astral-sh/ruff/pull/10492 

I incorrectly assumed that `subscript.value.end()` always points past
the value. However, this isn't the case for parenthesized values where
the end "ends" before the parentheses.

## Test Plan

I added new tests for the parenthesized case.
This commit is contained in:
Micha Reiser 2024-03-20 21:30:22 +01:00 • committed by GitHub
parent fd3d272026
commit 9d705a4414
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 42 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

16
crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/subscript.py vendored
View file

@ -4,7 +4,6 @@ result = (
+ 1
)[0]
# Regression tests for: https://github.com/astral-sh/ruff/issues/10355
repro(
"some long string that takes up some space"
@ -14,7 +13,7 @@ repro(
repro(
"some long string that takes up some space"
)[0 # some long comment also taking up space
)[0 # some long comment also taking up space
]
repro(
@ -23,9 +22,20 @@ repro(
repro("some long string that takes up some space")[0] # some long comment also taking up space
repro(
"some long string that takes up some space"
)[ # some long comment also taking up space
0:-1
]
(
repro
)[ # some long comment also taking up space
0
]
(
repro # some long comment also taking up space
)[
0
]

13
crates/ruff_python_formatter/src/comments/placement.rs
View file

@ -262,7 +262,9 @@ fn handle_enclosed_comment<'a>(
// 0
// ]
// ```
if comment.line_position().is_end_of_line() {
if comment.line_position().is_end_of_line()
&& expr_subscript.value.end() < comment.start()
{
// Ensure that there are no tokens between the open bracket and the comment.
let mut lexer = SimpleTokenizer::new(
locator.contents(),
@ -270,13 +272,14 @@ fn handle_enclosed_comment<'a>(
)
.skip_trivia();
// Skip the opening parenthesis.
let Some(paren) = lexer.next() else {
// Skip to after the opening parenthesis (may skip some closing parentheses of value)
if !lexer
.by_ref()
.any(|token| token.kind() == SimpleTokenKind::LBracket)
{
return CommentPlacement::Default(comment);
};
debug_assert_eq!(paren.kind(), SimpleTokenKind::LBracket);
// If there are no additional tokens between the open parenthesis and the comment, then
// it should be attached as a dangling comment on the brackets, rather than a leading
// comment on the first argument.

26
crates/ruff_python_formatter/tests/snapshots/format@expression__subscript.py.snap
View file

@ -10,7 +10,6 @@ result = (
+ 1
)[0]
# Regression tests for: https://github.com/astral-sh/ruff/issues/10355
repro(
"some long string that takes up some space"
@ -20,7 +19,7 @@ repro(
repro(
"some long string that takes up some space"
)[0 # some long comment also taking up space
)[0 # some long comment also taking up space
]
repro(
@ -29,12 +28,23 @@ repro(
repro("some long string that takes up some space")[0] # some long comment also taking up space
repro(
"some long string that takes up some space"
)[ # some long comment also taking up space
0:-1
]
(
repro
)[ # some long comment also taking up space
0
]
(
repro # some long comment also taking up space
)[
0
]
```
## Output
@ -45,7 +55,6 @@ result = (
+ 1
)[0]
# Regression tests for: https://github.com/astral-sh/ruff/issues/10355
repro(
"some long string that takes up some space"
@ -65,10 +74,17 @@ repro("some long string that takes up some space")[
0
] # some long comment also taking up space
repro(
"some long string that takes up some space"
)[ # some long comment also taking up space
0:-1
]
(repro)[ # some long comment also taking up space
0
]
(
repro # some long comment also taking up space
)[0]
```