mirror of
https://github.com/astral-sh/ruff.git
synced 2025-09-27 04:19:18 +00:00
b6fb972e6f
This PR does the plumbing to make a new formatting option,
`docstring-code-format`, available in the configuration for end users.
It is disabled by default (opt-in). It is opt-in at least initially to
reflect a conservative posture. The intent is to make it opt-out at some
point in the future.
This was split out from #8811 in order to make #8811 easier to merge.
Namely, once this is merged, docstring code snippet formatting will
become available to end users. (See comments below for how we arrived at
the name.)
Closes #7146
## Test Plan
Other than the standard test suite, I ran the formatter over the CPython
and polars projects to ensure both that the result looked sensible and
that tests still passed. At time of writing, one issue that currently
appears is that reformatting code snippets trips the long line lint:
1905886802
240 lines
5.8 KiB
Text
240 lines
5.8 KiB
Text
---
|
|
source: crates/ruff_python_formatter/tests/fixtures.rs
|
|
input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/preview.py
|
|
---
|
|
## Input
|
|
```python
|
|
"""
|
|
Black's `Preview.module_docstring_newlines`
|
|
"""
|
|
first_stmt_after_module_level_docstring = 1
|
|
|
|
|
|
class CachedRepository:
|
|
# Black's `Preview.dummy_implementations`
|
|
def get_release_info(self): ...
|
|
|
|
|
|
def raw_docstring():
|
|
|
|
r"""Black's `Preview.accept_raw_docstrings`
|
|
a
|
|
b
|
|
"""
|
|
pass
|
|
|
|
|
|
def reference_docstring_newlines():
|
|
|
|
"""A regular docstring for comparison
|
|
a
|
|
b
|
|
"""
|
|
pass
|
|
|
|
|
|
class RemoveNewlineBeforeClassDocstring:
|
|
|
|
"""Black's `Preview.no_blank_line_before_class_docstring`"""
|
|
|
|
|
|
def f():
|
|
"""Black's `Preview.prefer_splitting_right_hand_side_of_assignments`"""
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[
|
|
bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
|
|
] = cccccccc.ccccccccccccc.cccccccc
|
|
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[
|
|
bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
|
|
] = cccccccc.ccccccccccccc().cccccccc
|
|
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[
|
|
bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
|
|
] = cccccccc.ccccccccccccc(d).cccccccc
|
|
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (
|
|
cccccccc.ccccccccccccc(d).cccccccc + e
|
|
)
|
|
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (
|
|
cccccccc.ccccccccccccc.cccccccc + e
|
|
)
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (
|
|
cccccccc.ccccccccccccc.cccccccc
|
|
+ eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
|
|
)
|
|
|
|
self._cache: dict[
|
|
DependencyCacheKey, list[list[DependencyPackage]]
|
|
] = collections.defaultdict(list)
|
|
self._cached_dependencies_by_level: dict[
|
|
int, list[DependencyCacheKey]
|
|
] = collections.defaultdict(list)
|
|
```
|
|
|
|
## Outputs
|
|
### Output 1
|
|
```
|
|
indent-style = space
|
|
line-width = 88
|
|
indent-width = 4
|
|
quote-style = Double
|
|
line-ending = LineFeed
|
|
magic-trailing-comma = Respect
|
|
docstring-code = Disabled
|
|
docstring-code-line-width = "dynamic"
|
|
preview = Disabled
|
|
```
|
|
|
|
```python
|
|
"""
|
|
Black's `Preview.module_docstring_newlines`
|
|
"""
|
|
first_stmt_after_module_level_docstring = 1
|
|
|
|
|
|
class CachedRepository:
|
|
# Black's `Preview.dummy_implementations`
|
|
def get_release_info(self):
|
|
...
|
|
|
|
|
|
def raw_docstring():
|
|
r"""Black's `Preview.accept_raw_docstrings`
|
|
a
|
|
b
|
|
"""
|
|
pass
|
|
|
|
|
|
def reference_docstring_newlines():
|
|
"""A regular docstring for comparison
|
|
a
|
|
b
|
|
"""
|
|
pass
|
|
|
|
|
|
class RemoveNewlineBeforeClassDocstring:
|
|
|
|
"""Black's `Preview.no_blank_line_before_class_docstring`"""
|
|
|
|
|
|
def f():
|
|
"""Black's `Preview.prefer_splitting_right_hand_side_of_assignments`"""
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[
|
|
bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
|
|
] = cccccccc.ccccccccccccc.cccccccc
|
|
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[
|
|
bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
|
|
] = cccccccc.ccccccccccccc().cccccccc
|
|
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[
|
|
bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
|
|
] = cccccccc.ccccccccccccc(d).cccccccc
|
|
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (
|
|
cccccccc.ccccccccccccc(d).cccccccc + e
|
|
)
|
|
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (
|
|
cccccccc.ccccccccccccc.cccccccc + e
|
|
)
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (
|
|
cccccccc.ccccccccccccc.cccccccc
|
|
+ eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
|
|
)
|
|
|
|
self._cache: dict[
|
|
DependencyCacheKey, list[list[DependencyPackage]]
|
|
] = collections.defaultdict(list)
|
|
self._cached_dependencies_by_level: dict[
|
|
int, list[DependencyCacheKey]
|
|
] = collections.defaultdict(list)
|
|
```
|
|
|
|
|
|
### Output 2
|
|
```
|
|
indent-style = space
|
|
line-width = 88
|
|
indent-width = 4
|
|
quote-style = Double
|
|
line-ending = LineFeed
|
|
magic-trailing-comma = Respect
|
|
docstring-code = Disabled
|
|
docstring-code-line-width = "dynamic"
|
|
preview = Enabled
|
|
```
|
|
|
|
```python
|
|
"""
|
|
Black's `Preview.module_docstring_newlines`
|
|
"""
|
|
|
|
first_stmt_after_module_level_docstring = 1
|
|
|
|
|
|
class CachedRepository:
|
|
# Black's `Preview.dummy_implementations`
|
|
def get_release_info(self): ...
|
|
|
|
|
|
def raw_docstring():
|
|
r"""Black's `Preview.accept_raw_docstrings`
|
|
a
|
|
b
|
|
"""
|
|
pass
|
|
|
|
|
|
def reference_docstring_newlines():
|
|
"""A regular docstring for comparison
|
|
a
|
|
b
|
|
"""
|
|
pass
|
|
|
|
|
|
class RemoveNewlineBeforeClassDocstring:
|
|
|
|
"""Black's `Preview.no_blank_line_before_class_docstring`"""
|
|
|
|
|
|
def f():
|
|
"""Black's `Preview.prefer_splitting_right_hand_side_of_assignments`"""
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (
|
|
cccccccc.ccccccccccccc.cccccccc
|
|
)
|
|
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (
|
|
cccccccc.ccccccccccccc().cccccccc
|
|
)
|
|
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (
|
|
cccccccc.ccccccccccccc(d).cccccccc
|
|
)
|
|
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (
|
|
cccccccc.ccccccccccccc(d).cccccccc + e
|
|
)
|
|
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (
|
|
cccccccc.ccccccccccccc.cccccccc + e
|
|
)
|
|
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (
|
|
cccccccc.ccccccccccccc.cccccccc
|
|
+ eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
|
|
)
|
|
|
|
self._cache: dict[DependencyCacheKey, list[list[DependencyPackage]]] = (
|
|
collections.defaultdict(list)
|
|
)
|
|
self._cached_dependencies_by_level: dict[int, list[DependencyCacheKey]] = (
|
|
collections.defaultdict(list)
|
|
)
|
|
```
|
|
|
|
|
|
|