Make Parameters an optional field on ExprLambda (#6669)

## Summary

If a lambda doesn't contain any parameters, or any parameter _tokens_
(like `*`), we can use `None` for the parameters. This feels like a
better representation to me, since, e.g., what should the `TextRange` be
for a non-existent set of parameters? It also allows us to remove
several sites where we check if the `Parameters` is empty by seeing if
it contains any arguments, so semantically, we're already trying to
detect and model around this elsewhere.

Changing this also fixes a number of issues with dangling comments in
parameter-less lambdas, since those comments are now automatically
marked as dangling on the lambda. (As-is, we were also doing something
not-great whereby the lambda was responsible for formatting dangling
comments on the parameters, which has been removed.)

Closes https://github.com/astral-sh/ruff/issues/6646.

Closes https://github.com/astral-sh/ruff/issues/6647.

## Test Plan

`cargo test`
This commit is contained in:
Charlie Marsh 2023-08-18 11:34:54 -04:00 committed by GitHub
parent ea72d5feba
commit 6a5acde226
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
30 changed files with 517 additions and 412 deletions

View file

@ -874,6 +874,7 @@ where
},
) => {
// Visit the default arguments, but avoid the body, which will be deferred.
if let Some(parameters) = parameters {
for ParameterWithDefault {
default,
parameter: _,
@ -888,6 +889,7 @@ where
self.visit_expr(expr);
}
}
}
self.semantic.push_scope(ScopeKind::Lambda(lambda));
self.deferred.lambdas.push((expr, self.semantic.snapshot()));
@ -1834,7 +1836,9 @@ impl<'a> Checker<'a> {
range: _,
}) = expr
{
if let Some(parameters) = parameters {
self.visit_parameters(parameters);
}
self.visit_expr(body);
} else {
unreachable!("Expected Expr::Lambda");

View file

@ -184,7 +184,10 @@ impl<'a> Visitor<'a> for SuspiciousVariablesVisitor<'a> {
return false;
}
if parameters.includes(&loaded.id) {
if parameters
.as_ref()
.is_some_and(|parameters| parameters.includes(&loaded.id))
{
return false;
}

View file

@ -76,6 +76,8 @@ where
range: _,
}) => {
visitor::walk_expr(self, body);
if let Some(parameters) = parameters {
for ParameterWithDefault {
parameter,
default: _,
@ -89,6 +91,7 @@ where
self.names.remove(parameter.name.as_str());
}
}
}
_ => visitor::walk_expr(self, expr),
}
}

View file

