SONARPY-2029 Implement API to get a module type's member type from project level types table (#1880)

Author: maksim-grebeniuk-sonarsource

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

@@ -24,6 +24,7 @@
 import org.sonar.python.semantic.ProjectLevelSymbolTable;
 import org.sonar.python.types.v2.ModuleType;
 import org.sonar.python.types.v2.PythonType;
+import org.sonar.python.types.v2.TriBool;
 
 public class ProjectLevelTypeTable {
 
@@ -61,4 +62,30 @@ public ModuleType getModule(List<String> moduleNameParts) {
     }
     return parent;
   }
+
+  public PythonType getType(String typeFqn) {
+    return getType(typeFqn.split("\\."));
+  }
+
+  public PythonType getType(String... typeFqnParts) {
+    return getType(List.of(typeFqnParts));
+  }
+
+  public PythonType getType(List<String> typeFqnParts) {
+    var parent = (PythonType) rootModule;
+    for (int i = 0; i < typeFqnParts.size(); i++) {
+      var part = typeFqnParts.get(i);
+      if (parent.hasMember(part) == TriBool.TRUE) {
+        parent = parent.resolveMember(part).orElse(PythonType.UNKNOWN);
+      } else if (parent instanceof ModuleType module) {
+        var moduleFqn = IntStream.rangeClosed(0, i)
+          .mapToObj(typeFqnParts::get)
+          .toList();
+        parent = symbolsModuleTypeProvider.createModuleType(moduleFqn, module);
+      } else {
+        return PythonType.UNKNOWN;
+      }
+    }
+    return parent;
+  }
 }

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

@@ -51,6 +51,14 @@ public Optional<PythonType> resolveMember(String memberName) {
     return Optional.ofNullable(members.get(memberName));
   }
 
+  @Override
+  public TriBool hasMember(String memberName) {
+    if (resolveMember(memberName).isPresent()) {
+      return TriBool.TRUE;
+    }
+    return TriBool.UNKNOWN;
+  }
+
   @Override
   public String toString() {
     return "ModuleType{" +

python-frontend/src/test/java/org/sonar/python/semantic/v2/ProjectLevelTypeTableTest.java

@@ -0,0 +1,78 @@
+/*
+ * 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.semantic.v2;
+
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.sonar.python.semantic.ProjectLevelSymbolTable;
+import org.sonar.python.types.v2.ClassType;
+import org.sonar.python.types.v2.ModuleType;
+import org.sonar.python.types.v2.PythonType;
+import org.sonar.python.types.v2.TriBool;
+
+class ProjectLevelTypeTableTest {
+  
+  @Test
+  void getBuiltinTypeTest() {
+    var symbolTable = ProjectLevelSymbolTable.empty();
+    var table = new ProjectLevelTypeTable(symbolTable, new TypeShed(symbolTable));
+
+    var listClassType = table.getType("list");
+    Assertions.assertThat(listClassType).isNotNull().isInstanceOf(ClassType.class);
+
+    var builtinsModuleType = table.getType();
+    Assertions.assertThat(builtinsModuleType).isNotNull().isInstanceOf(ModuleType.class);
+    Assertions.assertThat(builtinsModuleType.resolveMember("list")).isPresent().containsSame(listClassType);
+
+    Assertions.assertThat(table.getType("list.something")).isSameAs(PythonType.UNKNOWN);
+  }
+
+  @Test
+  void getTypeshedTypeTest() {
+    var symbolTable = ProjectLevelSymbolTable.empty();
+    var table = new ProjectLevelTypeTable(symbolTable, new TypeShed(symbolTable));
+
+    var generatorClassType = table.getType("typing.Generator");
+    Assertions.assertThat(generatorClassType).isNotNull().isInstanceOf(ClassType.class);
+
+    var typingModuleType = table.getType("typing");
+    Assertions.assertThat(typingModuleType).isNotNull().isInstanceOf(ModuleType.class);
+    Assertions.assertThat(typingModuleType.resolveMember("Generator")).isPresent().containsSame(generatorClassType);
+  }
+
+  @Test
+  void updateTypeTableDuringGetTypeTest() {
+    var symbolTable = ProjectLevelSymbolTable.empty();
+    var table = new ProjectLevelTypeTable(symbolTable, new TypeShed(symbolTable));
+
+    var rootModuleType = table.getType();
+    Assertions.assertThat(rootModuleType.hasMember("typing")).isNotEqualTo(TriBool.TRUE);
+
+    var generatorClassType = table.getType("typing.Generator");
+    Assertions.assertThat(generatorClassType).isNotNull().isInstanceOf(ClassType.class);
+
+    var typingModuleType = table.getType("typing");
+    Assertions.assertThat(typingModuleType).isNotNull().isInstanceOf(ModuleType.class);
+    Assertions.assertThat(typingModuleType.resolveMember("Generator")).isPresent().containsSame(generatorClassType);
+
+    Assertions.assertThat(rootModuleType.hasMember("typing")).isEqualTo(TriBool.TRUE);
+    Assertions.assertThat(rootModuleType.resolveMember("typing")).containsSame(typingModuleType);
+  }
+}