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

Flag comparison-with-itself on builtin calls #6324

Merged
merged 1 commit into from
Aug 4, 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
Expand Up @@ -19,6 +19,10 @@

foo not in foo

id(foo) == id(foo)

len(foo) == len(foo)

# Non-errors.
"foo" == "foo" # This is flagged by `comparison-of-constant` instead.

Expand All @@ -43,3 +47,11 @@
foo in bar

foo not in bar

x(foo) == y(foo)

id(foo) == id(bar)

id(foo, bar) == id(foo, bar)

id(foo, bar=1) == id(foo, bar=1)
59 changes: 53 additions & 6 deletions crates/ruff/src/rules/pylint/rules/comparison_with_itself.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
use itertools::Itertools;
use ruff_python_ast::{CmpOp, Expr, Ranged};

use ruff_diagnostics::{Diagnostic, Violation};
use ruff_macros::{derive_message_formats, violation};
use ruff_python_ast::{CmpOp, Expr, Ranged};

use crate::checkers::ast::Checker;
use crate::rules::pylint::helpers::CmpOpExt;
Expand Down Expand Up @@ -51,17 +51,64 @@ pub(crate) fn comparison_with_itself(
.tuple_windows()
.zip(ops)
{
if let (Expr::Name(left), Expr::Name(right)) = (left, right) {
if left.id == right.id {
match (left, right) {
// Ex) `foo == foo`
(Expr::Name(left_name), Expr::Name(right_name)) if left_name.id == right_name.id => {
checker.diagnostics.push(Diagnostic::new(
ComparisonWithItself {
left: left.id.to_string(),
left: checker.generator().expr(left),
op: *op,
right: right.id.to_string(),
right: checker.generator().expr(right),
},
left.range(),
left_name.range(),
));
}
// Ex) `id(foo) == id(foo)`
(Expr::Call(left_call), Expr::Call(right_call)) => {
// Both calls must take a single argument, of the same name.
if !left_call.arguments.keywords.is_empty()
|| !right_call.arguments.keywords.is_empty()
{
continue;
}
let [Expr::Name(left_arg)] = left_call.arguments.args.as_slice() else {
continue;
};
let [Expr::Name(right_right)] = right_call.arguments.args.as_slice() else {
continue;
};
if left_arg.id != right_right.id {
continue;
}

// Both calls must be to the same function.
let Expr::Name(left_func) = left_call.func.as_ref() else {
continue;
};
let Expr::Name(right_func) = right_call.func.as_ref() else {
continue;
};
if left_func.id != right_func.id {
continue;
}

// The call must be to pure function, like `id`.
if matches!(
left_func.id.as_str(),
"id" | "len" | "type" | "int" | "bool" | "str" | "repr" | "bytes"
) && checker.semantic().is_builtin(&left_func.id)
{
checker.diagnostics.push(Diagnostic::new(
ComparisonWithItself {
left: checker.generator().expr(left),
op: *op,
right: checker.generator().expr(right),
},
left_call.range(),
));
}
}
_ => {}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,27 @@ comparison_with_itself.py:20:1: PLR0124 Name compared with itself, consider repl
20 | foo not in foo
| ^^^ PLR0124
21 |
22 | # Non-errors.
22 | id(foo) == id(foo)
|

comparison_with_itself.py:22:1: PLR0124 Name compared with itself, consider replacing `id(foo) == id(foo)`
|
20 | foo not in foo
21 |
22 | id(foo) == id(foo)
| ^^^^^^^ PLR0124
23 |
24 | len(foo) == len(foo)
|

comparison_with_itself.py:24:1: PLR0124 Name compared with itself, consider replacing `len(foo) == len(foo)`
|
22 | id(foo) == id(foo)
23 |
24 | len(foo) == len(foo)
| ^^^^^^^^ PLR0124
25 |
26 | # Non-errors.
|


Loading