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

Format delete statement #5169

Merged
merged 21 commits into from
Jul 11, 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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
x = 1
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa = 1
a, b, c, d = 1, 2, 3, 4

del a, b, c, d
del a, b, c, d # Trailing

del a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a
del a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a # Trailing

del (
a,
a
)

del (
# Dangling comment
)

# Delete something
del x # Deleted something
# Done deleting

# Delete something
del (
# Deleting something
x # Deleted something
# Finishing deletes
) # Completed
# Done deleting

# Delete something
del (
# Deleting something
x # Deleted something
# Finishing deletes
) # Completed
# Done deleting

# Delete something
del (
# Deleting something
x, # Deleted something
# Finishing deletes
) # Completed
# Done deleting

# Delete something
del (
# Deleting something
x # Deleted something
# Finishing deletes
# Dangling comment
) # Completed
# Done deleting

# NOTE: This shouldn't format. See https://github.com/astral-sh/ruff/issues/5630.
# Delete something
del x, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, b, c, d # Delete these
# Ready to delete

# Delete something
del (
x,
# Deleting this
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,
b,
c,
d,
# Deleted
) # Completed
# Done
42 changes: 39 additions & 3 deletions crates/ruff_python_formatter/src/statement/stmt_delete.rs
Original file line number Diff line number Diff line change
@@ -1,12 +1,48 @@
use crate::{not_yet_implemented, FormatNodeRule, PyFormatter};
use ruff_formatter::{write, Buffer, FormatResult};
use crate::builders::{optional_parentheses, PyFormatterExtensions};
use crate::comments::dangling_node_comments;
use crate::expression::parentheses::Parenthesize;
use crate::{AsFormat, FormatNodeRule, PyFormatter};
use ruff_formatter::prelude::{block_indent, format_with, space, text};
use ruff_formatter::{write, Buffer, Format, FormatResult};
use rustpython_parser::ast::StmtDelete;

#[derive(Default)]
pub struct FormatStmtDelete;

impl FormatNodeRule<StmtDelete> for FormatStmtDelete {
fn fmt_fields(&self, item: &StmtDelete, f: &mut PyFormatter) -> FormatResult<()> {
write!(f, [not_yet_implemented(item)])
let StmtDelete { range: _, targets } = item;

write!(f, [text("del"), space()])?;

match targets.as_slice() {
[] => {
write!(
f,
[
// Handle special case of delete statements without targets.
// ```
// del (
// # Dangling comment
// )
&text("("),
block_indent(&dangling_node_comments(item)),
&text(")"),
]
)
}
[single] => {
write!(f, [single.format().with_options(Parenthesize::IfBreaks)])
}
targets => {
let item = format_with(|f| f.join_comma_separated().nodes(targets.iter()).finish());
optional_parentheses(&item).fmt(f)
}
}
}

fn fmt_dangling_comments(&self, _node: &StmtDelete, _f: &mut PyFormatter) -> FormatResult<()> {
// Handled in `fmt_fields`
Ok(())
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
---
source: crates/ruff_python_formatter/tests/fixtures.rs
input_file: crates/ruff_python_formatter/resources/test/fixtures/ruff/statement/delete.py
---
## Input
```py
x = 1
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa = 1
a, b, c, d = 1, 2, 3, 4

del a, b, c, d
del a, b, c, d # Trailing

del a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a
del a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a, a # Trailing

del (
a,
a
)

del (
# Dangling comment
)

# Delete something
del x # Deleted something
# Done deleting

# Delete something
del (
# Deleting something
x # Deleted something
# Finishing deletes
) # Completed
# Done deleting

# Delete something
del (
# Deleting something
x # Deleted something
# Finishing deletes
) # Completed
# Done deleting

# Delete something
del (
# Deleting something
x, # Deleted something
# Finishing deletes
) # Completed
# Done deleting

# Delete something
del (
# Deleting something
x # Deleted something
# Finishing deletes
# Dangling comment
) # Completed
# Done deleting

# NOTE: This shouldn't format. See https://github.com/astral-sh/ruff/issues/5630.
# Delete something
del x, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, b, c, d # Delete these
# Ready to delete

# Delete something
del (
x,
# Deleting this
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,
b,
c,
d,
# Deleted
) # Completed
# Done
```

## Output
```py
x = 1
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa = 1
a, b, c, d = 1, 2, 3, 4

del a, b, c, d
del a, b, c, d # Trailing

del (
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
)
del (
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
a,
) # Trailing

del (a, a)

del (
# Dangling comment
)

# Delete something
del x # Deleted something
# Done deleting

# Delete something
del (
# Deleting something
x # Deleted something
# Finishing deletes
) # Completed
# Done deleting

# Delete something
del (
# Deleting something
x # Deleted something
# Finishing deletes
) # Completed
# Done deleting

# Delete something
del (
# Deleting something
x, # Deleted something
# Finishing deletes
) # Completed
# Done deleting

# Delete something
del (
# Deleting something
x # Deleted something
# Finishing deletes
# Dangling comment
) # Completed
# Done deleting

# NOTE: This shouldn't format. See https://github.com/astral-sh/ruff/issues/5630.
# Delete something
del x, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa, b, c, d # Delete these
# Ready to delete

# Delete something
del (
x,
# Deleting this
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,
b,
c,
d,
# Deleted
) # Completed
# Done
```