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.

Sign up for GitHub

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

Jump to bottom

Add newline after module docstrings in preview style #8283

Merged
merged 3 commits into from Oct 28, 2023
Merged

Add newline after module docstrings in preview style #8283

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
43558f5
Add newline after module docstrings in preview style
konstin Oct 27, 2023
ba98750
Copy over docstring fix
charliermarsh Oct 28, 2023
f0028ee
Add clippy ignore
charliermarsh Oct 28, 2023
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
30 changes: 21 additions & 9 deletions crates/ruff_python_formatter/src/statement/suite.rs
View file
Open in desktop
Expand Up @@ -19,7 +19,7 @@ use crate::verbatim::{
};

/// Level at which the [`Suite`] appears in the source code.
#[derive(Copy, Clone, Debug, Default)]
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub enum SuiteKind {
/// Statements at the module level / top level
TopLevel,
Expand Down Expand Up @@ -123,7 +123,7 @@ impl FormatRule<Suite, PyFormatContext<'_>> for FormatSuite {

let first_comments = comments.leading_dangling_trailing(first);

let (mut preceding, mut after_class_docstring) = if first_comments
let (mut preceding, mut empty_line_after_docstring) = if first_comments
.leading
.iter()
.any(|comment| comment.is_suppression_off_comment(source))
Expand All @@ -143,11 +143,23 @@ impl FormatRule<Suite, PyFormatContext<'_>> for FormatSuite {
)
} else {
first.fmt(f)?;
(
first.statement(),
matches!(first, SuiteChildStatement::Docstring(_))
&& matches!(self.kind, SuiteKind::Class),
)
let empty_line_after_docstring = if matches!(first, SuiteChildStatement::Docstring(_))
&& self.kind == SuiteKind::Class
{
true
} else if f.options().preview().is_enabled()
&& DocstringStmt::try_from_statement(first.statement()).is_some()
&& self.kind == SuiteKind::TopLevel
{
// Only in preview mode, insert a newline after a module level docstring, but treat
// it as a docstring otherwise
// https://github.com/psf/black/pull/3932
// https://github.com/astral-sh/ruff/issues/7995
true
} else {
false
};
(first.statement(), empty_line_after_docstring)
};

let mut preceding_comments = comments.leading_dangling_trailing(preceding);
Expand Down Expand Up @@ -303,7 +315,7 @@ impl FormatRule<Suite, PyFormatContext<'_>> for FormatSuite {
}
},
}
} else if after_class_docstring {
} else if empty_line_after_docstring {
// Enforce an empty line after a class docstring, e.g., these are both stable
// formatting:
// ```python
Expand Down Expand Up @@ -389,7 +401,7 @@ impl FormatRule<Suite, PyFormatContext<'_>> for FormatSuite {
preceding_comments = following_comments;
}

after_class_docstring = false;
empty_line_after_docstring = false;
}

Ok(())
Expand Down
13 changes: 13 additions & 0 deletions crates/ruff_python_formatter/tests/snapshots/format@expression__number.py.snap
View file
Open in desktop
Expand Up @@ -25,4 +25,17 @@ input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/expression
```


## Preview changes
```diff
--- Stable
+++ Preview
@@ -1,4 +1,5 @@
0.1
+
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should also be fixed by #8216

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Trying to understand, why / how is this happening?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see, there's a bug in try_from_docstring that's fixed in that PR. I'm just gonna copy that fix in here -- seems odd to commit without it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my plan was to merge the other one first and then rebase, but this does too

1.0
1e1
1e-1
```



1 change: 1 addition & 0 deletions crates/ruff_python_formatter/tests/snapshots/format@preview.py.snap
View file
Open in desktop
Expand Up @@ -166,6 +166,7 @@ preview = Enabled
"""
Black's `Preview.module_docstring_newlines`
"""

first_stmt_after_module_level_docstring = 1


Expand Down