SONARPY-1806 Fix false positive in S6730 when using np.bool (SONARPY-1806) (#983)

Co-authored-by: Vibe Bot <vibe-bot@sonarsource.com>
GitOrigin-RevId: 051c750045a94da4a13324b89eba55d9d2ea1c3a

Author: 2 people

python-checks/src/main/java/org/sonar/python/checks/DeprecatedNumpyTypesCheck.java

@@ -16,31 +16,33 @@
  */
 package org.sonar.python.checks;
 
-import java.util.Map;
-import java.util.Optional;
+import java.util.List;
 import org.sonar.check.Rule;
 import org.sonar.plugins.python.api.PythonSubscriptionCheck;
 import org.sonar.plugins.python.api.SubscriptionContext;
 import org.sonar.plugins.python.api.quickfix.PythonQuickFix;
-import org.sonar.plugins.python.api.symbols.Symbol;
 import org.sonar.plugins.python.api.tree.QualifiedExpression;
 import org.sonar.plugins.python.api.tree.Tree;
+import org.sonar.plugins.python.api.types.v2.matchers.TypeMatcher;
+import org.sonar.plugins.python.api.types.v2.matchers.TypeMatchers;
 import org.sonar.python.quickfix.TextEditUtils;
 
 @Rule(key = "S6730")
 public class DeprecatedNumpyTypesCheck extends PythonSubscriptionCheck {
 
   private static final String MESSAGE = "Replace this deprecated \"numpy\" type alias with the builtin type \"%s\".";
   private static final String QUICK_FIX_MESSAGE = "Replace with %s.";
-  private static final Map<String, String> TYPE_TO_CHECK = Map.of(
-      "numpy.bool", "bool",
-      "numpy.int", "int",
-      "numpy.float", "float",
-      "numpy.complex", "complex",
-      "numpy.object", "object",
-      "numpy.str", "str",
-      "numpy.long", "int",
-      "numpy.unicode", "str");
+
+  private record DeprecatedType(TypeMatcher matcher, String replacement) {}
+
+  private static final List<DeprecatedType> DEPRECATED_TYPES = List.of(
+    new DeprecatedType(TypeMatchers.withFQN("numpy.int"), "int"),
+    new DeprecatedType(TypeMatchers.withFQN("numpy.float"), "float"),
+    new DeprecatedType(TypeMatchers.withFQN("numpy.complex"), "complex"),
+    new DeprecatedType(TypeMatchers.withFQN("numpy.object"), "object"),
+    new DeprecatedType(TypeMatchers.withFQN("numpy.str"), "str"),
+    new DeprecatedType(TypeMatchers.withFQN("numpy.long"), "int"),
+    new DeprecatedType(TypeMatchers.withFQN("numpy.unicode"), "str"));
 
   @Override
   public void initialize(Context context) {
@@ -50,13 +52,15 @@ public void initialize(Context context) {
 
   private static void checkForDeprecatedTypesNames(SubscriptionContext ctx) {
     QualifiedExpression expression = (QualifiedExpression) ctx.syntaxNode();
-    Optional.ofNullable(expression.symbol())
-        .map(Symbol::fullyQualifiedName)
-        .map(TYPE_TO_CHECK::get)
-        .ifPresent(type -> raiseIssue(expression, type, ctx));
+    for (DeprecatedType deprecatedType : DEPRECATED_TYPES) {
+      if (deprecatedType.matcher().isTrueFor(expression, ctx)) {
+        raiseIssue(expression, deprecatedType.replacement(), ctx);
+        return;
+      }
+    }
   }
 
-  private static void raiseIssue(Tree expression, String replacementType, SubscriptionContext ctx) {
+  private static void raiseIssue(QualifiedExpression expression, String replacementType, SubscriptionContext ctx) {
     PreciseIssue issue = ctx.addIssue(expression, String.format(MESSAGE, replacementType));
     PythonQuickFix quickFix = PythonQuickFix.newQuickFix(
         String.format(QUICK_FIX_MESSAGE, replacementType),

python-checks/src/test/java/org/sonar/python/checks/DeprecatedNumpyTypesCheckTest.java

@@ -55,7 +55,6 @@ def foo():
 
   private static Stream<Arguments> numpyTypeProvider(){
     return Stream.of(
-      Arguments.of("np.bool", "(True)", "bool"),
       Arguments.of("np.int", "(42)", "int"),
       Arguments.of("np.float", "(4.2)", "float"),
       Arguments.of("np.complex", "(-2.0, -1.2)", "complex"),

python-checks/src/test/resources/checks/deprecatedNumpyTypesCheck.py

@@ -2,8 +2,6 @@
 
 
 def failure():
-    b = np.bool(True)  # Noncompliant {{Replace this deprecated "numpy" type alias with the builtin type "bool".}}
-    #   ^^^^^^^
     i = np.int(42)  # Noncompliant {{Replace this deprecated "numpy" type alias with the builtin type "int".}}
     #   ^^^^^^
     f = np.float(4.2)  # Noncompliant {{Replace this deprecated "numpy" type alias with the builtin type "float".}}
@@ -21,8 +19,6 @@ def failure():
 
 def failure_import_as_z():
     import numpy as z
-    b = z.bool(True)  # Noncompliant
-    #   ^^^^^^
     i = z.int(42)  # Noncompliant
     #   ^^^^^
     f = z.float(4.2)  # Noncompliant
@@ -39,6 +35,8 @@ def failure_import_as_z():
     #   ^^^^^^^^^
 
 def success():
+    b = np.bool(True)
+    b = np.bool(False)
     b = True  # Compliant
     b = bool(True)  # Compliant
     i = 42  # Compliant
@@ -54,3 +52,12 @@ def success():
     u = "bar"  # Compliant
     u = str("bar")  # Compliant
 
+def success_np_bool_usages():
+    # np.bool is no longer deprecated (reintroduced in NumPy 2.x)
+    arr = np.zeros(2).astype(np.bool)
+    mask = np.ones((3, 4), dtype=np.bool)
+    empty = np.zeros_like(arr, dtype=np.bool)
+    if arr.dtype == np.bool:
+        pass
+    dtype = np.bool
+