Skip to content

Commit 6a59648

Browse files
MichaReiserMichaReiser
committed
Parenthesize match..case if guards
1 parent 2584f8e commit 6a59648

File tree

6 files changed

+80
-88
lines changed

6 files changed

+80
-88
lines changed

‎crates/ruff_python_formatter/src/expression/parentheses.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ pub(crate) enum Parenthesize {
5959
/// Same as [`Self::IfBreaks`] except that it uses [`parenthesize_if_expands`] for expressions
6060
/// with the layout [`NeedsParentheses::BestFit`] which is used by non-splittable
6161
/// expressions like literals, name, and strings.
62+
///
63+
/// Use this layout over `IfBreaks` when there's a sequence of `maybe_parenthesize_expression`
64+
/// in a single logical-line and you want to break from right-to-left. Use `IfBreaks` for the
65+
/// first expression and `IfBreaksParenthesized` for the rest.
6266
IfBreaksParenthesized,
6367

6468
/// Same as [`Self::IfBreaksParenthesized`] but uses [`parenthesize_if_expands`] for nested

‎crates/ruff_python_formatter/src/other/match_case.rs

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@ use ruff_python_ast::AstNode;
33
use ruff_python_ast::MatchCase;
44

55
use crate::builders::parenthesize_if_expands;
6-
use crate::expression::parentheses::{NeedsParentheses, OptionalParentheses, Parentheses};
6+
use crate::expression::maybe_parenthesize_expression;
7+
use crate::expression::parentheses::{
8+
NeedsParentheses, OptionalParentheses, Parentheses, Parenthesize,
9+
};
710
use crate::pattern::maybe_parenthesize_pattern;
811
use crate::prelude::*;
912
use crate::preview::is_match_case_parentheses_enabled;
@@ -62,20 +65,27 @@ impl FormatNodeRule<MatchCase> for FormatMatchCase {
6265
}
6366
});
6467

