SONARPY-3526 Enable using Matcher API in type inference (#669)

GitOrigin-RevId: b6a84f2ce034a79ad2b4a44dddb50e305aefa7e7

Author: Seppli11

python-frontend/src/main/java/org/sonar/python/api/types/v2/matchers/TypeMatcherImpl.java

@@ -16,15 +16,14 @@
  */
 package org.sonar.python.api.types.v2.matchers;
 
-import com.google.common.annotations.VisibleForTesting;
-import java.util.Set;
 import org.sonar.api.Beta;
 import org.sonar.plugins.python.api.SubscriptionContext;
 import org.sonar.plugins.python.api.TriBool;
 import org.sonar.plugins.python.api.tree.Expression;
 import org.sonar.plugins.python.api.types.v2.PythonType;
-import org.sonar.plugins.python.api.types.v2.UnionType;
 import org.sonar.python.types.v2.matchers.TypePredicate;
+import org.sonar.python.types.v2.matchers.TypePredicateContext;
+import org.sonar.python.types.v2.matchers.TypePredicateUtils;
 
 // This record is package-private
 @Beta
@@ -33,28 +32,13 @@ record TypeMatcherImpl(TypePredicate predicate) implements TypeMatcher {
   @Override
   public TriBool evaluateFor(Expression expr, SubscriptionContext ctx) {
     PythonType type = expr.typeV2();
-    Set<PythonType> candidates = extractCandidates(type);
-
-    TriBool result = TriBool.TRUE;
-    for (PythonType candidate : candidates) {
-      result = result.conservativeAnd(predicate.check(candidate, ctx));
-      if (result.isUnknown()) {
-        break;
-      }
-    }
-    return result;
+    TypePredicateContext predicateContext = TypePredicateContext.of(ctx.typeTable());
+    return TypePredicateUtils.evaluate(predicate, type, predicateContext);
   }
 
   @Override
   public boolean isTrueFor(Expression expr, SubscriptionContext ctx) {
     return evaluateFor(expr, ctx).isTrue();
   }
 
-  @VisibleForTesting
-  static Set<PythonType> extractCandidates(PythonType type) {
-    if (type instanceof UnionType unionType) {
-      return unionType.candidates();
-    }
-    return Set.of(type);
-  }
 }

python-frontend/src/main/java/org/sonar/python/semantic/v2/types/TypeInferenceMatcher.java

@@ -0,0 +1,39 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2025 SonarSource Sàrl
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.python.semantic.v2.types;
+
+import org.sonar.plugins.python.api.TriBool;
+import org.sonar.plugins.python.api.types.v2.PythonType;
+import org.sonar.python.types.v2.matchers.TypePredicate;
+import org.sonar.python.types.v2.matchers.TypePredicateContext;
+import org.sonar.python.types.v2.matchers.TypePredicateUtils;
+
+class TypeInferenceMatcher {
+  private final TypePredicate predicate;
+
+  private TypeInferenceMatcher(TypePredicate predicate) {
+    this.predicate = predicate;
+  }
+
+  public TriBool evaluate(PythonType type, TypePredicateContext ctx) {
+    return TypePredicateUtils.evaluate(predicate, type, ctx);
+  }
+
+  public static TypeInferenceMatcher of(TypePredicate predicate) {
+    return new TypeInferenceMatcher(predicate);
+  }
+}

python-frontend/src/main/java/org/sonar/python/semantic/v2/types/TypeInferenceMatchers.java

@@ -0,0 +1,48 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2025 SonarSource Sàrl
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the Sonar Source-Available License for more details.
+ *
+ * You should have received a copy of the Sonar Source-Available License
+ * along with this program; if not, see https://sonarsource.com/license/ssal/
+ */
+package org.sonar.python.semantic.v2.types;
+
+import org.sonar.plugins.python.api.types.v2.PythonType;
+import org.sonar.python.api.types.v2.matchers.TypeMatchers;
+import org.sonar.python.types.v2.matchers.IsObjectSatisfyingPredicate;
+import org.sonar.python.types.v2.matchers.IsTypePredicate;
+import org.sonar.python.types.v2.matchers.TypePredicate;
+
+/**
+ * This class is the entry point for the TypeMatcher API specifically for type inference.
+ * Compared to the {@link TypeMatchers} class, this API can handle {@link PythonType} instances directly. 
+ * 
+ * In case of missing matchers, they should be added to this class, instead of using the constructor directly.
+ * 
+ * @see TypeInferenceMatcher
+ */
+class TypeInferenceMatchers {
+  private TypeInferenceMatchers() {
+  }
+
+  public static TypePredicate isType(String fqn) {
+    return new IsTypePredicate(fqn);
+  }
+
+  public static TypePredicate isObjectSatisfying(TypePredicate matcher) {
+    return new IsObjectSatisfyingPredicate(matcher);
+  }
+
+  public static TypePredicate isObjectOfType(String fqn) {
+    return isObjectSatisfying(isType(fqn));
+  }
+}

python-frontend/src/main/java/org/sonar/python/types/v2/matchers/AllTypePredicate.java

@@ -17,7 +17,6 @@
 package org.sonar.python.types.v2.matchers;
 
 import java.util.List;
-import org.sonar.plugins.python.api.SubscriptionContext;
 import org.sonar.plugins.python.api.TriBool;
 import org.sonar.plugins.python.api.types.v2.PythonType;
 
@@ -34,7 +33,7 @@ public AllTypePredicate(List<TypePredicate> predicates) {
   }
 
   @Override
-  public TriBool check(PythonType type, SubscriptionContext ctx) {
+  public TriBool check(PythonType type, TypePredicateContext ctx) {
     TriBool result = TriBool.TRUE;
     for (TypePredicate predicate : predicates) {
       TriBool partialResult = predicate.check(type, ctx);

python-frontend/src/main/java/org/sonar/python/types/v2/matchers/AnyTypePredicate.java

@@ -17,7 +17,6 @@
 package org.sonar.python.types.v2.matchers;
 
 import java.util.List;
-import org.sonar.plugins.python.api.SubscriptionContext;
 import org.sonar.plugins.python.api.TriBool;
 import org.sonar.plugins.python.api.types.v2.PythonType;
 
@@ -34,7 +33,7 @@ public AnyTypePredicate(List<TypePredicate> predicates) {
   }
 
   @Override
-  public TriBool check(PythonType type, SubscriptionContext ctx) {
+  public TriBool check(PythonType type, TypePredicateContext ctx) {
     TriBool result = TriBool.FALSE;
 
     for (TypePredicate predicate : predicates) {

python-frontend/src/main/java/org/sonar/python/types/v2/matchers/HasFQNPredicate.java

@@ -18,14 +18,13 @@
 
 import java.util.Objects;
 import java.util.Optional;
-import org.sonar.plugins.python.api.SubscriptionContext;
 import org.sonar.plugins.python.api.TriBool;
 import org.sonar.plugins.python.api.types.v2.FullyQualifiedNameHelper;
 import org.sonar.plugins.python.api.types.v2.PythonType;
 
 public record HasFQNPredicate(String fullyQualifiedName) implements TypePredicate {
   @Override
-  public TriBool check(PythonType type, SubscriptionContext ctx) {
+  public TriBool check(PythonType type, TypePredicateContext ctx) {
     return Optional.of(type)
       .flatMap(FullyQualifiedNameHelper::getFullyQualifiedName)
       .map(typeFqn -> Objects.equals(fullyQualifiedName, typeFqn) ? TriBool.TRUE : TriBool.FALSE)

python-frontend/src/main/java/org/sonar/python/types/v2/matchers/HasMemberPredicate.java

@@ -16,7 +16,6 @@
  */
 package org.sonar.python.types.v2.matchers;
 
-import org.sonar.plugins.python.api.SubscriptionContext;
 import org.sonar.plugins.python.api.TriBool;
 import org.sonar.plugins.python.api.types.v2.PythonType;
 
@@ -29,7 +28,7 @@ public HasMemberPredicate(String memberName) {
   }
 
   @Override
-  public TriBool check(PythonType type, SubscriptionContext ctx) {
+  public TriBool check(PythonType type, TypePredicateContext ctx) {
     return type.hasMember(memberName);
   }
 }

python-frontend/src/main/java/org/sonar/python/types/v2/matchers/HasMemberSatisfyingPredicate.java

@@ -16,7 +16,6 @@
  */
 package org.sonar.python.types.v2.matchers;
 
-import org.sonar.plugins.python.api.SubscriptionContext;
 import org.sonar.plugins.python.api.TriBool;
 import org.sonar.plugins.python.api.types.v2.PythonType;
 
@@ -31,7 +30,7 @@ public HasMemberSatisfyingPredicate(String memberName, TypePredicate memberTypeP
   }
 
   @Override
-  public TriBool check(PythonType type, SubscriptionContext ctx) {
+  public TriBool check(PythonType type, TypePredicateContext ctx) {
     return type.resolveMember(memberName)
       .map(member -> memberTypePredicate.check(member, ctx))
       .orElse(TriBool.FALSE);

python-frontend/src/main/java/org/sonar/python/types/v2/matchers/IsObjectSatisfyingPredicate.java

@@ -16,7 +16,6 @@
  */
 package org.sonar.python.types.v2.matchers;
 
-import org.sonar.plugins.python.api.SubscriptionContext;
 import org.sonar.plugins.python.api.TriBool;
 import org.sonar.plugins.python.api.types.v2.ObjectType;
 import org.sonar.plugins.python.api.types.v2.PythonType;
@@ -30,7 +29,7 @@ public IsObjectSatisfyingPredicate(TypePredicate wrappedPredicate) {
   }
 
   @Override
-  public TriBool check(PythonType type, SubscriptionContext ctx) {
+  public TriBool check(PythonType type, TypePredicateContext ctx) {
     if (type instanceof UnknownType) {
       return TriBool.UNKNOWN;
     }

python-frontend/src/main/java/org/sonar/python/types/v2/matchers/IsObjectSubtypeOfPredicate.java

@@ -17,7 +17,6 @@
 package org.sonar.python.types.v2.matchers;
 
 import java.util.Set;
-import org.sonar.plugins.python.api.SubscriptionContext;
 import org.sonar.plugins.python.api.TriBool;
 import org.sonar.plugins.python.api.types.v2.PythonType;
 
@@ -32,7 +31,7 @@ public IsObjectSubtypeOfPredicate(String fullyQualifiedName) {
   }
 
   @Override
-  public TriBool check(PythonType type, SubscriptionContext ctx) {
+  public TriBool check(PythonType type, TypePredicateContext ctx) {
     return isObjectSatisfyingPredicate.check(type, ctx);
   }
 
@@ -44,7 +43,7 @@ public IsSubtypeOfPredicate(String fullyQualifiedName) {
     }
 
     @Override
-    public TriBool check(PythonType type, SubscriptionContext ctx) {
+    public TriBool check(PythonType type, TypePredicateContext ctx) {
       PythonType expectedType = ctx.typeTable().getType(fullyQualifiedName);
       Set<PythonType> types = collectTypes(type);
       if (types.stream().anyMatch(t -> t.equals(expectedType))) {