-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
[pylint] Implement unnecessary-lambda (W0108) #7953
Merged
charliermarsh
merged 4 commits into
astral-sh:main
from
clemux:plw0108_unnecessary_lambda
Oct 20, 2023
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next
Next commit
[pylint] Implement unnecessary-lambda (W0108)
- Loading branch information
commit 125378ad3a8f28d1f3b798dc907124bb51f37373
There are no files selected for viewing
55 changes: 55 additions & 0 deletions
55
crates/ruff_linter/resources/test/fixtures/pylint/unnecessary_lambda.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
_ = lambda: print() # [unnecessary-lambda] | ||
_ = lambda x, y: min(x, y) # [unnecessary-lambda] | ||
|
||
_ = lambda *args: f(*args) # [unnecessary-lambda] | ||
_ = lambda **kwargs: f(**kwargs) # [unnecessary-lambda] | ||
_ = lambda *args, **kwargs: f(*args, **kwargs) # [unnecessary-lambda] | ||
_ = lambda x, y, z, *args, **kwargs: f(x, y, z, *args, **kwargs) # [unnecessary-lambda] | ||
|
||
_ = lambda x: f(lambda x: x)(x) # [unnecessary-lambda] | ||
_ = lambda x, y: f(lambda x, y: x + y)(x, y) # [unnecessary-lambda] | ||
|
||
# default value in lambda parameters | ||
_ = lambda x=42: print(x) | ||
|
||
# lambda body is not a call | ||
_ = lambda x: x | ||
|
||
# ignore chained calls | ||
_ = lambda: chained().call() | ||
|
||
# lambda has kwargs but not the call | ||
_ = lambda **kwargs: f() | ||
|
||
# lambda has kwargs and the call has kwargs named differently | ||
_ = lambda **kwargs: f(**dict([('forty-two', 42)])) | ||
|
||
# lambda has kwargs and the call has unnamed kwargs | ||
_ = lambda **kwargs: f(**{1: 2}) | ||
|
||
# lambda has starred parameters but not the call | ||
_ = lambda *args: f() | ||
|
||
# lambda has starred parameters and the call has starargs named differently | ||
_ = lambda *args: f(*list([3, 4])) | ||
# lambda has starred parameters and the call has unnamed starargs | ||
_ = lambda *args: f(*[3, 4]) | ||
|
||
# lambda has parameters but not the call | ||
_ = lambda x: f() | ||
_ = lambda *x: f() | ||
_ = lambda **x: f() | ||
|
||
# lambda parameters and call args are not the same length | ||
_ = lambda x, y: f(x) | ||
|
||
# lambda parameters and call args are not in the same order | ||
_ = lambda x, y: f(y, x) | ||
|
||
# lambda parameters and call args are not the same | ||
_ = lambda x: f(y) | ||
|
||
# the call uses the lambda parameters | ||
_ = lambda x: x(x) | ||
_ = lambda x, y: x(x, y) | ||
_ = lambda x: z(lambda y: x + y)(x) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
use crate::checkers::ast::Checker; | ||
use crate::codes::Rule; | ||
use crate::rules::pylint; | ||
use ruff_python_ast::{self as ast, Expr}; | ||
|
||
pub(crate) fn lambda(expr: &Expr, checker: &mut Checker) { | ||
match expr { | ||
Expr::Lambda( | ||
lambda @ ast::ExprLambda { | ||
parameters: _, | ||
body: _, | ||
range: _, | ||
}, | ||
) => { | ||
if checker.enabled(Rule::UnnecessaryLambda) { | ||
pylint::rules::unnecessary_lambda(checker, lambda); | ||
} | ||
} | ||
_ => unreachable!("Expected Expr::Lambda"), | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
188 changes: 188 additions & 0 deletions
188
crates/ruff_linter/src/rules/pylint/rules/unnecessary_lambda.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,188 @@ | ||
use ruff_diagnostics::{Diagnostic, Violation}; | ||
use ruff_macros::{derive_message_formats, violation}; | ||
use ruff_python_ast::visitor::Visitor; | ||
use ruff_python_ast::{ | ||
self as ast, visitor, Arguments, Expr, ExprLambda, Parameter, ParameterWithDefault, | ||
}; | ||
use ruff_text_size::Ranged; | ||
|
||
use crate::checkers::ast::Checker; | ||
|
||
/// ## What it does | ||
/// Checks for lambdas whose body is a function call on the same arguments as the lambda itself. | ||
/// | ||
/// ## Why is this bad? | ||
/// Such lambda expressions are in all but a few cases replaceable with the function being called | ||
/// in the body of the lambda. | ||
/// | ||
/// ## Example | ||
/// ```python | ||
/// df.apply(lambda x: str(x)) | ||
/// ``` | ||
/// | ||
/// Use instead: | ||
/// ```python | ||
/// df.apply(str) | ||
/// ``` | ||
|
||
#[violation] | ||
pub struct UnnecessaryLambda; | ||
|
||
impl Violation for UnnecessaryLambda { | ||
#[derive_message_formats] | ||
fn message(&self) -> String { | ||
format!("Lambda may not be necessary") | ||
} | ||
} | ||
|
||
/// Identify all `Expr::Name` nodes in an AST. | ||
struct NameFinder<'a> { | ||
/// A map from identifier to defining expression. | ||
names: Vec<&'a ast::ExprName>, | ||
} | ||
|
||
impl<'a, 'b> Visitor<'b> for NameFinder<'a> | ||
where | ||
'b: 'a, | ||
{ | ||
fn visit_expr(&mut self, expr: &'a Expr) { | ||
if let Expr::Name(expr_name) = expr { | ||
self.names.push(expr_name); | ||
} | ||
visitor::walk_expr(self, expr); | ||
} | ||
} | ||
|
||
/// PLW0108 | ||
pub(crate) fn unnecessary_lambda(checker: &mut Checker, lambda: &ExprLambda) { | ||
let ExprLambda { | ||
parameters, | ||
body, | ||
range: _, | ||
} = lambda; | ||
// At least one the parameters of the lambda include a default value. We can't know if the | ||
// defaults provided by the lambda are the same as the defaults provided by the function | ||
// being called. | ||
if parameters.as_ref().map_or(false, |parameters| { | ||
parameters | ||
.args | ||
.iter() | ||
.any(|ParameterWithDefault { default, .. }| default.is_some()) | ||
}) { | ||
return; | ||
} | ||
if let Expr::Call(ast::ExprCall { | ||
arguments, func, .. | ||
}) = body.as_ref() | ||
{ | ||
let Arguments { args, keywords, .. } = arguments; | ||
|
||
// don't check chained calls | ||
if let Expr::Attribute(ast::ExprAttribute { value, .. }) = func.as_ref() { | ||
if let Expr::Call(_) = value.as_ref() { | ||
return; | ||
} | ||
} | ||
|
||
let call_starargs: Vec<&Expr> = args | ||
.iter() | ||
.filter_map(|arg| { | ||
if let Expr::Starred(ast::ExprStarred { value, .. }) = arg { | ||
Some(value.as_ref()) | ||
} else { | ||
None | ||
} | ||
}) | ||
.collect::<Vec<_>>(); | ||
|
||
let call_kwargs: Vec<&Expr> = keywords.iter().map(|kw| &kw.value).collect::<Vec<_>>(); | ||
|
||
let call_ordinary_args: Vec<&Expr> = args | ||
.iter() | ||
.filter(|arg| !matches!(arg, Expr::Starred(_))) | ||
.collect::<Vec<_>>(); | ||
|
||
if let Some(parameters) = parameters.as_ref() { | ||
if let Some(kwarg) = parameters.kwarg.as_ref() { | ||
if call_kwargs.is_empty() | ||
|| call_kwargs.iter().any(|kw| { | ||
if let Expr::Name(ast::ExprName { id, .. }) = kw { | ||
id.as_str() != kwarg.name.as_str() | ||
} else { | ||
true | ||
} | ||
}) | ||
{ | ||
return; | ||
} | ||
} else if !call_kwargs.is_empty() { | ||
return; | ||
} | ||
if let Some(vararg) = parameters.vararg.as_ref() { | ||
if call_starargs.is_empty() | ||
|| call_starargs.iter().any(|arg| { | ||
if let Expr::Name(ast::ExprName { id, .. }) = arg { | ||
id.as_str() != vararg.name.as_str() | ||
} else { | ||
true | ||
} | ||
}) | ||
{ | ||
return; | ||
} | ||
} else if !call_starargs.is_empty() { | ||
return; | ||
} | ||
|
||
let lambda_ordinary_params: Vec<&Parameter> = parameters | ||
.args | ||
.iter() | ||
.map(|ParameterWithDefault { parameter, .. }| parameter) | ||
.collect::<Vec<_>>(); | ||
|
||
if call_ordinary_args.len() != lambda_ordinary_params.len() { | ||
return; | ||
} | ||
|
||
let params_args = lambda_ordinary_params | ||
.iter() | ||
.zip(call_ordinary_args.iter()) | ||
.collect::<Vec<_>>(); | ||
|
||
for (param, arg) in params_args { | ||
if let Expr::Name(ast::ExprName { id, .. }) = arg { | ||
if id.as_str() != param.name.as_str() { | ||
return; | ||
} | ||
} else { | ||
return; | ||
} | ||
} | ||
} else if !call_starargs.is_empty() | ||
|| !keywords.is_empty() | ||
|| !call_ordinary_args.is_empty() | ||
{ | ||
return; | ||
} | ||
|
||
// The lambda is necessary if it uses its parameter in the function it is | ||
// calling in the lambda's body | ||
// e.g. lambda foo: (func1 if foo else func2)(foo) | ||
|
||
let mut finder = NameFinder { names: vec![] }; | ||
finder.visit_expr(func); | ||
|
||
for expr_name in finder.names { | ||
if let Some(binding_id) = checker.semantic().resolve_name(expr_name) { | ||
let binding = checker.semantic().binding(binding_id); | ||
if checker.semantic().is_current_scope(binding.scope) { | ||
return; | ||
} | ||
} | ||
} | ||
|
||
checker | ||
.diagnostics | ||
.push(Diagnostic::new(UnnecessaryLambda, lambda.range())); | ||
} | ||
} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't expect you to accept that, but I couldn't figure out how to make it work otherwise :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Going to tweak this a bit, but the idea makes sense :)