Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement no_blank_line_before_class_docstring preview style #9154

Merged
merged 2 commits into from Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -0,0 +1,5 @@
[
{
"preview": "enabled"
}
]
@@ -0,0 +1,38 @@
class NormalDocstring:

"""This is a docstring."""


class DocstringWithComment0:
# This is a comment
"""This is a docstring."""


class DocstringWithComment1:
# This is a comment

"""This is a docstring."""


class DocstringWithComment2:

# This is a comment
"""This is a docstring."""


class DocstringWithComment3:

# This is a comment

"""This is a docstring."""


class DocstringWithComment4:


# This is a comment


"""This is a docstring."""


9 changes: 9 additions & 0 deletions crates/ruff_python_formatter/src/preview.rs
Expand Up @@ -24,3 +24,12 @@ pub(crate) const fn is_prefer_splitting_right_hand_side_of_assignments_enabled(
) -> bool {
context.is_preview()
}

/// Returns `true` if the [`no_blank_line_before_class_docstring`] preview style is enabled.
///
/// [`no_blank_line_before_class_docstring`]: https://github.com/astral-sh/ruff/issues/8888
pub(crate) const fn is_no_blank_line_before_class_docstring_enabled(
context: &PyFormatContext,
) -> bool {
context.is_preview()
}
11 changes: 11 additions & 0 deletions crates/ruff_python_formatter/src/statement/suite.rs
Expand Up @@ -11,6 +11,7 @@ use crate::comments::{
use crate::context::{NodeLevel, TopLevelStatementPosition, WithIndentLevel, WithNodeLevel};
use crate::expression::expr_string_literal::ExprStringLiteralKind;
use crate::prelude::*;
use crate::preview::is_no_blank_line_before_class_docstring_enabled;
use crate::statement::stmt_expr::FormatStmtExpr;
use crate::verbatim::{
suppressed_node, write_suppressed_statements_starting_with_leading_comment,
Expand Down Expand Up @@ -108,14 +109,24 @@ impl FormatRule<Suite, PyFormatContext<'_>> for FormatSuite {
if !comments.has_leading(first)
&& lines_before(first.start(), source) > 1
&& !source_type.is_stub()
&& !is_no_blank_line_before_class_docstring_enabled(f.context())
{
// Allow up to one empty line before a class docstring, e.g., this is
// stable formatting:
//
// ```python
// class Test:
//
// """Docstring"""
// ```
//
// But, in preview mode, we don't want to allow any empty lines before a
// class docstring, e.g., this is preview formatting:
//
// ```python
// class Test:
// """Docstring"""
// ```
empty_line().fmt(f)?;
}

Expand Down

This file was deleted.

Expand Up @@ -27,30 +27,21 @@ class UpperCaseR:
```diff
--- Black
+++ Ruff
@@ -1,4 +1,5 @@
class C:
+
r"""Raw"""


@@ -7,8 +8,9 @@
@@ -7,7 +7,7 @@


class SingleQuotes:
- r'''Raw'''

+ r"""Raw"""
+

class UpperCaseR:
R"""Raw"""
```

## Ruff Output

```python
class C:

r"""Raw"""


Expand All @@ -59,7 +50,6 @@ def f():


class SingleQuotes:

r"""Raw"""


Expand Down
@@ -0,0 +1,95 @@
---
source: crates/ruff_python_formatter/tests/fixtures.rs
input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/blank_line_before_class_docstring.py
---
## Input
```python
class NormalDocstring:

"""This is a docstring."""


class DocstringWithComment0:
# This is a comment
"""This is a docstring."""


class DocstringWithComment1:
# This is a comment

"""This is a docstring."""


class DocstringWithComment2:

# This is a comment
"""This is a docstring."""


class DocstringWithComment3:

# This is a comment

"""This is a docstring."""


class DocstringWithComment4:


# This is a comment


"""This is a docstring."""


```

## 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 = Enabled
```

```python
class NormalDocstring:
"""This is a docstring."""


class DocstringWithComment0:
# This is a comment
"""This is a docstring."""


class DocstringWithComment1:
# This is a comment

"""This is a docstring."""


class DocstringWithComment2:
# This is a comment
"""This is a docstring."""


class DocstringWithComment3:
# This is a comment

"""This is a docstring."""


class DocstringWithComment4:
# This is a comment

"""This is a docstring."""
```



Expand Up @@ -198,7 +198,6 @@ def reference_docstring_newlines():


class RemoveNewlineBeforeClassDocstring:

"""Black's `Preview.no_blank_line_before_class_docstring`"""


Expand Down