mirror of
https://github.com/astral-sh/ruff.git
synced 2025-09-27 12:29:28 +00:00
07380e0657
## Summary This does the light plumbing necessary to add a new internal option that permits setting the line width of code examples in docstrings. The plan is to add the corresponding user facing knob in #8854. Note that this effectively removes the `same-as-global` configuration style discussed [in this comment](https://github.com/astral-sh/ruff/issues/8855#issuecomment-1847230440). It replaces it with the `{integer}` configuration style only. There are a lot of commits here, but they are each tiny to make review easier because of the changes to snapshots. ## Test Plan I added a new docstring test configuration that sets `docstring-code-line-width = 60` and examined the differences.
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 = 88
|
|
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 = 88
|
|
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)
|
|
```
|
|
|
|
|
|
|