Skip to content
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.

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

Avoid expanding single-element tuple patterns #7683

Merged
merged 1 commit into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -501,3 +501,24 @@ def foo():
# own line
):
...


# Single-element tuples.
match pattern:
Copy link
Member

Choose a reason for hiding this comment

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

Can we add some more tests with comments?

case (a,):
pass

case (a, b):
pass

case (a, b,):
pass

case a,:
pass

case a, b:
pass

case a, b,:
pass
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use ruff_formatter::{Format, FormatResult};
use ruff_formatter::{format_args, Format, FormatResult};
use ruff_python_ast::node::AnyNodeRef;
use ruff_python_ast::PatternMatchSequence;
use ruff_python_trivia::{SimpleTokenKind, SimpleTokenizer};
Expand All @@ -20,14 +20,25 @@ impl FormatNodeRule<PatternMatchSequence> for FormatPatternMatchSequence {
let dangling = comments.dangling(item);

let sequence_type = SequenceType::from_pattern(item, f.context().source());
if patterns.is_empty() {
return match sequence_type {
SequenceType::List => empty_parenthesized("[", dangling, "]").fmt(f),
SequenceType::Tuple | SequenceType::TupleNoParens => {
empty_parenthesized("(", dangling, ")").fmt(f)
}
};

match (patterns.as_slice(), sequence_type) {
// If the sequence is empty, the parentheses with any dangling comments.
([], SequenceType::Tuple | SequenceType::TupleNoParens) => {
Copy link
Member

Choose a reason for hiding this comment

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

This comment seems to miss at least a verb.

return empty_parenthesized("(", dangling, ")").fmt(f)
}
([], SequenceType::List) => return empty_parenthesized("[", dangling, "]").fmt(f),

// A single-element tuple should always be parenthesized, and the trailing comma
// should never cause it to expand.
([elt], SequenceType::Tuple | SequenceType::TupleNoParens) => {
return parenthesized("(", &format_args![elt.format(), token(",")], ")")
.with_dangling_comments(dangling)
.fmt(f)
}

_ => {}
}

let items = format_with(|f| {
f.join_comma_separated(range.end())
.nodes(patterns.iter())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -507,6 +507,27 @@ match pattern_match_or:
# own line
):
...


# Single-element tuples.
match pattern:
case (a,):
pass

case (a, b):
pass

case (a, b,):
pass

case a,:
pass

case a, b:
pass

case a, b,:
pass
```

## Output
Expand Down Expand Up @@ -1038,6 +1059,33 @@ match pattern_match_or:
# own line
):
...


# Single-element tuples.
match pattern:
case (a,):
pass

case (a, b):
pass

case (
a,
b,
):
pass

case (a,):
pass

case a, b:
pass

case (
a,
b,
):
pass
```


Expand Down
Loading