SONARPY-1797 Introduce new type inference model classes

Author: maksim-grebeniuk-sonarsource

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

@@ -22,12 +22,18 @@
 import com.google.common.annotations.Beta;
 import org.sonar.plugins.python.api.types.InferredType;
 import org.sonar.python.types.InferredTypes;
+import org.sonar.python.types.v2.PythonType;
 
 public interface Expression extends Tree {
 
   @Beta
   default InferredType type() {
     return InferredTypes.anyType();
   }
+  
+  @Beta
+  default PythonType pythonType() {
+    return PythonType.UNKNOWN;
+  }
 
 }

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

@@ -22,6 +22,7 @@
 import javax.annotation.CheckForNull;
 import org.sonar.plugins.python.api.symbols.Symbol;
 import org.sonar.plugins.python.api.symbols.Usage;
+import org.sonar.python.types.v2.PythonType;
 
 /**
  * Qualified expression like "foo.bar"
@@ -56,4 +57,9 @@ default Symbol symbol() {
   default Usage usage() {
     return name().usage();
   }
+
+  @Override
+  default PythonType pythonType() {
+    return name().pythonType();
+  }
 }

python-frontend/src/main/java/org/sonar/python/tree/NameImpl.java

@@ -31,6 +31,7 @@
 import org.sonar.plugins.python.api.tree.TreeVisitor;
 import org.sonar.plugins.python.api.types.InferredType;
 import org.sonar.python.types.InferredTypes;
+import org.sonar.python.types.v2.PythonType;
 
 public class NameImpl extends PyTree implements Name {
   private final Token token;
@@ -39,6 +40,7 @@ public class NameImpl extends PyTree implements Name {
   private Symbol symbol;
   private Usage usage;
   private InferredType inferredType = InferredTypes.anyType();
+  private PythonType pythonType = PythonType.UNKNOWN;
   private static final String TRUE = "True";
   private static final String FALSE = "False";
 
@@ -118,4 +120,14 @@ private boolean isBooleanBuiltinSymbol() {
   public void setInferredType(InferredType inferredType) {
     this.inferredType = inferredType;
   }
+
+  @Override
+  public PythonType pythonType() {
+    return pythonType;
+  }
+
+  public NameImpl pythonType(PythonType pythonType) {
+    this.pythonType = pythonType;
+    return this;
+  }
 }

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

@@ -0,0 +1,95 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * 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 GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.python.types.v2;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+/**
+ * ClassType
+ */
+public record ClassType(
+  String name,
+  List<Member> members,
+  List<PythonType> attributes,
+  List<PythonType> superClasses,
+  List<PythonType> typeVars) implements PythonType {
+
+  public ClassType(String name) {
+    this(name, new ArrayList<>(), new ArrayList<>(), new ArrayList<>(), new ArrayList<>());
+  }
+
+  public ClassType(String name, List<PythonType> attributes) {
+    this(name, new ArrayList<>(), attributes, new ArrayList<>(), new ArrayList<>());
+  }
+
+  @Override
+  public String displayName() {
+    var splits = name.split("\\.");
+    if (splits.length > 0) {
+      return splits[splits.length - 1];
+    }
+    return name;
+  }
+
+  @Override
+  public boolean isCompatibleWith(PythonType another) {
+    if (another instanceof ObjectType) {
+      return this.isCompatibleWith(((ObjectType) another).type());
+    }
+    if (another instanceof UnionType) {
+      return ((UnionType) another).candidates().stream().anyMatch(c -> this.isCompatibleWith(c));
+    }
+    if (another instanceof FunctionType) {
+      return this.isCompatibleWith(((FunctionType) another).returnType());
+    }
+    if (another instanceof ClassType) {
+      var other = (ClassType) another;
+      var isASubClass = this.isASubClassFrom(other);
+      var areAttributeCompatible = this.areAttributesCompatible(other);
+      var isDuckTypeCompatible = !this.members.isEmpty() && other.members.stream().allMatch(member -> this.members.contains(member));
+      return Objects.equals(this, another) || "builtins.object".equals(other.name()) || 
+        isDuckTypeCompatible ||
+        ( isASubClass && areAttributeCompatible) ;
+    }
+    return true;
+  }
+
+  public boolean isASubClassFrom(ClassType other) {
+    return superClasses.stream().anyMatch(superClass -> superClass.isCompatibleWith(other));
+  }
+
+  public boolean areAttributesCompatible(ClassType other) {
+    return attributes.stream().allMatch(attr -> other.attributes.stream().anyMatch(otherAttr -> attr.isCompatibleWith(otherAttr)));
+  }
+
+  @Override
+  public String key() {
+    return Optional.of(attributes())
+      .stream()
+      .flatMap(Collection::stream)
+      .map(PythonType::key)
+      .collect(Collectors.joining(",", name() + "[", "]"));
+  }
+}

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

@@ -0,0 +1,34 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * 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 GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.python.types.v2;
+
+import java.util.List;
+
+/**
+ * FunctionType
+ */
+public record FunctionType(
+  String name,
+  List<Member> members,
+  List<PythonType> attributes,
+  List<PythonType> typeVars,
+  List<Member> parameters,
+  PythonType returnType) implements PythonType {
+}

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

@@ -0,0 +1,24 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * 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 GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.python.types.v2;
+
+public record Member(String name, PythonType type) {
+}
+

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

@@ -0,0 +1,36 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * 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 GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.python.types.v2;
+
+import java.util.List;
+import java.util.Optional;
+
+public record ModuleType(String name, List<PythonType> children) implements PythonType {
+
+  @Override
+  public boolean isCompatibleWith(PythonType another) {
+    return Optional.ofNullable(another)
+      .filter(ModuleType.class::isInstance)
+      .map(ModuleType.class::cast)
+      .map(ModuleType::name)
+      .filter(name::equals)
+      .isPresent();
+  }
+}

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

@@ -0,0 +1,35 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * 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 GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.python.types.v2;
+
+import java.util.List;
+
+public record ObjectType(PythonType type, List<PythonType> attributes, List<Member> members) implements PythonType {
+
+  @Override
+  public String displayName() {
+    return type.displayName();
+  }
+
+  @Override
+  public boolean isCompatibleWith(PythonType another) {
+    return this.type.isCompatibleWith(another);
+  }
+}

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

@@ -0,0 +1,44 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * 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 GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.python.types.v2;
+
+/**
+ * PythonType
+ */
+public interface PythonType {
+  PythonType UNKNOWN = new UnknownType();
+
+  default String name() {
+    return this.toString();
+  }
+
+  default String displayName() {
+    return this.toString();
+  }
+
+  default boolean isCompatibleWith(PythonType another) {
+    return true;
+  }
+
+  default String key() {
+    return name();
+  }
+
+}

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

@@ -0,0 +1,40 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * 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 GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.python.types.v2;
+
+import java.util.List;
+
+public record UnionType(List<PythonType> candidates) implements PythonType {
+  public UnionType() {
+    this(List.of());
+  }
+
+  @Override
+  public String displayName() {
+    var candidatesName = candidates.stream().map(c -> c.displayName()).toList();
+    return "Union[%s]".formatted(String.join(", ", candidatesName));
+  }
+
+  @Override
+  public boolean isCompatibleWith(PythonType another) {
+    return candidates.isEmpty() || candidates.stream()
+      .anyMatch(candidate -> candidate.isCompatibleWith(another));
+  }
+}