@ -103,7 +103,10 @@ pub(crate) fn unnecessary_map(
return;
};
if late_binding(parameters, body) {
if parameters
.as_ref()
.is_some_and(|parameters| late_binding(parameters, body))
{
return;
}
}
@ -134,7 +137,10 @@ pub(crate) fn unnecessary_map(
return;
};
if late_binding(parameters, body) {
if parameters
.as_ref()
.is_some_and(|parameters| late_binding(parameters, body))
{
return;
}
}
@ -171,7 +177,10 @@ pub(crate) fn unnecessary_map(
return;
}
if late_binding(parameters, body) {
if parameters
.as_ref()
.is_some_and(|parameters| late_binding(parameters, body))
{
return;
}
}
@ -240,7 +249,7 @@ struct LateBindingVisitor<'a> {
/// The arguments to the current lambda.
parameters: &'a Parameters,
/// The arguments to any lambdas within the current lambda body.
lambdas: Vec<&'a Parameters>,
lambdas: Vec<Option<&'a Parameters>>,
/// Whether any names within the current lambda body are late-bound within nested lambdas.
late_bound: bool,
}
@ -261,7 +270,7 @@ impl<'a> Visitor<'a> for LateBindingVisitor<'a> {
fn visit_expr(&mut self, expr: &'a Expr) {
match expr {
Expr::Lambda(ast::ExprLambda { parameters, .. }) => {
self.lambdas.push(parameters);
self.lambdas.push(parameters.as_deref());
visitor::walk_expr(self, expr);
self.lambdas.pop();
}
@ -275,11 +284,11 @@ impl<'a> Visitor<'a> for LateBindingVisitor<'a> {
// If the name is defined in the current lambda...
if self.parameters.includes(id) {
// And isn't overridden by any nested lambdas...
if !self
.lambdas
.iter()
.any(|parameters| parameters.includes(id))
{
if !self.lambdas.iter().any(|parameters| {
parameters
.as_ref()
.is_some_and(|parameters| parameters.includes(id))
}) {
// Then it's late-bound.
self.late_bound = true;
}

View file

@ -59,12 +59,7 @@ pub(crate) fn reimplemented_list_builtin(checker: &mut Checker, expr: &ExprLambd
range: _,
} = expr;
if parameters.args.is_empty()
&& parameters.kwonlyargs.is_empty()
&& parameters.posonlyargs.is_empty()
&& parameters.vararg.is_none()
&& parameters.kwarg.is_none()
{
if parameters.is_none() {
if let Expr::List(ast::ExprList { elts, .. }) = body.as_ref() {
if elts.is_empty() {
let mut diagnostic = Diagnostic::new(ReimplementedListBuiltin, expr.range());

View file

@ -89,18 +89,19 @@ fn check_patch_call(call: &ast::ExprCall, index: usize) -> Option<Diagnostic> {
.find_argument("new", index)?
.as_lambda_expr()?;
// Walk the lambda body.
// Walk the lambda body. If the lambda uses the arguments, then it's valid.
if let Some(parameters) = parameters {
let mut visitor = LambdaBodyVisitor {
parameters,
uses_args: false,
};
visitor.visit_expr(body);
if visitor.uses_args {
None
} else {
Some(Diagnostic::new(PytestPatchWithLambda, call.func.range()))
return None;
}
}
Some(Diagnostic::new(PytestPatchWithLambda, call.func.range()))
}
/// PT008

View file

@ -436,7 +436,10 @@ pub(crate) fn unused_arguments(
}
}
}
ScopeKind::Lambda(ast::ExprLambda { parameters, .. }) => {
ScopeKind::Lambda(ast::ExprLambda {
parameters: Some(parameters),
..
}) => {
if checker.enabled(Argumentable::Lambda.rule_code()) {
function(
Argumentable::Lambda,

View file

@ -91,7 +91,7 @@ pub(crate) fn lambda_assignment(
let mut indented = String::new();
for (idx, line) in function(
id,
parameters,
parameters.as_deref(),
body,
annotation,
checker.semantic(),
@ -180,7 +180,7 @@ fn extract_types(annotation: &Expr, semantic: &SemanticModel) -> Option<(Vec<Exp
fn function(
name: &str,
parameters: &Parameters,
parameters: Option<&Parameters>,
body: &Expr,
annotation: Option<&Expr>,
semantic: &SemanticModel,
@ -190,6 +190,9 @@ fn function(
value: Some(Box::new(body.clone())),
range: TextRange::default(),
});
let parameters = parameters
.cloned()
.unwrap_or_else(|| Parameters::empty(TextRange::default()));
if let Some(annotation) = annotation {
if let Some((arg_types, return_type)) = extract_types(annotation, semantic) {
// A `lambda` expression can only have positional and positional-only
@ -228,7 +231,7 @@ fn function(
parameters: Box::new(Parameters {
posonlyargs: new_posonlyargs,
args: new_args,
..parameters.clone()
..parameters
}),
body: vec![body],
decorator_list: vec![],
@ -242,7 +245,7 @@ fn function(
let func = Stmt::FunctionDef(ast::StmtFunctionDef {
is_async: false,
name: Identifier::new(name.to_string(), TextRange::default()),
parameters: Box::new(parameters.clone()),
parameters: Box::new(parameters),
body: vec![body],
decorator_list: vec![],
returns: None,

View file

@ -542,7 +542,7 @@ pub struct ExprUnaryOp<'a> {
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct ExprLambda<'a> {
parameters: ComparableParameters<'a>,
parameters: Option<ComparableParameters<'a>>,
body: Box<ComparableExpr<'a>>,
}
@ -773,7 +773,7 @@ impl<'a> From<&'a ast::Expr> for ComparableExpr<'a> {
body,
range: _,
}) => Self::Lambda(ExprLambda {
parameters: (parameters.as_ref()).into(),
parameters: parameters.as_ref().map(Into::into),
body: body.into(),
}),
ast::Expr::IfExp(ast::ExprIfExp {

View file

@ -2038,7 +2038,9 @@ impl AstNode for ast::ExprLambda {
range: _,
} = self;
if let Some(parameters) = parameters {
visitor.visit_parameters(parameters);
}
visitor.visit_expr(body);
}
}

View file

@ -632,7 +632,7 @@ impl From<ExprUnaryOp> for Expr {
#[derive(Clone, Debug, PartialEq)]
pub struct ExprLambda {
pub range: TextRange,
pub parameters: Box<Parameters>,
pub parameters: Option<Box<Parameters>>,
pub body: Box<Expr>,
}

View file

@ -354,7 +354,9 @@ pub fn walk_expr<'a, V: Visitor<'a> + ?Sized>(visitor: &mut V, expr: &'a Expr) {
body,
range: _,
}) => {
if let Some(parameters) = parameters {
visitor.visit_parameters(parameters);
}
visitor.visit_expr(body);
}
Expr::IfExp(ast::ExprIfExp {

View file

@ -878,9 +878,11 @@ impl<'a> Generator<'a> {
range: _,
}) => {
group_if!(precedence::LAMBDA, {
let npos = parameters.args.len() + parameters.posonlyargs.len();
self.p(if npos > 0 { "lambda " } else { "lambda" });
self.p("lambda");
if let Some(parameters) = parameters {
self.p(" ");
self.unparse_parameters(parameters);
}
self.p(": ");
self.unparse_expr(body, precedence::LAMBDA);
});

View file

@ -56,12 +56,16 @@ lambda x: lambda y: lambda z: (
z) # Trailing
# Trailing
a = (
lambda # Dangling
: 1
)
a = (
lambda x # Dangling
, y: 1
)
# Regression test: lambda empty arguments ranges were too long, leading to unstable
# formatting
(lambda:(#
@ -93,3 +97,24 @@ lambda a, *args, b, **kwds,: 0
lambda a, *, b, **kwds,: 0
lambda a, /: a
lambda a, /, c: a
# Dangling comments without parameters.
(
lambda
: # 3
None
)
(
lambda
# 3
: None
)
(
lambda # 1
# 2
: # 3
# 4
None # 5
)

View file

@ -162,9 +162,14 @@ fn handle_enclosed_comment<'a>(
locator: &Locator,
) -> CommentPlacement<'a> {
match comment.enclosing_node() {
AnyNodeRef::Parameters(arguments) => {
handle_parameters_separator_comment(comment, arguments, locator)
.or_else(|comment| handle_bracketed_end_of_line_comment(comment, locator))
AnyNodeRef::Parameters(parameters) => {
handle_parameters_separator_comment(comment, parameters, locator).or_else(|comment| {
if are_parameters_parenthesized(parameters, locator.contents()) {
handle_bracketed_end_of_line_comment(comment, locator)
} else {
CommentPlacement::Default(comment)
}
})
}
AnyNodeRef::Arguments(_) | AnyNodeRef::TypeParams(_) => {
handle_bracketed_end_of_line_comment(comment, locator)
@ -1544,6 +1549,13 @@ fn is_first_statement_in_alternate_body(statement: AnyNodeRef, has_body: AnyNode
}
}
/// Returns `true` if the parameters are parenthesized (as in a function definition), or `false` if
/// not (as in a lambda).
fn are_parameters_parenthesized(parameters: &Parameters, contents: &str) -> bool {
// A lambda never has parentheses around its parameters, but a function definition always does.
contents[parameters.range()].starts_with('(')
}
/// Counts the number of empty lines in `contents`.
fn max_empty_lines(contents: &str) -> u32 {
let mut newlines = 0u32;

View file

@ -1,13 +1,14 @@
use crate::comments::{dangling_node_comments, SourceComment};
use ruff_formatter::prelude::{space, text};
use ruff_formatter::{write, Buffer, FormatResult};
use ruff_python_ast::node::AnyNodeRef;
use ruff_python_ast::ExprLambda;
use crate::comments::{dangling_comments, SourceComment};
use crate::context::PyFormatContext;
use crate::expression::parentheses::{NeedsParentheses, OptionalParentheses};
use crate::other::parameters::ParametersParentheses;
use crate::AsFormat;
use crate::{FormatNodeRule, PyFormatter};
use ruff_formatter::prelude::{space, text};
use ruff_formatter::{write, Buffer, FormatResult};
use ruff_python_ast::node::AnyNodeRef;
use ruff_python_ast::ExprLambda;
#[derive(Default)]
pub struct FormatExprLambda;
@ -20,13 +21,12 @@ impl FormatNodeRule<ExprLambda> for FormatExprLambda {
body,
} = item;
let comments = f.context().comments().clone();
let dangling = comments.dangling(item);
write!(f, [text("lambda")])?;
if !parameters.args.is_empty()
|| !parameters.posonlyargs.is_empty()
|| parameters.vararg.is_some()
|| parameters.kwarg.is_some()
{
if let Some(parameters) = parameters {
write!(
f,
[
@ -38,21 +38,15 @@ impl FormatNodeRule<ExprLambda> for FormatExprLambda {
)?;
}
write!(
f,
[
text(":"),
space(),
body.format(),
// It's possible for some `Arguments` of `lambda`s to be assigned dangling comments.
//
// a = (
// lambda # Dangling
// : 1
// )
dangling_node_comments(parameters.as_ref())
]
)
write!(f, [text(":")])?;
if dangling.is_empty() {
write!(f, [space()])?;
} else {
write!(f, [dangling_comments(dangling)])?;
}
write!(f, [body.format()])
}
fn fmt_dangling_comments(

View file

@ -7,8 +7,8 @@ use ruff_python_trivia::{SimpleToken, SimpleTokenKind, SimpleTokenizer};
use ruff_text_size::{TextRange, TextSize};
use crate::comments::{
dangling_open_parenthesis_comments, leading_comments, leading_node_comments, trailing_comments,
CommentLinePosition, SourceComment,
dangling_comments, dangling_open_parenthesis_comments, leading_comments, leading_node_comments,
trailing_comments, CommentLinePosition, SourceComment,
};
use crate::context::{NodeLevel, WithNodeLevel};
use crate::expression::parentheses::empty_parenthesized;
@ -242,7 +242,7 @@ impl FormatNodeRule<Parameters> for FormatParameters {
+ usize::from(kwarg.is_some());
if self.parentheses == ParametersParentheses::Never {
write!(f, [group(&format_inner)])
write!(f, [group(&format_inner), dangling_comments(dangling)])
} else if num_parameters == 0 {
// No parameters, format any dangling comments between `()`
write!(f, [empty_parenthesized("(", dangling, ")")])

View file

@ -62,12 +62,16 @@ lambda x: lambda y: lambda z: (
z) # Trailing
# Trailing
a = (
lambda # Dangling
: 1
)
a = (
lambda x # Dangling
, y: 1
)
# Regression test: lambda empty arguments ranges were too long, leading to unstable
# formatting
(lambda:(#
@ -99,6 +103,27 @@ lambda a, *args, b, **kwds,: 0
lambda a, *, b, **kwds,: 0
lambda a, /: a
lambda a, /, c: a
# Dangling comments without parameters.
(
lambda
: # 3
None
)
(
lambda
# 3
: None
)
(
lambda # 1
# 2
: # 3
# 4
None # 5
)
```
## Output
@ -159,9 +184,14 @@ lambda x: lambda y: lambda z: (
) # Trailing
# Trailing
a = (
lambda: # Dangling
1
)
a = (
lambda: 1 # Dangling
lambda x, # Dangling
y: 1
)
# Regression test: lambda empty arguments ranges were too long, leading to unstable
@ -188,7 +218,7 @@ lambda **kwds,: 0
lambda a, *args,: 0
lambda a, **kwds,: 0
lambda *args, b,: 0
lambda: 0
lambda *, b,: 0
lambda *args, **kwds,: 0
lambda a, *args, b,: 0
lambda a, *, b,: 0
@ -199,6 +229,25 @@ lambda a, *args, b, **kwds,: 0
lambda a, *, b, **kwds,: 0
lambda a, /: a
lambda a, /, c: a
# Dangling comments without parameters.
(
lambda: # 3
None
)
(
lambda: # 3
None
)
(
lambda: # 1
# 2
# 3
# 4
None # 5
)
```

View file

@ -1354,14 +1354,12 @@ NamedExpression: ast::Expr = {
};
LambdaDef: ast::Expr = {
<location:@L> "lambda" <location_args:@L> <p:ParameterList<UntypedParameter, StarUntypedParameter, StarUntypedParameter>?> <end_location_args:@R> ":" <body:Test<"all">> <end_location:@R> =>? {
p.as_ref().map(validate_arguments).transpose()?;
let p = p
.unwrap_or_else(|| ast::Parameters::empty((location_args..end_location_args).into()));
<location:@L> "lambda" <location_args:@L> <parameters:ParameterList<UntypedParameter, StarUntypedParameter, StarUntypedParameter>?> <end_location_args:@R> ":" <body:Test<"all">> <end_location:@R> =>? {
parameters.as_ref().map(validate_arguments).transpose()?;
Ok(ast::Expr::Lambda(
ast::ExprLambda {
parameters: Box::new(p),
parameters: parameters.map(Box::new),
body: Box::new(body),
range: (location..end_location).into()
}

View file

@ -1,5 +1,5 @@
// auto-generated: "lalrpop 0.20.0"
// sha3: e2b75c2709648429269934006c032842f6800678baccab09dedfb746463c30b4
// sha3: 6ec03d3255ad27917601bff9ad0b1df5f8702124139879a78e7dca689ca1b113
use num_bigint::BigInt;
use ruff_text_size::TextSize;
use ruff_python_ast::{self as ast, Ranged, IpyEscapeKind};
@ -35817,7 +35817,7 @@ fn __action184<
(_, location, _): (TextSize, TextSize, TextSize),
(_, _, _): (TextSize, token::Tok, TextSize),
(_, location_args, _): (TextSize, TextSize, TextSize),
(_, p, _): (TextSize, core::option::Option<ast::Parameters>, TextSize),
(_, parameters, _): (TextSize, core::option::Option<ast::Parameters>, TextSize),
(_, end_location_args, _): (TextSize, TextSize, TextSize),
(_, _, _): (TextSize, token::Tok, TextSize),
(_, body, _): (TextSize, ast::Expr, TextSize),
@ -35825,13 +35825,11 @@ fn __action184<
) -> Result<ast::Expr,__lalrpop_util::ParseError<TextSize,token::Tok,LexicalError>>
{
{
p.as_ref().map(validate_arguments).transpose()?;
let p = p
.unwrap_or_else(|| ast::Parameters::empty((location_args..end_location_args).into()));
parameters.as_ref().map(validate_arguments).transpose()?;
Ok(ast::Expr::Lambda(
ast::ExprLambda {
parameters: Box::new(p),
parameters: parameters.map(Box::new),
body: Box::new(body),
range: (location..end_location).into()
}

View file

@ -10,7 +10,8 @@ Ok(
value: Lambda(
ExprLambda {
range: 0..20,
parameters: Parameters {
parameters: Some(
Parameters {
range: 7..17,
posonlyargs: [],
args: [],
@ -55,6 +56,7 @@ Ok(
],
kwarg: None,
},
),
body: Constant(
ExprConstant {
range: 19..20,

View file

@ -10,7 +10,8 @@ Ok(
value: Lambda(
ExprLambda {
range: 0..26,
parameters: Parameters {
parameters: Some(
Parameters {
range: 7..23,
posonlyargs: [],
args: [],
@ -75,6 +76,7 @@ Ok(
],
kwarg: None,
},
),
body: Constant(
ExprConstant {
range: 25..26,

View file

@ -10,14 +10,7 @@ Ok(
value: Lambda(
ExprLambda {
range: 0..9,
parameters: Parameters {
range: 6..6,
posonlyargs: [],
args: [],
vararg: None,
kwonlyargs: [],
kwarg: None,
},
parameters: None,
body: Constant(
ExprConstant {
range: 8..9,

View file

@ -10,7 +10,8 @@ Ok(
value: Lambda(
ExprLambda {
range: 0..26,
parameters: Parameters {
parameters: Some(
Parameters {
range: 7..23,
posonlyargs: [],
args: [
@ -80,6 +81,7 @@ Ok(
],
kwarg: None,
},
),
body: Constant(
ExprConstant {
range: 25..26,

View file

@ -10,7 +10,8 @@ Ok(
value: Lambda(
ExprLambda {
range: 0..17,
parameters: Parameters {
parameters: Some(
Parameters {
range: 7..14,
posonlyargs: [],
args: [
@ -55,6 +56,7 @@ Ok(
kwonlyargs: [],
kwarg: None,
},
),
body: Constant(
ExprConstant {
range: 16..17,

View file

@ -10,7 +10,8 @@ Ok(
value: Lambda(
ExprLambda {
range: 0..23,
parameters: Parameters {
parameters: Some(
Parameters {
range: 7..20,
posonlyargs: [],
args: [
@ -75,6 +76,7 @@ Ok(
kwonlyargs: [],
kwarg: None,
},
),
body: Constant(
ExprConstant {
range: 22..23,

View file

@ -727,7 +727,8 @@ expression: "parse_suite(source, \"<test>\").unwrap()"
value: Lambda(
ExprLambda {
range: 591..619,
parameters: Parameters {
parameters: Some(
Parameters {
range: 598..603,
posonlyargs: [],
args: [
@ -748,6 +749,7 @@ expression: "parse_suite(source, \"<test>\").unwrap()"
kwonlyargs: [],
kwarg: None,
},
),
body: Compare(
ExprCompare {
range: 605..619,

View file

@ -9,7 +9,8 @@ expression: parse_ast
value: Lambda(
ExprLambda {
range: 0..18,
parameters: Parameters {
parameters: Some(
Parameters {
range: 7..11,
posonlyargs: [],
args: [
@ -42,6 +43,7 @@ expression: parse_ast
kwonlyargs: [],
kwarg: None,
},
),
body: BinOp(
ExprBinOp {
range: 13..18,

View file

@ -9,14 +9,7 @@ expression: parse_ast
value: Lambda(
ExprLambda {
range: 0..9,
parameters: Parameters {
range: 6..6,
posonlyargs: [],
args: [],
vararg: None,
kwonlyargs: [],
kwarg: None,
},
parameters: None,
body: Constant(
ExprConstant {
range: 8..9,

View file

@ -663,7 +663,8 @@ expression: "parse_suite(source, \"<test>\").unwrap()"
value: Lambda(
ExprLambda {
range: 507..535,
parameters: Parameters {
parameters: Some(
Parameters {
range: 514..519,
posonlyargs: [],
args: [
@ -684,6 +685,7 @@ expression: "parse_suite(source, \"<test>\").unwrap()"
kwonlyargs: [],
kwarg: None,
},
),
body: Compare(
ExprCompare {
range: 521..535,