Skip to content

Avoid syntax error when formatting attribute expressions with outer parentheses, parenthesized value, and trailing comment on value #20418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Avoid syntax error when formatting attribute expressions with outer parentheses, parenthesized value, and trailing comment on value #20418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ffc6e58
add fixture
dylwil3 Sep 15, 2025
b44449c
modify attr needs parens when trailing comment
dylwil3 Sep 15, 2025
080b026
update snapshot
dylwil3 Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/attribute.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,3 +169,9 @@
# dangling before dot
.b # trailing end-of-line
)

# Regression test for https://github.com/astral-sh/ruff/issues/19350
variable = (
(something) # a comment
.fist_method("some string")
)
6 changes: 5 additions & 1 deletion crates/ruff_python_formatter/src/expression/expr_attribute.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,11 @@ impl NeedsParentheses for ExprAttribute {
context.comments().ranges(),
context.source(),
) {
OptionalParentheses::Never
if context.comments().has_trailing(self.value.as_ref()) {
Copy link
Member

@MichaReiser MichaReiser Sep 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll now also use the new layout if value is parenthesized and has a trailing comment like this

variable = (
    (something # a comment  
    ).fist_method("some string")
)

I think that's fine but it might be worth adding a few more tests.

For example, this snippet now gets formatted differently:

if (
    (something # a comment  
    ).fist_method("some string") # second comment
): pass

Overall, maybe add a few more permutations with multiple comments (or at least play with it in the playground)

OptionalParentheses::Multiline
} else {
OptionalParentheses::Never
}
} else {
self.value.needs_parentheses(self.into(), context)
}
Expand Down
12 changes: 12 additions & 0 deletions crates/ruff_python_formatter/tests/snapshots/format@expression__attribute.py.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,12 @@ result = (
# dangling before dot
.b # trailing end-of-line
)

# Regression test for https://github.com/astral-sh/ruff/issues/19350
variable = (
(something) # a comment
.fist_method("some string")
)
```

## Output
Expand Down Expand Up @@ -328,4 +334,10 @@ result = (
# dangling before dot
.b # trailing end-of-line
)

# Regression test for https://github.com/astral-sh/ruff/issues/19350
variable = (
(something) # a comment
.fist_method("some string")
)
```
Loading