mirror of
https://github.com/astral-sh/ruff.git
synced 2025-09-28 21:05:08 +00:00

## Summary This PR adds dangling comment handling for `lambda` expressions. In short, comments around the `lambda` and the `:` are all considered dangling. Comments that come between the `lambda` and the `:` may be moved after the colon for simplicity (this is an odd position for a comment anyway), unless they also precede the lambda parameters, in which case they're formatted before the parameters. Closes https://github.com/astral-sh/ruff/issues/7470. ## Test Plan `cargo test` No change in similarity. Before: | project | similarity index | total files | changed files | |--------------|------------------:|------------------:|------------------:| | cpython | 0.76083 | 1789 | 1632 | | django | 0.99982 | 2760 | 37 | | transformers | 0.99957 | 2587 | 398 | | twine | 1.00000 | 33 | 0 | | typeshed | 0.99983 | 3496 | 18 | | warehouse | 0.99929 | 648 | 16 | | zulip | 0.99962 | 1437 | 22 | After: | project | similarity index | total files | changed files | |--------------|------------------:|------------------:|------------------:| | cpython | 0.76083 | 1789 | 1632 | | django | 0.99982 | 2760 | 37 | | transformers | 0.99957 | 2587 | 398 | | twine | 1.00000 | 33 | 0 | | typeshed | 0.99983 | 3496 | 18 | | warehouse | 0.99929 | 648 | 16 | | zulip | 0.99962 | 1437 | 22 |
89 lines
2.7 KiB
Rust
89 lines
2.7 KiB
Rust
use ruff_formatter::write;
|
|
use ruff_python_ast::node::AnyNodeRef;
|
|
use ruff_python_ast::ExprLambda;
|
|
use ruff_text_size::Ranged;
|
|
|
|
use crate::comments::{dangling_comments, SourceComment};
|
|
use crate::expression::parentheses::{NeedsParentheses, OptionalParentheses};
|
|
use crate::other::parameters::ParametersParentheses;
|
|
use crate::prelude::*;
|
|
|
|
#[derive(Default)]
|
|
pub struct FormatExprLambda;
|
|
|
|
impl FormatNodeRule<ExprLambda> for FormatExprLambda {
|
|
fn fmt_fields(&self, item: &ExprLambda, f: &mut PyFormatter) -> FormatResult<()> {
|
|
let ExprLambda {
|
|
range: _,
|
|
parameters,
|
|
body,
|
|
} = item;
|
|
|
|
let comments = f.context().comments().clone();
|
|
let dangling = comments.dangling(item);
|
|
|
|
write!(f, [token("lambda")])?;
|
|
|
|
if let Some(parameters) = parameters {
|
|
// In this context, a dangling comment can either be a comment between the `lambda` the
|
|
// parameters, or a comment between the parameters and the body.
|
|
let (dangling_before_parameters, dangling_after_parameters) = dangling
|
|
.split_at(dangling.partition_point(|comment| comment.end() < parameters.start()));
|
|
|
|
if dangling_before_parameters.is_empty() {
|
|
write!(f, [space()])?;
|
|
} else {
|
|
write!(f, [dangling_comments(dangling_before_parameters)])?;
|
|
}
|
|
|
|
write!(
|
|
f,
|
|
[parameters
|
|
.format()
|
|
.with_options(ParametersParentheses::Never)]
|
|
)?;
|
|
|
|
write!(f, [token(":")])?;
|
|
|
|
if dangling_after_parameters.is_empty() {
|
|
write!(f, [space()])?;
|
|
} else {
|
|
write!(f, [dangling_comments(dangling_after_parameters)])?;
|
|
}
|
|
} else {
|
|
write!(f, [token(":")])?;
|
|
|
|
// In this context, a dangling comment is a comment between the `lambda` and the body.
|
|
if dangling.is_empty() {
|
|
write!(f, [space()])?;
|
|
} else {
|
|
write!(f, [dangling_comments(dangling)])?;
|
|
}
|
|
}
|
|
|
|
write!(f, [body.format()])
|
|
}
|
|
|
|
fn fmt_dangling_comments(
|
|
&self,
|
|
_dangling_comments: &[SourceComment],
|
|
_f: &mut PyFormatter,
|
|
) -> FormatResult<()> {
|
|
// Override. Dangling comments are handled in `fmt_fields`.
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
impl NeedsParentheses for ExprLambda {
|
|
fn needs_parentheses(
|
|
&self,
|
|
parent: AnyNodeRef,
|
|
_context: &PyFormatContext,
|
|
) -> OptionalParentheses {
|
|
if parent.is_expr_await() {
|
|
OptionalParentheses::Always
|
|
} else {
|
|
OptionalParentheses::Multiline
|
|
}
|
|
}
|
|
}
|