SONARPY-1889 share v2 TypeChed between PythonVisitorContext instances

Author: maksim-grebeniuk-sonarsource

python-checks/src/test/java/org/sonar/python/checks/quickfix/PythonQuickFixVerifier.java

@@ -40,6 +40,7 @@
 import org.sonar.python.caching.CacheContextImpl;
 import org.sonar.python.parser.PythonParser;
 import org.sonar.python.semantic.ProjectLevelSymbolTable;
+import org.sonar.python.semantic.v2.TypeShed;
 import org.sonar.python.tree.IPythonTreeMaker;
 import org.sonar.python.tree.PythonTreeMaker;
 
@@ -161,7 +162,7 @@ private static PythonVisitorContext createVisitorContext(PythonParser parser, Py
 
     return new PythonVisitorContext(fileInput,
       pythonFile, null, "",
-      ProjectLevelSymbolTable.empty(), CacheContextImpl.dummyCache(), SonarProduct.SONARLINT);
+      ProjectLevelSymbolTable.empty(), new TypeShed(), CacheContextImpl.dummyCache(), SonarProduct.SONARLINT);
   }
 
   private static String applyQuickFix(String codeWithIssue, PythonQuickFix quickFix) {

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

@@ -34,6 +34,7 @@
 import org.sonar.python.semantic.v2.ProjectLevelTypeTable;
 import org.sonar.python.semantic.v2.SymbolTableBuilderV2;
 import org.sonar.python.semantic.v2.TypeInferenceV2;
+import org.sonar.python.semantic.v2.TypeShed;
 
 public class PythonVisitorContext extends PythonInputFileContext {
 
@@ -48,7 +49,8 @@ public PythonVisitorContext(FileInput rootTree, PythonFile pythonFile, @Nullable
     SymbolTableBuilder symbolTableBuilder = packageName != null ? new SymbolTableBuilder(packageName, pythonFile) : new SymbolTableBuilder(pythonFile);
     symbolTableBuilder.visitFileInput(rootTree);
     var symbolTable = new SymbolTableBuilderV2(rootTree).build();
-    new TypeInferenceV2(new ProjectLevelTypeTable(ProjectLevelSymbolTable.empty()), pythonFile, symbolTable).inferTypes(rootTree);
+    var projectLevelTypeTable = new ProjectLevelTypeTable(ProjectLevelSymbolTable.empty(), new TypeShed());
+    new TypeInferenceV2(projectLevelTypeTable, pythonFile, symbolTable).inferTypes(rootTree);
   }
 
   public PythonVisitorContext(FileInput rootTree, PythonFile pythonFile, @Nullable File workingDirectory, String packageName,
@@ -60,18 +62,20 @@ public PythonVisitorContext(FileInput rootTree, PythonFile pythonFile, @Nullable
 
     var symbolTable = new SymbolTableBuilderV2(rootTree)
       .build();
-    new TypeInferenceV2(new ProjectLevelTypeTable(ProjectLevelSymbolTable.from(projectLevelSymbolTable)), pythonFile, symbolTable).inferTypes(rootTree);
+    var projectLevelTypeTable = new ProjectLevelTypeTable(ProjectLevelSymbolTable.from(projectLevelSymbolTable), new TypeShed());
+    new TypeInferenceV2(projectLevelTypeTable, pythonFile, symbolTable).inferTypes(rootTree);
   }
 
   public PythonVisitorContext(FileInput rootTree, PythonFile pythonFile, @Nullable File workingDirectory, String packageName,
-    ProjectLevelSymbolTable projectLevelSymbolTable, CacheContext cacheContext, SonarProduct sonarProduct) {
+    ProjectLevelSymbolTable projectLevelSymbolTable, TypeShed typeShed, CacheContext cacheContext, SonarProduct sonarProduct) {
     super(pythonFile, workingDirectory, cacheContext, sonarProduct);
     this.rootTree = rootTree;
     this.parsingException = null;
     new SymbolTableBuilder(packageName, pythonFile, projectLevelSymbolTable).visitFileInput(rootTree);
     var symbolTable = new SymbolTableBuilderV2(rootTree)
       .build();
-    new TypeInferenceV2(new ProjectLevelTypeTable(ProjectLevelSymbolTable.from(projectLevelSymbolTable)), pythonFile, symbolTable).inferTypes(rootTree);
+    var projectLevelTypeTable = new ProjectLevelTypeTable(ProjectLevelSymbolTable.from(projectLevelSymbolTable), typeShed);
+    new TypeInferenceV2(projectLevelTypeTable, pythonFile, symbolTable).inferTypes(rootTree);
   }
 
   public PythonVisitorContext(PythonFile pythonFile, RecognitionException parsingException) {

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

@@ -31,7 +31,11 @@ public class ProjectLevelTypeTable {
   private final ModuleType rootModule;
 
   public ProjectLevelTypeTable(ProjectLevelSymbolTable projectLevelSymbolTable) {
-    this.symbolsModuleTypeProvider = new SymbolsModuleTypeProvider(projectLevelSymbolTable);
+    this(projectLevelSymbolTable, new TypeShed());
+  }
+
+  public ProjectLevelTypeTable(ProjectLevelSymbolTable projectLevelSymbolTable, TypeShed typeShed) {
+    this.symbolsModuleTypeProvider = new SymbolsModuleTypeProvider(projectLevelSymbolTable, typeShed);
     this.rootModule = this.symbolsModuleTypeProvider.createBuiltinModule();
   }
 

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

@@ -48,9 +48,9 @@ public class SymbolsModuleTypeProvider {
   private final ProjectLevelSymbolTable projectLevelSymbolTable;
   private final TypeShed typeShed;
 
-  public SymbolsModuleTypeProvider(ProjectLevelSymbolTable projectLevelSymbolTable) {
+  public SymbolsModuleTypeProvider(ProjectLevelSymbolTable projectLevelSymbolTable, TypeShed typeShed) {
     this.projectLevelSymbolTable = projectLevelSymbolTable;
-    typeShed = new TypeShed();
+    this.typeShed = typeShed;
   }
 
   public ModuleType createBuiltinModule() {

python-frontend/src/test/java/org/sonar/plugins/python/api/PythonVisitorContextTest.java

@@ -39,6 +39,7 @@
 import org.sonar.python.parser.PythonParser;
 import org.sonar.python.semantic.ProjectLevelSymbolTable;
 import org.sonar.python.semantic.SymbolImpl;
+import org.sonar.python.semantic.v2.TypeShed;
 import org.sonar.python.tree.FileInputImpl;
 import org.sonar.python.tree.PythonTreeMaker;
 
@@ -95,15 +96,16 @@ void globalSymbols() {
   void sonar_product() {
     CacheContextImpl cacheContext = CacheContextImpl.dummyCache();
     ProjectLevelSymbolTable projectLevelSymbolTable = ProjectLevelSymbolTable.empty();
+    var typeShed = new TypeShed();
     String myPackage = "my_package";
     File workingDirectory = null;
     PythonFile pythonFile = pythonFile("my_module.py");
     FileInput fileInput = mock(FileInputImpl.class);
 
-    PythonVisitorContext pythonVisitorContext = new PythonVisitorContext(fileInput, pythonFile, workingDirectory, myPackage, projectLevelSymbolTable, cacheContext, SonarProduct.SONARLINT);
+    PythonVisitorContext pythonVisitorContext = new PythonVisitorContext(fileInput, pythonFile, workingDirectory, myPackage, projectLevelSymbolTable, typeShed, cacheContext, SonarProduct.SONARLINT);
     assertThat(pythonVisitorContext.sonarProduct()).isEqualTo(SonarProduct.SONARLINT);
 
-    pythonVisitorContext = new PythonVisitorContext(fileInput, pythonFile, workingDirectory, myPackage, projectLevelSymbolTable, cacheContext, SonarProduct.SONARQUBE);
+    pythonVisitorContext = new PythonVisitorContext(fileInput, pythonFile, workingDirectory, myPackage, projectLevelSymbolTable, typeShed, cacheContext, SonarProduct.SONARQUBE);
     assertThat(pythonVisitorContext.sonarProduct()).isEqualTo(SonarProduct.SONARQUBE);
 
     pythonVisitorContext = new PythonVisitorContext(fileInput, pythonFile, workingDirectory, myPackage, projectLevelSymbolTable, cacheContext);

sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonScanner.java

@@ -106,8 +106,14 @@ protected void scanFile(InputFile inputFile) {
       AstNode astNode = parser.parse(pythonFile.content());
       PythonTreeMaker treeMaker = getTreeMaker(inputFile);
       FileInput parse = treeMaker.fileInput(astNode);
-      visitorContext = new PythonVisitorContext(
-        parse, pythonFile, getWorkingDirectory(context), indexer.packageName(inputFile), indexer.projectLevelSymbolTable(), indexer.cacheContext(), context.runtime().getProduct());
+      visitorContext = new PythonVisitorContext(parse,
+        pythonFile,
+        getWorkingDirectory(context),
+        indexer.packageName(inputFile),
+        indexer.projectLevelSymbolTable(),
+        indexer.typeShed(),
+        indexer.cacheContext(),
+        context.runtime().getProduct());
       if (fileType == InputFile.Type.MAIN) {
         saveMeasures(inputFile, visitorContext);
       }

sonar-python-plugin/src/main/java/org/sonar/plugins/python/indexer/PythonIndexer.java

@@ -38,6 +38,7 @@
 import org.sonar.plugins.python.api.tree.FileInput;
 import org.sonar.python.parser.PythonParser;
 import org.sonar.python.semantic.ProjectLevelSymbolTable;
+import org.sonar.python.semantic.v2.TypeShed;
 import org.sonar.python.tree.PythonTreeMaker;
 
 import static org.sonar.python.semantic.SymbolUtils.pythonPackageName;
@@ -51,11 +52,16 @@ public abstract class PythonIndexer {
   private final Map<URI, String> packageNames = new HashMap<>();
   private final PythonParser parser = PythonParser.create();
   private final ProjectLevelSymbolTable projectLevelSymbolTable = new ProjectLevelSymbolTable();
+  private final TypeShed typeShed = new TypeShed();
 
   public ProjectLevelSymbolTable projectLevelSymbolTable() {
     return projectLevelSymbolTable;
   }
 
+  public TypeShed typeShed() {
+    return typeShed;
+  }
+
   public String packageName(InputFile inputFile) {
     return packageNames.computeIfAbsent(inputFile.uri(), k -> pythonPackageName(inputFile.file(), projectBaseDirAbsolutePath));
   }