mirror of
https://github.com/astral-sh/ruff.git
synced 2025-07-24 13:34:40 +00:00
Improve dummy_implementations preview style formatting (#9240)
This commit is contained in:
Micha Reiser
GitHub
parent
a06723da2b
commit
9cc257ee7d
6 changed files with 159 additions and 294 deletions
|
|
@ -1,276 +0,0 @@
|
|||
---
|
||||
source: crates/ruff_python_formatter/tests/fixtures.rs
|
||||
input_file: crates/ruff_python_formatter/resources/test/fixtures/black/cases/preview_dummy_implementations.py
|
||||
---
|
||||
## Input
|
||||
|
||||
```python
|
||||
from typing import NoReturn, Protocol, Union, overload
|
||||
|
||||
class Empty:
|
||||
...
|
||||
|
||||
def dummy(a): ...
|
||||
async def other(b): ...
|
||||
|
||||
|
||||
@overload
|
||||
def a(arg: int) -> int: ...
|
||||
@overload
|
||||
def a(arg: str) -> str: ...
|
||||
@overload
|
||||
def a(arg: object) -> NoReturn: ...
|
||||
def a(arg: Union[int, str, object]) -> Union[int, str]:
|
||||
if not isinstance(arg, (int, str)):
|
||||
raise TypeError
|
||||
return arg
|
||||
|
||||
class Proto(Protocol):
|
||||
def foo(self, a: int) -> int:
|
||||
...
|
||||
|
||||
def bar(self, b: str) -> str: ...
|
||||
def baz(self, c: bytes) -> str:
|
||||
...
|
||||
|
||||
|
||||
def dummy_two():
|
||||
...
|
||||
@dummy
|
||||
def dummy_three():
|
||||
...
|
||||
|
||||
def dummy_four():
|
||||
...
|
||||
|
||||
@overload
|
||||
def b(arg: int) -> int: ...
|
||||
|
||||
@overload
|
||||
def b(arg: str) -> str: ...
|
||||
@overload
|
||||
def b(arg: object) -> NoReturn: ...
|
||||
|
||||
def b(arg: Union[int, str, object]) -> Union[int, str]:
|
||||
if not isinstance(arg, (int, str)):
|
||||
raise TypeError
|
||||
return arg
|
||||
|
||||
def has_comment():
|
||||
... # still a dummy
|
||||
|
||||
if some_condition:
|
||||
...
|
||||
|
||||
if already_dummy: ...
|
||||
```
|
||||
|
||||
## Black Differences
|
||||
|
||||
```diff
|
||||
--- Black
|
||||
+++ Ruff
|
||||
@@ -5,15 +5,23 @@
|
||||
|
||||
|
||||
def dummy(a): ...
|
||||
+
|
||||
+
|
||||
async def other(b): ...
|
||||
|
||||
|
||||
@overload
|
||||
def a(arg: int) -> int: ...
|
||||
+
|
||||
+
|
||||
@overload
|
||||
def a(arg: str) -> str: ...
|
||||
+
|
||||
+
|
||||
@overload
|
||||
def a(arg: object) -> NoReturn: ...
|
||||
+
|
||||
+
|
||||
def a(arg: Union[int, str, object]) -> Union[int, str]:
|
||||
if not isinstance(arg, (int, str)):
|
||||
raise TypeError
|
||||
@@ -24,10 +32,13 @@
|
||||
def foo(self, a: int) -> int: ...
|
||||
|
||||
def bar(self, b: str) -> str: ...
|
||||
+
|
||||
def baz(self, c: bytes) -> str: ...
|
||||
|
||||
|
||||
def dummy_two(): ...
|
||||
+
|
||||
+
|
||||
@dummy
|
||||
def dummy_three(): ...
|
||||
|
||||
@@ -41,6 +52,8 @@
|
||||
|
||||
@overload
|
||||
def b(arg: str) -> str: ...
|
||||
+
|
||||
+
|
||||
@overload
|
||||
def b(arg: object) -> NoReturn: ...
|
||||
|
||||
@@ -54,8 +67,6 @@
|
||||
def has_comment(): ... # still a dummy
|
||||
|
||||
|
||||
-if some_condition:
|
||||
- ...
|
||||
+if some_condition: ...
|
||||
|
||||
-if already_dummy:
|
||||
- ...
|
||||
+if already_dummy: ...
|
||||
```
|
||||
|
||||
## Ruff Output
|
||||
|
||||
```python
|
||||
from typing import NoReturn, Protocol, Union, overload
|
||||
|
||||
|
||||
class Empty: ...
|
||||
|
||||
|
||||
def dummy(a): ...
|
||||
|
||||
|
||||
async def other(b): ...
|
||||
|
||||
|
||||
@overload
|
||||
def a(arg: int) -> int: ...
|
||||
|
||||
|
||||
@overload
|
||||
def a(arg: str) -> str: ...
|
||||
|
||||
|
||||
@overload
|
||||
def a(arg: object) -> NoReturn: ...
|
||||
|
||||
|
||||
def a(arg: Union[int, str, object]) -> Union[int, str]:
|
||||
if not isinstance(arg, (int, str)):
|
||||
raise TypeError
|
||||
return arg
|
||||
|
||||
|
||||
class Proto(Protocol):
|
||||
def foo(self, a: int) -> int: ...
|
||||
|
||||
def bar(self, b: str) -> str: ...
|
||||
|
||||
def baz(self, c: bytes) -> str: ...
|
||||
|
||||
|
||||
def dummy_two(): ...
|
||||
|
||||
|
||||
@dummy
|
||||
def dummy_three(): ...
|
||||
|
||||
|
||||
def dummy_four(): ...
|
||||
|
||||
|
||||
@overload
|
||||
def b(arg: int) -> int: ...
|
||||
|
||||
|
||||
@overload
|
||||
def b(arg: str) -> str: ...
|
||||
|
||||
|
||||
@overload
|
||||
def b(arg: object) -> NoReturn: ...
|
||||
|
||||
|
||||
def b(arg: Union[int, str, object]) -> Union[int, str]:
|
||||
if not isinstance(arg, (int, str)):
|
||||
raise TypeError
|
||||
return arg
|
||||
|
||||
|
||||
def has_comment(): ... # still a dummy
|
||||
|
||||
|
||||
if some_condition: ...
|
||||
|
||||
if already_dummy: ...
|
||||
```
|
||||
|
||||
## Black Output
|
||||
|
||||
```python
|
||||
from typing import NoReturn, Protocol, Union, overload
|
||||
|
||||
|
||||
class Empty: ...
|
||||
|
||||
|
||||
def dummy(a): ...
|
||||
async def other(b): ...
|
||||
|
||||
|
||||
@overload
|
||||
def a(arg: int) -> int: ...
|
||||
@overload
|
||||
def a(arg: str) -> str: ...
|
||||
@overload
|
||||
def a(arg: object) -> NoReturn: ...
|
||||
def a(arg: Union[int, str, object]) -> Union[int, str]:
|
||||
if not isinstance(arg, (int, str)):
|
||||
raise TypeError
|
||||
return arg
|
||||
|
||||
|
||||
class Proto(Protocol):
|
||||
def foo(self, a: int) -> int: ...
|
||||
|
||||
def bar(self, b: str) -> str: ...
|
||||
def baz(self, c: bytes) -> str: ...
|
||||
|
||||
|
||||
def dummy_two(): ...
|
||||
@dummy
|
||||
def dummy_three(): ...
|
||||
|
||||
|
||||
def dummy_four(): ...
|
||||
|
||||
|
||||
@overload
|
||||
def b(arg: int) -> int: ...
|
||||
|
||||
|
||||
@overload
|
||||
def b(arg: str) -> str: ...
|
||||
@overload
|
||||
def b(arg: object) -> NoReturn: ...
|
||||
|
||||
|
||||
def b(arg: Union[int, str, object]) -> Union[int, str]:
|
||||
if not isinstance(arg, (int, str)):
|
||||
raise TypeError
|
||||
return arg
|
||||
|
||||
|
||||
def has_comment(): ... # still a dummy
|
||||
|
||||
|
||||
if some_condition:
|
||||
...
|
||||
|
||||
if already_dummy:
|
||||
...
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -259,7 +259,27 @@ if True:
|
|||
# empty line(s) at the end of the file due to nested function
|
||||
if True:
|
||||
def nested_trailing_function():
|
||||
pass```
|
||||
pass
|
||||
|
||||
|
||||
def overload1(): ... # trailing comment
|
||||
def overload1(a: int): ...
|
||||
|
||||
def overload2(): ... # trailing comment
|
||||
|
||||
def overload2(a: int): ...
|
||||
|
||||
def overload3():
|
||||
...
|
||||
# trailing comment
|
||||
def overload3(a: int): ...
|
||||
|
||||
def overload4():
|
||||
...
|
||||
# trailing comment
|
||||
|
||||
def overload4(a: int): ...
|
||||
```
|
||||
|
||||
## Output
|
||||
```python
|
||||
|
|
@ -546,6 +566,40 @@ if True:
|
|||
|
||||
def nested_trailing_function():
|
||||
pass
|
||||
|
||||
|
||||
def overload1():
|
||||
... # trailing comment
|
||||
|
||||
|
||||
def overload1(a: int):
|
||||
...
|
||||
|
||||
|
||||
def overload2():
|
||||
... # trailing comment
|
||||
|
||||
|
||||
def overload2(a: int):
|
||||
...
|
||||
|
||||
|
||||
def overload3():
|
||||
...
|
||||
# trailing comment
|
||||
|
||||
|
||||
def overload3(a: int):
|
||||
...
|
||||
|
||||
|
||||
def overload4():
|
||||
...
|
||||
# trailing comment
|
||||
|
||||
|
||||
def overload4(a: int):
|
||||
...
|
||||
```
|
||||
|
||||
|
||||
|
|
@ -569,6 +623,48 @@ if True:
|
|||
|
||||
|
||||
def fakehttp():
|
||||
@@ -283,20 +281,14 @@
|
||||
pass
|
||||
|
||||
|
||||
-def overload1():
|
||||
- ... # trailing comment
|
||||
+def overload1(): ... # trailing comment
|
||||
+def overload1(a: int): ...
|
||||
|
||||
|
||||
-def overload1(a: int):
|
||||
- ...
|
||||
+def overload2(): ... # trailing comment
|
||||
|
||||
|
||||
-def overload2():
|
||||
- ... # trailing comment
|
||||
-
|
||||
-
|
||||
-def overload2(a: int):
|
||||
- ...
|
||||
+def overload2(a: int): ...
|
||||
|
||||
|
||||
def overload3():
|
||||
@@ -304,8 +296,7 @@
|
||||
# trailing comment
|
||||
|
||||
|
||||
-def overload3(a: int):
|
||||
- ...
|
||||
+def overload3(a: int): ...
|
||||
|
||||
|
||||
def overload4():
|
||||
@@ -313,5 +304,4 @@
|
||||
# trailing comment
|
||||
|
||||
|
||||
-def overload4(a: int):
|
||||
- ...
|
||||
+def overload4(a: int): ...
|
||||
```
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -150,21 +150,23 @@ def quuz():
|
|||
|
||||
|
||||
class Baz(Qux):
|
||||
@@ -49,12 +44,10 @@
|
||||
@@ -49,14 +44,8 @@
|
||||
pass
|
||||
|
||||
|
||||
-def bar():
|
||||
- ...
|
||||
+def bar(): ...
|
||||
|
||||
|
||||
-
|
||||
-
|
||||
-def baz():
|
||||
- ...
|
||||
-
|
||||
-
|
||||
+def bar(): ...
|
||||
+def baz(): ...
|
||||
|
||||
|
||||
def quux():
|
||||
"""Some docstring."""
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue