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

Preview Style: Format module level docstring #9725

Merged
merged 5 commits into from
Feb 5, 2024
Merged

Preview Style: Format module level docstring #9725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4a49976
Format module level docstring
Glyphack Jan 30, 2024
c551d8e
Mark format docstring as preview style
Glyphack Feb 1, 2024
681e893
Move module docstring test to preview
Glyphack Feb 1, 2024
f5ddfb0
Remove code block from preview test fixture
Glyphack Feb 2, 2024
b226fa5
Update snapshot tests
MichaReiser Feb 5, 2024
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
2 changes: 1 addition & 1 deletion crates/ruff_python_formatter/resources/test/fixtures/ruff/quote_style.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
'single'
'single' # this string is treated as a docstring
"double"
r'r single'
r"r double"
Expand Down
7 changes: 7 additions & 0 deletions crates/ruff_python_formatter/src/preview.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,10 @@ pub(crate) const fn is_hex_codes_in_unicode_sequences_enabled(context: &PyFormat
pub(crate) const fn is_multiline_string_handling_enabled(context: &PyFormatContext) -> bool {
context.is_preview()
}

/// Returns `true` if the [`multiline_string_handling`](https://github.com/astral-sh/ruff/pull/9725) preview style is enabled.
/// Black does not [`format docstrings`](https://github.com/psf/black/issues/3493) so we keep this
/// preview for compatibility with Black.
pub(crate) const fn is_format_module_docstring_enabled(context: &PyFormatContext) -> bool {
context.is_preview()
}
15 changes: 13 additions & 2 deletions crates/ruff_python_formatter/src/statement/suite.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ use crate::expression::expr_string_literal::ExprStringLiteralKind;
use crate::prelude::*;
use crate::preview::{
is_blank_line_after_nested_stub_class_enabled, is_dummy_implementations_enabled,
is_module_docstring_newlines_enabled, is_no_blank_line_before_class_docstring_enabled,
is_format_module_docstring_enabled, is_module_docstring_newlines_enabled,
is_no_blank_line_before_class_docstring_enabled,
};
use crate::statement::stmt_expr::FormatStmtExpr;
use crate::verbatim::{
Expand Down Expand Up @@ -140,7 +141,17 @@ impl FormatRule<Suite, PyFormatContext<'_>> for FormatSuite {
SuiteChildStatement::Other(first)
}
}
SuiteKind::TopLevel => SuiteChildStatement::Other(first),
SuiteKind::TopLevel => {
if is_format_module_docstring_enabled(f.context()) {
if let Some(docstring) = DocstringStmt::try_from_statement(first, self.kind) {
SuiteChildStatement::Docstring(docstring)
} else {
SuiteChildStatement::Other(first)
}
} else {
SuiteChildStatement::Other(first)
}
}
};

let first_comments = comments.leading_dangling_trailing(first);
Expand Down
133 changes: 0 additions & 133 deletions ...ff_python_formatter/tests/snapshots/black_compatibility@cases__module_docstring_2.py.snap
View file
Open in desktop

This file was deleted.

16 changes: 9 additions & 7 deletions crates/ruff_python_formatter/tests/snapshots/format@quote_style.py.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/quote_styl
---
## Input
```python
'single'
'single' # this string is treated as a docstring
"double"
r'r single'
r"r double"
Expand Down Expand Up @@ -73,7 +73,7 @@ source_type = Python
```

```python
'single'
'single' # this string is treated as a docstring
'double'
r'r single'
r'r double'
Expand Down Expand Up @@ -135,7 +135,8 @@ def docstring_single():
--- Stable
+++ Preview
@@ -1,4 +1,5 @@
'single'
-'single' # this string is treated as a docstring
+"single" # this string is treated as a docstring
+
'double'
r'r single'
Expand All @@ -159,7 +160,7 @@ source_type = Python
```

```python
"single"
"single" # this string is treated as a docstring
"double"
r"r single"
r"r double"
Expand Down Expand Up @@ -221,7 +222,7 @@ def docstring_single():
--- Stable
+++ Preview
@@ -1,4 +1,5 @@
"single"
"single" # this string is treated as a docstring
+
"double"
r"r single"
Expand All @@ -245,7 +246,7 @@ source_type = Python
```

```python
'single'
'single' # this string is treated as a docstring
"double"
r'r single'
r"r double"
Expand Down Expand Up @@ -307,7 +308,8 @@ def docstring_single():
--- Stable
+++ Preview
@@ -1,4 +1,5 @@
'single'
-'single' # this string is treated as a docstring
+"single" # this string is treated as a docstring
+
"double"
r'r single'
Expand Down