68+
let format_guard = guard.as_deref().map(|guard| {
69+
format_with(|f| {
70+
write!(f, [space(), token("if"), space()])?;
71+
72+
if is_match_case_parentheses_enabled(f.context()) {
73+
maybe_parenthesize_expression(guard, item, Parenthesize::IfBreaksParenthesized)
74+
.fmt(f)
75+
} else {
76+
guard.format().fmt(f)
77+
}
78+
})
79+
});
80+
6581
write!(
6682
f,
6783
[
6884
clause_header(
6985
ClauseHeader::MatchCase(item),
7086
dangling_item_comments,
7187
&format_with(|f| {
72-
write!(f, [token("case"), space(), format_pattern])?;
73-
74-
if let Some(guard) = guard {
75-
write!(f, [space(), token("if"), space(), guard.format()])?;
76-
}
77-
78-
Ok(())
88+
write!(f, [token("case"), space(), format_pattern, format_guard])
7989
}),
8090
),
8191
clause_body(

‎crates/ruff_python_formatter/src/preview.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ pub(crate) fn is_empty_parameters_no_unnecessary_parentheses_around_return_value
3939

4040
/// See [#6933](https://github.com/astral-sh/ruff/issues/6933).
4141
/// This style also covers the black preview styles `remove_redundant_guard_parens` and `parens_for_long_if_clauses_in_case_block `.
42+
/// WARNING: This preview style depends on `is_empty_parameters_no_unnecessary_parentheses_around_return_value_enabled`
43+
/// because it relies on the new semantic of `IfBreaksParenthesized`.
4244
pub(crate) fn is_match_case_parentheses_enabled(context: &PyFormatContext) -> bool {
4345
context.is_preview()
4446
}

‎crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__pattern_matching_with_if_stmt.py.snap

Lines changed: 16 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -44,36 +44,9 @@ match x:
4444
```diff
4545
--- Black
4646
+++ Ruff
47-
@@ -3,34 +3,36 @@
47+
@@ -21,11 +21,17 @@
4848
pass
49-
50-
match smth:
51-
- case "test" if (
52-
- "any long condition" != "another long condition" and "this is a long condition"
53-
- ):
54-
+ case "test" if "any long condition" != "another long condition" and "this is a long condition":
55-
pass
56-
- case test if (
57-
- "any long condition" != "another long condition"
58-
- and "this is a looooong condition"
59-
- ):
60-
+ case (
61-
+ test
62-
+ ) if "any long condition" != "another long condition" and "this is a looooong condition":
63-
pass
64-
- case test if (
65-
- "any long condition" != "another long condition"
66-
- and "this is a looooong condition"
67-
- ): # some additional comments
68-
+ case (
69-
+ test
70-
+ ) if "any long condition" != "another long condition" and "this is a looooong condition": # some additional comments
71-
pass
72-
- case test if True: # some comment
73-
+ case test if (True): # some comment
74-
pass
75-
- case test if False: # some comment
76-
+ case test if (False): # some comment
49+
case test if False: # some comment
7750
pass
7851
- case test if True: # some comment
7952
+ case test if (
@@ -92,12 +65,6 @@ match x:
9265
pass # some comment
9366
9467
# case black_test_patma_052 (originally in the pattern_matching_complex test case)
95-
match x:
96-
case [1, 0] if x := x[:0]:
97-
y = 1
98-
- case [1, 0] if x := x[:0]:
99-
+ case [1, 0] if (x := x[:0]):
100-
y = 1
10168
```
10269

10370
## Ruff Output
@@ -108,19 +75,23 @@ match match:
10875
pass
10976
11077
match smth:
111-
case "test" if "any long condition" != "another long condition" and "this is a long condition":
78+
case "test" if (
79+
"any long condition" != "another long condition" and "this is a long condition"
80+
):
11281
pass
113-
case (
114-
test
115-
) if "any long condition" != "another long condition" and "this is a looooong condition":
82+
case test if (
83+
"any long condition" != "another long condition"
84+
and "this is a looooong condition"
85+
):
11686
pass
117-
case (
118-
test
119-
) if "any long condition" != "another long condition" and "this is a looooong condition": # some additional comments
87+
case test if (
88+
"any long condition" != "another long condition"
89+
and "this is a looooong condition"
90+
): # some additional comments
12091
pass
121-
case test if (True): # some comment
92+
case test if True: # some comment
12293
pass
123-
case test if (False): # some comment
94+
case test if False: # some comment
12495
pass
12596
case test if (
12697
True # some comment
@@ -139,7 +110,7 @@ match smth:
139110
match x:
140111
case [1, 0] if x := x[:0]:
141112
y = 1
142-
case [1, 0] if (x := x[:0]):
113+
case [1, 0] if x := x[:0]:
143114
y = 1
144115
```
145116

‎crates/ruff_python_formatter/tests/snapshots/black_compatibility@cases__remove_redundant_parens_in_case_guard.py.snap

Lines changed: 6 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -69,20 +69,7 @@ match 1:
6969
```diff
7070
--- Black
7171
+++ Ruff
72-
@@ -1,10 +1,10 @@
73-
match 1:
74-
- case _ if True:
75-
+ case _ if (True):
76-
pass
77-
78-
79-
match 1:
80-
- case _ if True:
81-
+ case _ if (True):
82-
pass
83-
84-
85-
@@ -25,27 +25,33 @@
72+
@@ -25,12 +25,16 @@
8673
8774
8875
match 1:
@@ -101,18 +88,7 @@ match 1:
10188
pass
10289
10390
104-
match 1:
105-
- case _ if True: # this is a comment
106-
+ case _ if (True): # this is a comment
107-
pass
108-
109-
110-
match 1:
111-
- case _ if True: # comment over the line limit unless parens are removed x
112-
+ case _ if (
113-
+ True
114-
+ ): # comment over the line limit unless parens are removed x
115-
pass
91+
@@ -45,7 +49,7 @@
11692
11793
11894
match 1:
@@ -129,12 +105,12 @@ match 1:
129105

130106
```python
131107
match 1:
132-
case _ if (True):
108+
case _ if True:
133109
pass
134110
135111
136112
match 1:
137-
case _ if (True):
113+
case _ if True:
138114
pass
139115
140116
@@ -169,14 +145,12 @@ match 1:
169145
170146
171147
match 1:
172-
case _ if (True): # this is a comment
148+
case _ if True: # this is a comment
173149
pass
174150
175151
176152
match 1:
177-
case _ if (
178-
True
179-
): # comment over the line limit unless parens are removed x
153+
case _ if True: # comment over the line limit unless parens are removed x
180154
pass
181155
182156

‎crates/ruff_python_formatter/tests/snapshots/format@statement__match.py.snap

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1239,17 +1239,48 @@ match x:
12391239
```diff
12401240
--- Stable
12411241
+++ Preview
1242+
@@ -69,7 +69,7 @@
1243+
case "case comment with newlines" if foo == 2: # second
1244+
pass
1245+
1246+
- case "one", "newline" if (foo := 1): # third
1247+
+ case "one", "newline" if foo := 1: # third
1248+
pass
1249+
1250+
case "two newlines":
12421251
@@ -82,7 +82,9 @@
12431252
12441253
12451254
match long_lines:
12461255
- case "this is a long line for if condition" if aaaaaaaaahhhhhhhh == 1 and bbbbbbaaaaaaaaaaa == 2: # comment
1247-
+ case (
1248-
+ "this is a long line for if condition"
1249-
+ ) if aaaaaaaaahhhhhhhh == 1 and bbbbbbaaaaaaaaaaa == 2: # comment
1256+
+ case "this is a long line for if condition" if (
1257+
+ aaaaaaaaahhhhhhhh == 1 and bbbbbbaaaaaaaaaaa == 2
1258+
+ ): # comment
12501259
pass
12511260
12521261
case "this is a long line for if condition with parentheses" if (
1262+
@@ -93,7 +95,7 @@
1263+
case "named expressions aren't special" if foo := 1:
1264+
pass
1265+
1266+
- case "named expressions aren't that special" if (foo := 1):
1267+
+ case "named expressions aren't that special" if foo := 1:
1268+
pass
1269+
1270+
case "but with already broken long lines" if (
1271+
@@ -101,9 +103,9 @@
1272+
): # another comment
1273+
pass
1274+
1275+
- case {
1276+
- "long_long_long_key": str(long_long_long_key)
1277+
- } if value := "long long long long long long long long long long long value":
1278+
+ case {"long_long_long_key": str(long_long_long_key)} if (
1279+
+ value := "long long long long long long long long long long long value"
1280+
+ ):
1281+
pass
1282+
1283+
12531284
@@ -198,7 +200,9 @@
12541285
# trailing own 2
12551286
):

0 commit comments

Comments
 (0)