mirror of
https://github.com/astral-sh/ruff.git
synced 2025-08-03 02:13:08 +00:00
362 lines
7.2 KiB
Text
362 lines
7.2 KiB
Text
---
|
|
source: crates/ruff_python_formatter/tests/fixtures.rs
|
|
input_file: crates/ruff_python_formatter/resources/test/fixtures/black/simple_cases/comments.py
|
|
---
|
|
## Input
|
|
|
|
```py
|
|
#!/usr/bin/env python3
|
|
# fmt: on
|
|
# Some license here.
|
|
#
|
|
# Has many lines. Many, many lines.
|
|
# Many, many, many lines.
|
|
"""Module docstring.
|
|
|
|
Possibly also many, many lines.
|
|
"""
|
|
|
|
import os.path
|
|
import sys
|
|
|
|
import a
|
|
from b.c import X # some noqa comment
|
|
|
|
try:
|
|
import fast
|
|
except ImportError:
|
|
import slow as fast
|
|
|
|
|
|
# Some comment before a function.
|
|
y = 1
|
|
(
|
|
# some strings
|
|
y # type: ignore
|
|
)
|
|
|
|
|
|
def function(default=None):
|
|
"""Docstring comes first.
|
|
|
|
Possibly many lines.
|
|
"""
|
|
# FIXME: Some comment about why this function is crap but still in production.
|
|
import inner_imports
|
|
|
|
if inner_imports.are_evil():
|
|
# Explains why we have this if.
|
|
# In great detail indeed.
|
|
x = X()
|
|
return x.method1() # type: ignore
|
|
|
|
# This return is also commented for some reason.
|
|
return default
|
|
|
|
|
|
# Explains why we use global state.
|
|
GLOBAL_STATE = {"a": a(1), "b": a(2), "c": a(3)}
|
|
|
|
|
|
# Another comment!
|
|
# This time two lines.
|
|
|
|
|
|
class Foo:
|
|
"""Docstring for class Foo. Example from Sphinx docs."""
|
|
|
|
#: Doc comment for class attribute Foo.bar.
|
|
#: It can have multiple lines.
|
|
bar = 1
|
|
|
|
flox = 1.5 #: Doc comment for Foo.flox. One line only.
|
|
|
|
baz = 2
|
|
"""Docstring for class attribute Foo.baz."""
|
|
|
|
def __init__(self):
|
|
#: Doc comment for instance attribute qux.
|
|
self.qux = 3
|
|
|
|
self.spam = 4
|
|
"""Docstring for instance attribute spam."""
|
|
|
|
|
|
#' <h1>This is pweave!</h1>
|
|
|
|
|
|
@fast(really=True)
|
|
async def wat():
|
|
# This comment, for some reason \
|
|
# contains a trailing backslash.
|
|
async with X.open_async() as x: # Some more comments
|
|
result = await x.method1()
|
|
# Comment after ending a block.
|
|
if result:
|
|
print("A OK", file=sys.stdout)
|
|
# Comment between things.
|
|
print()
|
|
|
|
|
|
# Some closing comments.
|
|
# Maybe Vim or Emacs directives for formatting.
|
|
# Who knows.
|
|
```
|
|
|
|
## Black Differences
|
|
|
|
```diff
|
|
--- Black
|
|
+++ Ruff
|
|
@@ -9,16 +9,16 @@
|
|
Possibly also many, many lines.
|
|
"""
|
|
|
|
-import os.path
|
|
-import sys
|
|
+NOT_YET_IMPLEMENTED_StmtImport
|
|
+NOT_YET_IMPLEMENTED_StmtImport
|
|
|
|
-import a
|
|
-from b.c import X # some noqa comment
|
|
+NOT_YET_IMPLEMENTED_StmtImport
|
|
+NOT_YET_IMPLEMENTED_StmtImportFrom # some noqa comment
|
|
|
|
try:
|
|
- import fast
|
|
+ NOT_YET_IMPLEMENTED_StmtImport
|
|
except ImportError:
|
|
- import slow as fast
|
|
+ NOT_YET_IMPLEMENTED_StmtImport
|
|
|
|
|
|
# Some comment before a function.
|
|
@@ -35,7 +35,7 @@
|
|
Possibly many lines.
|
|
"""
|
|
# FIXME: Some comment about why this function is crap but still in production.
|
|
- import inner_imports
|
|
+ NOT_YET_IMPLEMENTED_StmtImport
|
|
|
|
if inner_imports.are_evil():
|
|
# Explains why we have this if.
|
|
@@ -82,8 +82,7 @@
|
|
async def wat():
|
|
# This comment, for some reason \
|
|
# contains a trailing backslash.
|
|
- async with X.open_async() as x: # Some more comments
|
|
- result = await x.method1()
|
|
+ NOT_YET_IMPLEMENTED_StmtAsyncWith # Some more comments
|
|
# Comment after ending a block.
|
|
if result:
|
|
print("A OK", file=sys.stdout)
|
|
@@ -93,4 +92,4 @@
|
|
|
|
# Some closing comments.
|
|
# Maybe Vim or Emacs directives for formatting.
|
|
-# Who knows.
|
|
\ No newline at end of file
|
|
+# Who knows.
|
|
```
|
|
|
|
## Ruff Output
|
|
|
|
```py
|
|
#!/usr/bin/env python3
|
|
# fmt: on
|
|
# Some license here.
|
|
#
|
|
# Has many lines. Many, many lines.
|
|
# Many, many, many lines.
|
|
"""Module docstring.
|
|
|
|
Possibly also many, many lines.
|
|
"""
|
|
|
|
NOT_YET_IMPLEMENTED_StmtImport
|
|
NOT_YET_IMPLEMENTED_StmtImport
|
|
|
|
NOT_YET_IMPLEMENTED_StmtImport
|
|
NOT_YET_IMPLEMENTED_StmtImportFrom # some noqa comment
|
|
|
|
try:
|
|
NOT_YET_IMPLEMENTED_StmtImport
|
|
except ImportError:
|
|
NOT_YET_IMPLEMENTED_StmtImport
|
|
|
|
|
|
# Some comment before a function.
|
|
y = 1
|
|
(
|
|
# some strings
|
|
y # type: ignore
|
|
)
|
|
|
|
|
|
def function(default=None):
|
|
"""Docstring comes first.
|
|
|
|
Possibly many lines.
|
|
"""
|
|
# FIXME: Some comment about why this function is crap but still in production.
|
|
NOT_YET_IMPLEMENTED_StmtImport
|
|
|
|
if inner_imports.are_evil():
|
|
# Explains why we have this if.
|
|
# In great detail indeed.
|
|
x = X()
|
|
return x.method1() # type: ignore
|
|
|
|
# This return is also commented for some reason.
|
|
return default
|
|
|
|
|
|
# Explains why we use global state.
|
|
GLOBAL_STATE = {"a": a(1), "b": a(2), "c": a(3)}
|
|
|
|
|
|
# Another comment!
|
|
# This time two lines.
|
|
|
|
|
|
class Foo:
|
|
"""Docstring for class Foo. Example from Sphinx docs."""
|
|
|
|
#: Doc comment for class attribute Foo.bar.
|
|
#: It can have multiple lines.
|
|
bar = 1
|
|
|
|
flox = 1.5 #: Doc comment for Foo.flox. One line only.
|
|
|
|
baz = 2
|
|
"""Docstring for class attribute Foo.baz."""
|
|
|
|
def __init__(self):
|
|
#: Doc comment for instance attribute qux.
|
|
self.qux = 3
|
|
|
|
self.spam = 4
|
|
"""Docstring for instance attribute spam."""
|
|
|
|
|
|
#' <h1>This is pweave!</h1>
|
|
|
|
|
|
@fast(really=True)
|
|
async def wat():
|
|
# This comment, for some reason \
|
|
# contains a trailing backslash.
|
|
NOT_YET_IMPLEMENTED_StmtAsyncWith # Some more comments
|
|
# Comment after ending a block.
|
|
if result:
|
|
print("A OK", file=sys.stdout)
|
|
# Comment between things.
|
|
print()
|
|
|
|
|
|
# Some closing comments.
|
|
# Maybe Vim or Emacs directives for formatting.
|
|
# Who knows.
|
|
```
|
|
|
|
## Black Output
|
|
|
|
```py
|
|
#!/usr/bin/env python3
|
|
# fmt: on
|
|
# Some license here.
|
|
#
|
|
# Has many lines. Many, many lines.
|
|
# Many, many, many lines.
|
|
"""Module docstring.
|
|
|
|
Possibly also many, many lines.
|
|
"""
|
|
|
|
import os.path
|
|
import sys
|
|
|
|
import a
|
|
from b.c import X # some noqa comment
|
|
|
|
try:
|
|
import fast
|
|
except ImportError:
|
|
import slow as fast
|
|
|
|
|
|
# Some comment before a function.
|
|
y = 1
|
|
(
|
|
# some strings
|
|
y # type: ignore
|
|
)
|
|
|
|
|
|
def function(default=None):
|
|
"""Docstring comes first.
|
|
|
|
Possibly many lines.
|
|
"""
|
|
# FIXME: Some comment about why this function is crap but still in production.
|
|
import inner_imports
|
|
|
|
if inner_imports.are_evil():
|
|
# Explains why we have this if.
|
|
# In great detail indeed.
|
|
x = X()
|
|
return x.method1() # type: ignore
|
|
|
|
# This return is also commented for some reason.
|
|
return default
|
|
|
|
|
|
# Explains why we use global state.
|
|
GLOBAL_STATE = {"a": a(1), "b": a(2), "c": a(3)}
|
|
|
|
|
|
# Another comment!
|
|
# This time two lines.
|
|
|
|
|
|
class Foo:
|
|
"""Docstring for class Foo. Example from Sphinx docs."""
|
|
|
|
#: Doc comment for class attribute Foo.bar.
|
|
#: It can have multiple lines.
|
|
bar = 1
|
|
|
|
flox = 1.5 #: Doc comment for Foo.flox. One line only.
|
|
|
|
baz = 2
|
|
"""Docstring for class attribute Foo.baz."""
|
|
|
|
def __init__(self):
|
|
#: Doc comment for instance attribute qux.
|
|
self.qux = 3
|
|
|
|
self.spam = 4
|
|
"""Docstring for instance attribute spam."""
|
|
|
|
|
|
#' <h1>This is pweave!</h1>
|
|
|
|
|
|
@fast(really=True)
|
|
async def wat():
|
|
# This comment, for some reason \
|
|
# contains a trailing backslash.
|
|
async with X.open_async() as x: # Some more comments
|
|
result = await x.method1()
|
|
# Comment after ending a block.
|
|
if result:
|
|
print("A OK", file=sys.stdout)
|
|
# Comment between things.
|
|
print()
|
|
|
|
|
|
# Some closing comments.
|
|
# Maybe Vim or Emacs directives for formatting.
|
|
# Who knows.```
|
|
|
|
|