[pylint] Implement nan-comparison (PLW0117)

crates/ruff_linter/resources/test/fixtures/pylint/nan_comparison.py

@@ -0,0 +1,76 @@
+import math
+from math import nan as bad_val
+import numpy as np
+from numpy import nan as npy_nan
+
+
+x = float('nan')
+y = np.NaN
+
+# PLW0117
+if x == float('nan'):
+    pass
+
+# PLW0117
+if x == float('NaN'):
+    pass
+
+# PLW0117
+if x == float('NAN'):
+    pass
+
+# PLW0117
+if x == float('Nan'):
+    pass
+
+# PLW0117
+if x == math.nan:
+    pass
+
+# PLW0117
+if x == bad_val:
+    pass
+
+# PLW0117
+if y == np.NaN:
+    pass
+
+# PLW0117
+if y == np.NAN:
+    pass
+
+# PLW0117
+if y == np.nan:
+    pass
+
+# PLW0117
+if y == npy_nan:
+    pass
+
+# Ok
+if math.isnan(x):
+    pass
+
+# Ok
+if np.isnan(y):
+    pass
+
+# Ok
+if x == 0:
+    pass
+
+# Ok
+if x == float('32'):
+    pass
+
+# Ok
+if x == float(42):
+    pass
+
+# Ok
+if y == np.inf:
+    pass
+
+# Ok
+if x == 'nan':
+    pass

crates/ruff_linter/src/checkers/ast/analyze/expression.rs

