language-servers/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-09-25 03:22:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Add newline after module docstrings in preview style (#8283)

Browse source 
Change
```python
"""Test docstring"""
a = 1
```
to
```python
"""Test docstring"""

a = 1
```
in preview style, but don't touch the docstring otherwise.

Do we want to ask black to also format the content of module level
docstrings? Seems inconsistent to me that we change function and class
docstring indentation/contents but not module docstrings.

Fixes https://github.com/astral-sh/ruff/issues/7995
This commit is contained in:
konsti 2023-10-28 03:16:50 +02:00 • committed by GitHub
parent fc94857a20
commit af95cbaeef
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

39
crates/ruff_python_formatter/src/statement/suite.rs
View file

@ -19,7 +19,7 @@ use crate::verbatim::{
}; };
/// Level at which the [`Suite`] appears in the source code. /// 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 { pub enum SuiteKind {
/// Statements at the module level / top level /// Statements at the module level / top level
TopLevel, TopLevel,
@ -123,7 +123,7 @@ impl FormatRule<Suite, PyFormatContext<'_>> for FormatSuite {
let first_comments = comments.leading_dangling_trailing(first); 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 .leading
.iter() .iter()
.any(|comment| comment.is_suppression_off_comment(source)) .any(|comment| comment.is_suppression_off_comment(source))
@ -143,11 +143,24 @@ impl FormatRule<Suite, PyFormatContext<'_>> for FormatSuite {
) )
} else { } else {
first.fmt(f)?; first.fmt(f)?;
(
first.statement(), #[allow(clippy::if_same_then_else)]
matches!(first, SuiteChildStatement::Docstring(_)) let empty_line_after_docstring = if matches!(first, SuiteChildStatement::Docstring(_))
&& matches!(self.kind, SuiteKind::Class), && self.kind == SuiteKind::Class
) {
true
} else if f.options().preview().is_enabled()
&& self.kind == SuiteKind::TopLevel
&& DocstringStmt::try_from_statement(first.statement()).is_some()
{
// Only in preview mode, insert a newline after a module level docstring, but treat
// it as a docstring otherwise. See: https://github.com/psf/black/pull/3932.
true
} else {
false
};
(first.statement(), empty_line_after_docstring)
}; };
let mut preceding_comments = comments.leading_dangling_trailing(preceding); let mut preceding_comments = comments.leading_dangling_trailing(preceding);
@ -303,7 +316,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 // Enforce an empty line after a class docstring, e.g., these are both stable
// formatting: // formatting:
// ```python // ```python
@ -389,7 +402,7 @@ impl FormatRule<Suite, PyFormatContext<'_>> for FormatSuite {
preceding_comments = following_comments; preceding_comments = following_comments;
} }
after_class_docstring = false; empty_line_after_docstring = false;
} }
Ok(()) Ok(())
@ -547,9 +560,11 @@ impl<'a> DocstringStmt<'a> {
}; };
if let Expr::Constant(ExprConstant { value, .. }) = value.as_ref() { if let Expr::Constant(ExprConstant { value, .. }) = value.as_ref() {
if !value.is_implicit_concatenated() { return match value {
return Some(DocstringStmt(stmt)); Constant::Str(value) if !value.implicit_concatenated => Some(DocstringStmt(stmt)),
} Constant::Bytes(value) if !value.implicit_concatenated => Some(DocstringStmt(stmt)),
_ => None,
};
} }
None None

1
crates/ruff_python_formatter/tests/snapshots/format@preview.py.snap
View file

@ -166,6 +166,7 @@ preview = Enabled
""" """
Black's `Preview.module_docstring_newlines` Black's `Preview.module_docstring_newlines`
""" """
first_stmt_after_module_level_docstring = 1 first_stmt_after_module_level_docstring = 1