SONARPY-1894 Mark new type inference API as Beta (#1816)

Author: maksim-grebeniuk-sonarsource

python-frontend/src/main/java/org/sonar/plugins/python/api/tree/Name.java

@@ -19,6 +19,7 @@
  */
 package org.sonar.plugins.python.api.tree;
 
+import org.sonar.api.Beta;
 import org.sonar.python.semantic.v2.SymbolV2;
 
 /**
@@ -31,5 +32,6 @@ public interface Name extends Expression, HasSymbol {
   // FIXME: we should create a separate tree for Variables
   boolean isVariable();
 
+  @Beta
   SymbolV2 symbolV2();
 }

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

@@ -22,9 +22,11 @@
 import java.util.ArrayList;
 import java.util.List;
 import javax.annotation.Nullable;
+import org.sonar.api.Beta;
 import org.sonar.plugins.python.api.tree.Name;
 import org.sonar.python.tree.NameImpl;
 
+@Beta
 public record SymbolV2(String name, @Nullable String fullyQualifiedName, List<UsageV2> usages) {
 
   public SymbolV2(String name) {
@@ -39,6 +41,7 @@ void addUsage(Name name, UsageV2.Kind kind) {
     }
   }
 
+  @Beta
   public boolean hasSingleBindingUsage() {
     return usages.stream().filter(UsageV2::isBindingUsage).toList().size() == 1;
   }

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

@@ -19,10 +19,13 @@
  */
 package org.sonar.python.semantic.v2;
 
+import org.sonar.api.Beta;
 import org.sonar.plugins.python.api.tree.Tree;
 
+@Beta
 public record UsageV2(Tree tree, Kind kind) {
 
+  @Beta
   public boolean isBindingUsage() {
     return kind() != UsageV2.Kind.OTHER && kind() != UsageV2.Kind.GLOBAL_DECLARATION;
   }

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

@@ -28,11 +28,13 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 import javax.annotation.Nullable;
+import org.sonar.api.Beta;
 import org.sonar.plugins.python.api.LocationInFile;
 
 /**
  * ClassType
  */
+@Beta
 public record ClassType(
   String name,
   Set<Member> members,
@@ -86,10 +88,12 @@ public boolean isCompatibleWith(PythonType another) {
     return true;
   }
 
+  @Beta
   public boolean isASubClassFrom(ClassType other) {
     return superClasses.stream().anyMatch(superClass -> superClass.isCompatibleWith(other));
   }
 
+  @Beta
   public boolean areAttributesCompatible(ClassType other) {
     return attributes.stream().allMatch(attr -> other.attributes.stream().anyMatch(attr::isCompatibleWith));
   }

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

@@ -23,11 +23,13 @@
 import java.util.Objects;
 import java.util.Optional;
 import javax.annotation.Nullable;
+import org.sonar.api.Beta;
 import org.sonar.plugins.python.api.LocationInFile;
 
 /**
  * FunctionType
  */
+@Beta
 public record FunctionType(
   String name,
   List<PythonType> attributes,
@@ -71,7 +73,6 @@ public int hashCode() {
     return Objects.hash(name, attributes, parameters, returnType, isAsynchronous, hasDecorators, isInstanceMethod, hasVariadicParameter);
   }
 
-
   @Override
   public String toString() {
     return "FunctionType[%s]".formatted(name);

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

@@ -19,6 +19,9 @@
  */
 package org.sonar.python.types.v2;
 
+import org.sonar.api.Beta;
+
+@Beta
 public record Member(String name, PythonType type) {
 }
 

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

@@ -24,7 +24,9 @@
 import java.util.Objects;
 import java.util.Optional;
 import javax.annotation.Nullable;
+import org.sonar.api.Beta;
 
+@Beta
 public record ModuleType(@Nullable String name, @Nullable ModuleType parent, Map<String, PythonType> members) implements PythonType {
   public ModuleType(@Nullable String name) {
     this(name, null);

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

@@ -23,8 +23,10 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
+import org.sonar.api.Beta;
 import org.sonar.plugins.python.api.LocationInFile;
 
+@Beta
 public record ObjectType(PythonType type, List<PythonType> attributes, List<Member> members) implements PythonType {
 
   public ObjectType(PythonType type) {

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

@@ -20,8 +20,10 @@
 package org.sonar.python.types.v2;
 
 import javax.annotation.Nullable;
+import org.sonar.api.Beta;
 import org.sonar.plugins.python.api.LocationInFile;
 
+@Beta
 public record ParameterV2(
   @Nullable String name,
   PythonType declaredType,
@@ -32,6 +34,7 @@ public record ParameterV2(
   boolean isPositionalVariadic,
   @Nullable LocationInFile location) {
 
+  @Beta
   public boolean isVariadic() {
     return isKeywordVariadic || isPositionalVariadic;
   }

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

@@ -20,46 +20,57 @@
 package org.sonar.python.types.v2;
 
 import java.util.Optional;
+import org.sonar.api.Beta;
 import org.sonar.plugins.python.api.LocationInFile;
 
 /**
  * PythonType
  */
+@Beta
 public interface PythonType {
   PythonType UNKNOWN = new UnknownType();
 
+  @Beta
   default String name() {
     return this.toString();
   }
 
+  @Beta
   default Optional<String> displayName() {
     return Optional.empty();
   }
 
+  @Beta
   default Optional<String> instanceDisplayName() {
     return Optional.empty();
   }
 
+  @Beta
   default boolean isCompatibleWith(PythonType another) {
     return true;
   }
 
+  @Beta
   default String key() {
     return name();
   }
 
+  @Beta
   default Optional<PythonType> resolveMember(String memberName) {
     return Optional.empty();
   }
 
+  @Beta
   default TriBool hasMember(String memberName) {
     return TriBool.UNKNOWN;
   }
 
+  @Beta
   default Optional<LocationInFile> definitionLocation() {
     return Optional.empty();
   }
 
+  @Beta
   default PythonType unwrappedType() {
     return this;
   }