@@ -1283,6 +1283,9 @@ pub(crate) fn expression(expr: &Expr, checker: &mut Checker) {
             if checker.enabled(Rule::MagicValueComparison) {
                 pylint::rules::magic_value_comparison(checker, left, comparators);
             }
+            if checker.enabled(Rule::NanComparison) {
+                pylint::rules::nan_comparison(checker, left, comparators);
+            }
             if checker.enabled(Rule::InDictKeys) {
                 flake8_simplify::rules::key_in_dict_compare(checker, compare);
             }

crates/ruff_linter/src/codes.rs

@@ -291,6 +291,7 @@ pub fn code_to_rule(linter: Linter, code: &str) -> Option<(RuleGroup, Rule)> {
         #[allow(deprecated)]
         (Pylint, "R6301") => (RuleGroup::Nursery, rules::pylint::rules::NoSelfUse),
         (Pylint, "W0108") => (RuleGroup::Preview, rules::pylint::rules::UnnecessaryLambda),
+        (Pylint, "W0117") => (RuleGroup::Preview, rules::pylint::rules::NanComparison),
         (Pylint, "W0120") => (RuleGroup::Stable, rules::pylint::rules::UselessElseOnLoop),
         (Pylint, "W0127") => (RuleGroup::Stable, rules::pylint::rules::SelfAssigningVariable),
         (Pylint, "W0129") => (RuleGroup::Stable, rules::pylint::rules::AssertOnStringLiteral),

crates/ruff_linter/src/rules/pylint/mod.rs

@@ -181,6 +181,7 @@ mod tests {
         Rule::UselessExceptionStatement,
         Path::new("useless_exception_statement.py")
     )]
+    #[test_case(Rule::NanComparison, Path::new("nan_comparison.py"))]
     fn rules(rule_code: Rule, path: &Path) -> Result<()> {
         let snapshot = format!("{}_{}", rule_code.noqa_code(), path.to_string_lossy());
         let diagnostics = test_path(

crates/ruff_linter/src/rules/pylint/rules/mod.rs

@@ -37,6 +37,7 @@ pub(crate) use magic_value_comparison::*;
 pub(crate) use manual_import_from::*;
 pub(crate) use misplaced_bare_raise::*;
 pub(crate) use named_expr_without_context::*;
+pub(crate) use nan_comparison::*;
 pub(crate) use nested_min_max::*;
 pub(crate) use no_method_decorator::*;
 pub(crate) use no_self_use::*;
@@ -125,6 +126,7 @@ mod magic_value_comparison;
 mod manual_import_from;
 mod misplaced_bare_raise;
 mod named_expr_without_context;
+mod nan_comparison;
 mod nested_min_max;
 mod no_method_decorator;
 mod no_self_use;

crates/ruff_linter/src/rules/pylint/rules/nan_comparison.rs

@@ -0,0 +1,104 @@
+use ruff_python_ast::{self as ast, Expr};
+
+use ruff_diagnostics::{Diagnostic, Violation};
+use ruff_macros::{derive_message_formats, violation};
+use ruff_text_size::Ranged;
+
+use crate::checkers::ast::Checker;
+
+/// ## What it does
+/// Checks for comparisons against NaN values.
+///
+/// ## Why is this bad?
+/// Comparing against a NaN value will always return False even if both values are NaN.
+///
+/// ## Example
+/// ```python
+/// if x == float("NaN"):
+///     pass
+/// ```
+///
+/// Use instead:
+/// ```python
+/// import math
+///
+/// if math.isnan(x):
+///     pass
+/// ```
+///
+#[violation]
+pub struct NanComparison {
+    using_numpy: bool,
+}
+
+impl Violation for NanComparison {
+    #[derive_message_formats]
+    fn message(&self) -> String {
+        let NanComparison { using_numpy } = self;
+        if *using_numpy {
+            format!("Comparing against a NaN value, consider using `np.isnan`")
+        } else {
+            format!("Comparing against a NaN value, consider using `math.isnan`")
+        }
+    }
+}
+
+fn is_nan_float(expr: &Expr) -> bool {
+    let Expr::Call(call) = expr else {
+        return false;
+    };
+
+    let Expr::Name(ast::ExprName { id, .. }) = ast::helpers::map_subscript(call.func.as_ref())
+    else {
+        return false;
+    };
+
+    if id.as_str() != "float" {
+        return false;
+    }
+
+    let Some(arg) = call.arguments.find_positional(0) else {
+        return false;
+    };
+
+    if let Expr::StringLiteral(ast::ExprStringLiteral { value, .. }) = arg {
+        return value.to_str().to_lowercase() == "nan";
+    }
+
+    false
+}
+
+/// PLW0117
+pub(crate) fn nan_comparison(checker: &mut Checker, left: &Expr, comparators: &[Expr]) {
+    for comparison_expr in std::iter::once(left).chain(comparators.iter()) {
+        if let Some(qualified_name) = checker.semantic().resolve_qualified_name(comparison_expr) {
+            let segments = qualified_name.segments();
+            match segments[0] {
+                "numpy" => {
+                    if segments[1].to_lowercase() == "nan" {
+                        checker.diagnostics.push(Diagnostic::new(
+                            NanComparison { using_numpy: true },
+                            comparison_expr.range(),
+                        ));
+                    }
+                }
+                "math" => {
+                    if segments[1] == "nan" {
+                        checker.diagnostics.push(Diagnostic::new(
+                            NanComparison { using_numpy: false },
+                            comparison_expr.range(),
+                        ));
+                    }
+                }
+                _ => continue,
+            }
+        }
+
+        if is_nan_float(comparison_expr) {
+            checker.diagnostics.push(Diagnostic::new(
+                NanComparison { using_numpy: false },
+                comparison_expr.range(),
+            ));
+        }
+    }
+}

crates/ruff_linter/src/rules/pylint/snapshots/ruff_linter__rules__pylint__tests__PLW0117_nan_comparison.py.snap

@@ -0,0 +1,82 @@
+---
+source: crates/ruff_linter/src/rules/pylint/mod.rs
+---
+nan_comparison.py:11:9: PLW0117 Comparing against a NaN value, consider using `math.isnan`
+   |
+10 | # PLW0117
+11 | if x == float('nan'):
+   |         ^^^^^^^^^^^^ PLW0117
+12 |     pass
+   |
+
+nan_comparison.py:15:9: PLW0117 Comparing against a NaN value, consider using `math.isnan`
+   |
+14 | # PLW0117
+15 | if x == float('NaN'):
+   |         ^^^^^^^^^^^^ PLW0117
+16 |     pass
+   |
+
+nan_comparison.py:19:9: PLW0117 Comparing against a NaN value, consider using `math.isnan`
+   |
+18 | # PLW0117
+19 | if x == float('NAN'):
+   |         ^^^^^^^^^^^^ PLW0117
+20 |     pass
+   |
+
+nan_comparison.py:23:9: PLW0117 Comparing against a NaN value, consider using `math.isnan`
+   |
+22 | # PLW0117
+23 | if x == float('Nan'):
+   |         ^^^^^^^^^^^^ PLW0117
+24 |     pass
+   |
+
+nan_comparison.py:27:9: PLW0117 Comparing against a NaN value, consider using `math.isnan`
+   |
+26 | # PLW0117
+27 | if x == math.nan:
+   |         ^^^^^^^^ PLW0117
+28 |     pass
+   |
+
+nan_comparison.py:31:9: PLW0117 Comparing against a NaN value, consider using `math.isnan`
+   |
+30 | # PLW0117
+31 | if x == bad_val:
+   |         ^^^^^^^ PLW0117
+32 |     pass
+   |
+
+nan_comparison.py:35:9: PLW0117 Comparing against a NaN value, consider using `np.isnan`
+   |
+34 | # PLW0117
+35 | if y == np.NaN:
+   |         ^^^^^^ PLW0117
+36 |     pass
+   |
+
+nan_comparison.py:39:9: PLW0117 Comparing against a NaN value, consider using `np.isnan`
+   |
+38 | # PLW0117
+39 | if y == np.NAN:
+   |         ^^^^^^ PLW0117
+40 |     pass
+   |
+
+nan_comparison.py:43:9: PLW0117 Comparing against a NaN value, consider using `np.isnan`
+   |
+42 | # PLW0117
+43 | if y == np.nan:
+   |         ^^^^^^ PLW0117
+44 |     pass
+   |
+
+nan_comparison.py:47:9: PLW0117 Comparing against a NaN value, consider using `np.isnan`
+   |
+46 | # PLW0117
+47 | if y == npy_nan:
+   |         ^^^^^^^ PLW0117
+48 |     pass
+   |