language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-03 18:28:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Avoid omitting optional parentheses for argument-less parentheses (#6484)

Browse source 
## Summary

This PR fixes some misformattings around optional parentheses for
expressions.

I first noticed that we were misformatting this:

```python
return (
    unicodedata.normalize("NFKC", s1).casefold()
    == unicodedata.normalize("NFKC", s2).casefold()
)
```

The above is stable Black formatting, but we were doing:
```python
return unicodedata.normalize("NFKC", s1).casefold() == unicodedata.normalize(
    "NFKC", s2
).casefold()
```

Above, the "last" expression is a function call, so our
`can_omit_optional_parentheses` was returning `true`...

However, it turns out that Black treats function calls differently
depending on whether or not they have arguments -- presumedly because
they'll never split empty parentheses, and so they're functionally
non-useful. On further investigation, I believe this applies to all
parenthesized expressions. If Black can't split on the parentheses, it
doesn't leverage them when removing optional parentheses.

## Test Plan

Nice increase in similarity scores.

Before:

- `zulip`: 0.99702
- `django`: 0.99784
- `warehouse`: 0.99585
- `build`: 0.75623
- `transformers`: 0.99470
- `cpython`: 0.75989
- `typeshed`: 0.74853

After:

- `zulip`: 0.99705
- `django`: 0.99795
- `warehouse`: 0.99600
- `build`: 0.75623
- `transformers`: 0.99471
- `cpython`: 0.75989
- `typeshed`: 0.74853
This commit is contained in:
Charlie Marsh 2023-08-11 13:58:42 -04:00 • committed by GitHub
parent 7c4aa3948b
commit d616c9b870
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 428 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

7
crates/ruff_python_formatter/tests/snapshots/format@expression__compare.py.snap
View file

@ -226,9 +226,10 @@ return 1 == 2 and (
def f():
return unicodedata.normalize("NFKC", s1).casefold() == unicodedata.normalize(
"NFKC", s2
).casefold()
return (
unicodedata.normalize("NFKC", s1).casefold()
== unicodedata.normalize("NFKC", s2).casefold()
)
# Call expressions with trailing attributes.

197
crates/ruff_python_formatter/tests/snapshots/format@expression__split_empty_brackets.py.snap Normal file
View file

@ -0,0 +1,197 @@
---
source: crates/ruff_python_formatter/tests/fixtures.rs
input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression/split_empty_brackets.py
---
## Input
```py
# Expressions with empty parentheses.
ct_match = (
unicodedata.normalize("NFKC", s1).casefold()
== unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = (
unicodedata.normalize("NFKC", s1).casefold(1)
== unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = (
unicodedata.normalize("NFKC", s1).casefold(0)
== unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold(1)
)
ct_match = (
unicodedata.normalize("NFKC", s1).casefold(1)
== unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold(1)
)
ct_match = (
unicodedata.normalize("NFKC", s1).casefold(
# foo
)
== unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold(
# foo
)
)
ct_match = (
[].unicodedata.normalize("NFKC", s1).casefold()
== [].unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = (
[].unicodedata.normalize("NFKC", s1).casefold()
== [1].unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = (
[1].unicodedata.normalize("NFKC", s1).casefold()
== [].unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = (
[1].unicodedata.normalize("NFKC", s1).casefold()
== [1].unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = (
{}.unicodedata.normalize("NFKC", s1).casefold()
== {}.unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = (
{}.unicodedata.normalize("NFKC", s1).casefold()
== {1}.unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = (
{1}.unicodedata.normalize("NFKC", s1).casefold()
== {}.unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = (
{1}.unicodedata.normalize("NFKC", s1).casefold()
== {1}.unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = (
([]).unicodedata.normalize("NFKC", s1).casefold()
== ([]).unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
return await self.http_client.fetch(
f"http://127.0.0.1:{self.port}{path}", method=method, **kwargs,
)
return await self.http_client().fetch(
f"http://127.0.0.1:{self.port}{path}", method=method, **kwargs,
)
return await self().http_client().fetch(
f"http://127.0.0.1:{self.port}{path}", method=method, **kwargs,
)
response = await sync_to_async(
lambda: self.django_handler.get_response(request), thread_sensitive=True
)()
```
## Output
```py
# Expressions with empty parentheses.
ct_match = (
unicodedata.normalize("NFKC", s1).casefold()
== unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = (
unicodedata.normalize("NFKC", s1).casefold(1)
== unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = unicodedata.normalize("NFKC", s1).casefold(0) == unicodedata.normalize(
"NFKCNFKCNFKCNFKCNFKC", s2
).casefold(1)
ct_match = unicodedata.normalize("NFKC", s1).casefold(1) == unicodedata.normalize(
"NFKCNFKCNFKCNFKCNFKC", s2
).casefold(1)
ct_match = (
unicodedata.normalize("NFKC", s1).casefold(
# foo
)
== unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold(
# foo
)
)
ct_match = (
[].unicodedata.normalize("NFKC", s1).casefold()
== [].unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = (
[].unicodedata.normalize("NFKC", s1).casefold()
== [1].unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = [1].unicodedata.normalize("NFKC", s1).casefold() == [].unicodedata.normalize(
"NFKCNFKCNFKCNFKCNFKC", s2
).casefold()
ct_match = [1].unicodedata.normalize("NFKC", s1).casefold() == [
1
].unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
ct_match = (
{}.unicodedata.normalize("NFKC", s1).casefold()
== {}.unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = (
{}.unicodedata.normalize("NFKC", s1).casefold()
== {1}.unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
)
ct_match = {1}.unicodedata.normalize("NFKC", s1).casefold() == {}.unicodedata.normalize(
"NFKCNFKCNFKCNFKCNFKC", s2
).casefold()
ct_match = {1}.unicodedata.normalize("NFKC", s1).casefold() == {
1
}.unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
ct_match = ([]).unicodedata.normalize("NFKC", s1).casefold() == (
[]
).unicodedata.normalize("NFKCNFKCNFKCNFKCNFKC", s2).casefold()
return await self.http_client.fetch(
f"http://127.0.0.1:{self.port}{path}",
method=method,
**kwargs,
)
return await self.http_client().fetch(
f"http://127.0.0.1:{self.port}{path}",
method=method,
**kwargs,
)
return (
await self()
.http_client()
.fetch(
f"http://127.0.0.1:{self.port}{path}",
method=method,
**kwargs,
)
)
response = await sync_to_async(
lambda: self.django_handler.get_response(request), thread_sensitive=True
)()
```

19
crates/ruff_python_formatter/tests/snapshots/format@statement__assign.py.snap
View file

@ -19,6 +19,17 @@ aa = [
bakjdshflkjahdslkfjlasfdahjlfds
] = dddd = ddd = fkjaödkjaföjfahlfdalfhaöfaöfhaöfha = g = [3]
aa = [
] = dddd = ddd = fkjaödkjaföjfahlfdalfhaöfaöfhaöfha = g = [3]
aa = [
# foo
] = dddd = ddd = fkjaödkjaföjfahlfdalfhaöfaöfhaöfha = g = [3]
aa = ([
]) = dddd = ddd = fkjaödkjaföjfahlfdalfhaöfaöfhaöfha = g = [3]
aaaa = ( # trailing
# comment
bbbbb) = cccccccccccccccc = 3
@ -47,6 +58,14 @@ aa = [
bakjdshflkjahdslkfjlasfdahjlfds
] = dddd = ddd = fkjaödkjaföjfahlfdalfhaöfaöfhaöfha = g = [3]
aa = [] = dddd = ddd = fkjaödkjaföjfahlfdalfhaöfaöfhaöfha = g = [3]
aa = [
# foo
] = dddd = ddd = fkjaödkjaföjfahlfdalfhaöfaöfhaöfha = g = [3]
aa = [] = dddd = ddd = fkjaödkjaföjfahlfdalfhaöfaöfhaöfha = g = [3]
aaaa = ( # trailing
# comment
bbbbb