SONARPY-1803 Store type definition location in the new type model (#1780

)
SonarSource · May 1, 2024 · d936bd4 · d936bd4
1 parent 5ef0ca4
commit d936bd4
Show file tree

Hide file tree

Showing 19 changed files with 127 additions and 78 deletions.
diff --git a/python-checks/src/main/java/org/sonar/python/checks/NonCallableCalledCheck.java b/python-checks/src/main/java/org/sonar/python/checks/NonCallableCalledCheck.java
@@ -21,17 +21,14 @@
 
 import javax.annotation.Nullable;
 import org.sonar.check.Rule;
-import org.sonar.plugins.python.api.LocationInFile;
 import org.sonar.plugins.python.api.PythonSubscriptionCheck;
 import org.sonar.plugins.python.api.tree.CallExpression;
 import org.sonar.plugins.python.api.tree.Expression;
 import org.sonar.plugins.python.api.tree.Tree;
-import org.sonar.plugins.python.api.types.InferredType;
 import org.sonar.python.types.v2.PythonType;
 import org.sonar.python.types.v2.TriBool;
 
 import static org.sonar.python.tree.TreeUtils.nameFromExpression;
-import static org.sonar.python.types.InferredTypes.typeClassLocation;
 
 @Rule(key = "S5756")
 public class NonCallableCalledCheck extends PythonSubscriptionCheck {
@@ -41,15 +38,12 @@ public void initialize(Context context) {
  context.registerSyntaxNodeConsumer(Tree.Kind.CALL_EXPR, ctx -> {
  CallExpression callExpression = (CallExpression) ctx.syntaxNode();
  Expression callee = callExpression.callee();
- InferredType calleeType = callee.type();
  PythonType type = callee.typeV2();
  if (isNonCallableType(type)) {
  String name = nameFromExpression(callee);
  PreciseIssue preciseIssue = ctx.addIssue(callee, message(type, name));
- LocationInFile location = typeClassLocation(calleeType);
- if (location != null) {
- preciseIssue.secondary(location, "Definition.");
- }
+ type.definitionLocation()
+ .ifPresent(location -> preciseIssue.secondary(location, "Definition."));
  }
  });
  }

diff --git a/python-frontend/src/main/java/org/sonar/plugins/python/api/LocationInFile.java b/python-frontend/src/main/java/org/sonar/plugins/python/api/LocationInFile.java
@@ -19,38 +19,5 @@
  */
 package org.sonar.plugins.python.api;
 
-public class LocationInFile {
- private final String fileId;
- private final int startLine;
- private final int startLineOffset;
- private final int endLine;
- private final int endLineOffset;
-
- public LocationInFile(String fileId, int startLine, int startLineOffset, int endLine, int endLineOffset) {
- this.fileId = fileId;
- this.startLine = startLine;
- this.startLineOffset = startLineOffset;
- this.endLine = endLine;
- this.endLineOffset = endLineOffset;
- }
-
- public String fileId() {
- return fileId;
- }
-
- public int startLine() {
- return startLine;
- }
-
- public int startLineOffset() {
- return startLineOffset;
- }
-
- public int endLine() {
- return endLine;
- }
-
- public int endLineOffset() {
- return endLineOffset;
- }
+public record LocationInFile(String fileId, int startLine, int startLineOffset, int endLine, int endLineOffset) {
 }
diff --git a/python-frontend/src/main/java/org/sonar/plugins/python/api/PythonVisitorContext.java b/python-frontend/src/main/java/org/sonar/plugins/python/api/PythonVisitorContext.java
@@ -49,7 +49,7 @@ public PythonVisitorContext(FileInput rootTree, PythonFile pythonFile, @Nullable
  symbolTableBuilder.visitFileInput(rootTree);
  SymbolTableBuilderV2 symbolTableBuilderV2 = new SymbolTableBuilderV2();
  symbolTableBuilderV2.visitFileInput(rootTree);
- rootTree.accept(new TypeInferenceV2(new ProjectLevelTypeTable(ProjectLevelSymbolTable.empty())));
+ rootTree.accept(new TypeInferenceV2(new ProjectLevelTypeTable(ProjectLevelSymbolTable.empty()), pythonFile));
  }
 
  public PythonVisitorContext(FileInput rootTree, PythonFile pythonFile, @Nullable File workingDirectory, String packageName,
@@ -60,7 +60,7 @@ public PythonVisitorContext(FileInput rootTree, PythonFile pythonFile, @Nullable
  new SymbolTableBuilder(packageName, pythonFile, projectLevelSymbolTable).visitFileInput(rootTree);
  SymbolTableBuilderV2 symbolTableBuilderV2 = new SymbolTableBuilderV2();
  symbolTableBuilderV2.visitFileInput(rootTree);
- rootTree.accept(new TypeInferenceV2(new ProjectLevelTypeTable(projectLevelSymbolTable)));
+ rootTree.accept(new TypeInferenceV2(new ProjectLevelTypeTable(projectLevelSymbolTable), pythonFile));
  }
 
  public PythonVisitorContext(FileInput rootTree, PythonFile pythonFile, @Nullable File workingDirectory, String packageName,
@@ -71,7 +71,7 @@ public PythonVisitorContext(FileInput rootTree, PythonFile pythonFile, @Nullable
  new SymbolTableBuilder(packageName, pythonFile, projectLevelSymbolTable).visitFileInput(rootTree);
  SymbolTableBuilderV2 symbolTableBuilderV2 = new SymbolTableBuilderV2();
  symbolTableBuilderV2.visitFileInput(rootTree);
- rootTree.accept(new TypeInferenceV2(new ProjectLevelTypeTable(projectLevelSymbolTable)));
+ rootTree.accept(new TypeInferenceV2(new ProjectLevelTypeTable(projectLevelSymbolTable), pythonFile));
  }
 
  public PythonVisitorContext(PythonFile pythonFile, RecognitionException parsingException) {

diff --git a/python-frontend/src/main/java/org/sonar/python/semantic/v2/ClassTypeBuilder.java b/python-frontend/src/main/java/org/sonar/python/semantic/v2/ClassTypeBuilder.java
@@ -23,6 +23,8 @@
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
+import javax.annotation.Nullable;
+import org.sonar.plugins.python.api.LocationInFile;
 import org.sonar.python.types.v2.ClassType;
 import org.sonar.python.types.v2.Member;
 import org.sonar.python.types.v2.PythonType;
@@ -35,17 +37,24 @@ public class ClassTypeBuilder implements TypeBuilder<ClassType> {
  List<PythonType> attributes = new ArrayList<>();
  List<PythonType> superClasses = new ArrayList<>();
  List<PythonType> metaClasses = new ArrayList<>();
+ LocationInFile definitionLocation;
 
  @Override
  public ClassType build() {
- return new ClassType(name, members, attributes, superClasses, metaClasses);
+ return new ClassType(name, members, attributes, superClasses, metaClasses, definitionLocation);
  }
 
- public ClassTypeBuilder setName(String name) {
+ public ClassTypeBuilder withName(String name) {
  this.name = name;
  return this;
  }
 
+ @Override
+ public ClassTypeBuilder withDefinitionLocation(@Nullable LocationInFile definitionLocation) {
+ this.definitionLocation = definitionLocation;
+ return this;
+ }
+
  public List<PythonType> superClasses() {
  return superClasses;
  }

diff --git a/python-frontend/src/main/java/org/sonar/python/semantic/v2/FunctionTypeBuilder.java b/python-frontend/src/main/java/org/sonar/python/semantic/v2/FunctionTypeBuilder.java
@@ -24,6 +24,7 @@
 import java.util.Objects;
 import java.util.Optional;
 import javax.annotation.Nullable;
+import org.sonar.plugins.python.api.LocationInFile;
 import org.sonar.plugins.python.api.tree.AnyParameter;
 import org.sonar.plugins.python.api.tree.FunctionDef;
 import org.sonar.plugins.python.api.tree.Name;
@@ -48,6 +49,7 @@ public class FunctionTypeBuilder implements TypeBuilder<FunctionType> {
  private boolean isInstanceMethod;
  private PythonType owner;
  private PythonType returnType = PythonType.UNKNOWN;
+ private LocationInFile definitionLocation;
 
  private static final String CLASS_METHOD_DECORATOR = "classmethod";
  private static final String STATIC_METHOD_DECORATOR = "staticmethod";
@@ -108,8 +110,16 @@ public FunctionTypeBuilder withReturnType(PythonType returnType) {
  return this;
  }
 
+ @Override
+ public FunctionTypeBuilder withDefinitionLocation(@Nullable LocationInFile definitionLocation) {
+ this.definitionLocation = definitionLocation;
+ return this;
+ }
+
  public FunctionType build() {
- return new FunctionType(name, attributes, parameters, returnType, isAsynchronous, hasDecorators, isInstanceMethod, hasVariadicParameter, owner);
+ return new FunctionType(
+ name, attributes, parameters, returnType, isAsynchronous, hasDecorators, isInstanceMethod, hasVariadicParameter, owner, definitionLocation
+ );
  }
 
  private static boolean isInstanceMethod(FunctionDef functionDef) {

diff --git a/python-frontend/src/main/java/org/sonar/python/semantic/v2/SymbolsModuleTypeProvider.java b/python-frontend/src/main/java/org/sonar/python/semantic/v2/SymbolsModuleTypeProvider.java
@@ -121,7 +121,8 @@ private static PythonType convertToFunctionType(FunctionSymbol symbol, Map<Symbo
  .withAsynchronous(symbol.isAsynchronous())
  .withHasDecorators(symbol.hasDecorators())
  .withInstanceMethod(symbol.isInstanceMethod())
- .withHasVariadicParameter(symbol.hasVariadicParameter());
+ .withHasVariadicParameter(symbol.hasVariadicParameter())
+ .withDefinitionLocation(symbol.definitionLocation());
  FunctionType functionType = functionTypeBuilder.build();
  createdTypesBySymbol.put(symbol, functionType);
  return functionType;
@@ -142,7 +143,7 @@ private PythonType convertToClassType(ClassSymbol symbol, Map<Symbol, PythonType
  if (createdTypesBySymbol.containsKey(symbol)) {
  return createdTypesBySymbol.get(symbol);
  }
- ClassType classType = new ClassType(symbol.name());
+ ClassType classType = new ClassType(symbol.name(), symbol.definitionLocation());
  createdTypesBySymbol.put(symbol, classType);
  Set<Member> members =
  symbol.declaredMembers().stream().map(m -> new Member(m.name(), convertToType(m, createdTypesBySymbol))).collect(Collectors.toSet());

diff --git a/python-frontend/src/main/java/org/sonar/python/semantic/v2/TypeBuilder.java b/python-frontend/src/main/java/org/sonar/python/semantic/v2/TypeBuilder.java
@@ -19,9 +19,12 @@
  */
 package org.sonar.python.semantic.v2;
 
+import org.sonar.plugins.python.api.LocationInFile;
 import org.sonar.python.types.v2.PythonType;
 
 public interface TypeBuilder<T extends PythonType> {
 
  T build();
+
+ TypeBuilder<T> withDefinitionLocation(LocationInFile definitionLocation);
 }
diff --git a/python-frontend/src/main/java/org/sonar/python/semantic/v2/TypeInferenceV2.java b/python-frontend/src/main/java/org/sonar/python/semantic/v2/TypeInferenceV2.java
@@ -19,13 +19,15 @@
  */
 package org.sonar.python.semantic.v2;
 
+import java.nio.file.Path;
 import java.util.ArrayDeque;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Deque;
 import java.util.List;
 import java.util.Optional;
 import javax.annotation.Nullable;
+import org.sonar.plugins.python.api.PythonFile;
 import org.sonar.plugins.python.api.tree.ArgList;
 import org.sonar.plugins.python.api.tree.AssignmentStatement;
 import org.sonar.plugins.python.api.tree.BaseTreeVisitor;
@@ -65,14 +67,20 @@
 import org.sonar.python.types.v2.ObjectType;
 import org.sonar.python.types.v2.PythonType;
 
+import static org.sonar.python.semantic.SymbolUtils.pathOf;
+import static org.sonar.python.tree.TreeUtils.locationInFile;
+
 public class TypeInferenceV2 extends BaseTreeVisitor {
 
  private final ProjectLevelTypeTable projectLevelTypeTable;
+ private final String fileId;
 
  private final Deque<PythonType> typeStack = new ArrayDeque<>();
 
- public TypeInferenceV2(ProjectLevelTypeTable projectLevelTypeTable) {
+ public TypeInferenceV2(ProjectLevelTypeTable projectLevelTypeTable, PythonFile pythonFile) {
  this.projectLevelTypeTable = projectLevelTypeTable;
+ Path path = pathOf(pythonFile);
+ this.fileId = path != null ? path.toString() : pythonFile.toString();
  }
 
  @Override
@@ -151,7 +159,9 @@ public void visitListLiteral(ListLiteral listLiteral) {
  public void visitClassDef(ClassDef classDef) {
  scan(classDef.args());
  Name name = classDef.name();
- ClassTypeBuilder classTypeBuilder = new ClassTypeBuilder().setName(name.name());
+ ClassTypeBuilder classTypeBuilder = new ClassTypeBuilder()
+ .withName(name.name())
+ .withDefinitionLocation(locationInFile(classDef.name(), fileId));
  resolveTypeHierarchy(classDef, classTypeBuilder);
  ClassType type = classTypeBuilder.build();
  ((NameImpl) name).typeV2(type);
@@ -212,7 +222,9 @@ public void visitFunctionDef(FunctionDef functionDef) {
  }
 
  private FunctionType buildFunctionType(FunctionDef functionDef) {
- FunctionTypeBuilder functionTypeBuilder = new FunctionTypeBuilder().fromFunctionDef(functionDef);
+ FunctionTypeBuilder functionTypeBuilder = new FunctionTypeBuilder()
+ .fromFunctionDef(functionDef)
+ .withDefinitionLocation(locationInFile(functionDef.name(), fileId));
  ClassType owner = null;
  if (currentType() instanceof ClassType classType) {
  owner = classType;

diff --git a/python-frontend/src/main/java/org/sonar/python/types/v2/ClassType.java b/python-frontend/src/main/java/org/sonar/python/types/v2/ClassType.java
@@ -27,6 +27,8 @@
 import java.util.Optional;
 import java.util.Set;
 import java.util.stream.Collectors;
+import javax.annotation.Nullable;
+import org.sonar.plugins.python.api.LocationInFile;
 
 /**
  * ClassType
@@ -36,14 +38,15 @@ public record ClassType(
  Set<Member> members,
  List<PythonType> attributes,
  List<PythonType> superClasses,
- List<PythonType> metaClasses) implements PythonType {
+ List<PythonType> metaClasses,
+ @Nullable LocationInFile locationInFile) implements PythonType {
 
  public ClassType(String name) {
- this(name, new HashSet<>(), new ArrayList<>(), new ArrayList<>(), new ArrayList<>());
+ this(name, new HashSet<>(), new ArrayList<>(), new ArrayList<>(), new ArrayList<>(), null);
  }
 
- public ClassType(String name, List<PythonType> attributes) {
- this(name, new HashSet<>(), attributes, new ArrayList<>(), new ArrayList<>());
+ public ClassType(String name, @Nullable LocationInFile locationInFile) {
+ this(name, new HashSet<>(), new ArrayList<>(), new ArrayList<>(), new ArrayList<>(), locationInFile);
  }
 
  @Override
@@ -159,6 +162,11 @@ public TriBool instancesHaveMember(String memberName) {
  return resolveMember(memberName).isPresent() ? TriBool.TRUE : TriBool.FALSE;
  }
 
+ @Override
+ public Optional<LocationInFile> definitionLocation() {
+ return Optional.ofNullable(this.locationInFile);
+ }
+
  @Override
  public boolean equals(Object o) {
  if (this == o) return true;

diff --git a/python-frontend/src/main/java/org/sonar/python/types/v2/FunctionType.java b/python-frontend/src/main/java/org/sonar/python/types/v2/FunctionType.java
@@ -23,6 +23,7 @@
 import java.util.Objects;
 import java.util.Optional;
 import javax.annotation.Nullable;
+import org.sonar.plugins.python.api.LocationInFile;
 
 /**
  * FunctionType
@@ -36,7 +37,8 @@ public record FunctionType(
  boolean hasDecorators,
  boolean isInstanceMethod,
  boolean hasVariadicParameter,
- @Nullable PythonType owner
+ @Nullable PythonType owner,
+ @Nullable LocationInFile locationInFile
 ) implements PythonType {
 
  @Override
@@ -59,6 +61,11 @@ public Optional<String> displayName() {
  return Optional.of("Callable");
  }
 
+ @Override
+ public Optional<LocationInFile> definitionLocation() {
+ return Optional.ofNullable(this.locationInFile);
+ }
+
  @Override
  public int hashCode() {
  return Objects.hash(name, attributes, parameters, returnType, isAsynchronous, hasDecorators, isInstanceMethod, hasVariadicParameter);

diff --git a/python-frontend/src/main/java/org/sonar/python/types/v2/ObjectType.java b/python-frontend/src/main/java/org/sonar/python/types/v2/ObjectType.java
@@ -23,6 +23,7 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
+import org.sonar.plugins.python.api.LocationInFile;
 
 public record ObjectType(PythonType type, List<PythonType> attributes, List<Member> members) implements PythonType {
 
@@ -59,4 +60,9 @@ public TriBool hasMember(String memberName) {
  }
  return TriBool.UNKNOWN;
  }
+
+ @Override
+ public Optional<LocationInFile> definitionLocation() {
+ return type.definitionLocation();
+ }
 }
diff --git a/python-frontend/src/main/java/org/sonar/python/types/v2/PythonType.java b/python-frontend/src/main/java/org/sonar/python/types/v2/PythonType.java
@@ -20,6 +20,7 @@
 package org.sonar.python.types.v2;
 
 import java.util.Optional;
+import org.sonar.plugins.python.api.LocationInFile;
 
 /**
  * PythonType
@@ -54,4 +55,8 @@ default Optional<PythonType> resolveMember(String memberName) {
  default TriBool hasMember(String memberName) {
  return TriBool.UNKNOWN;
  }
+
+ default Optional<LocationInFile> definitionLocation() {
+ return Optional.empty();
+ }
 }
diff --git a/python-frontend/src/test/java/org/sonar/plugins/python/api/PythonVisitorContextTest.java b/python-frontend/src/test/java/org/sonar/plugins/python/api/PythonVisitorContextTest.java
@@ -84,8 +84,7 @@ void initModuleFullyQualifiedName() {
  void globalSymbols() {
  String code = "from mod import a, b";
  FileInput fileInput = new PythonTreeMaker().fileInput(PythonParser.create().parse(code));
- PythonFile pythonFile = mock(PythonFile.class, "my_module.py");
- Mockito.when(pythonFile.fileName()).thenReturn("my_module.py");
+ PythonFile pythonFile = pythonFile("my_module.py");
  List<Symbol> modSymbols = Arrays.asList(new SymbolImpl("a", null), new SymbolImpl("b", null));
  Map<String, Set<Symbol>> globalSymbols = Collections.singletonMap("mod", new HashSet<>(modSymbols));
  new PythonVisitorContext(fileInput, pythonFile, null, "my_package", ProjectLevelSymbolTable.from(globalSymbols), null);
@@ -98,8 +97,7 @@ void sonar_product() {
  ProjectLevelSymbolTable projectLevelSymbolTable = ProjectLevelSymbolTable.empty();
  String myPackage = "my_package";
  File workingDirectory = null;
- PythonFile pythonFile = mock(PythonFile.class, "my_module.py");
- Mockito.when(pythonFile.fileName()).thenReturn("my_module.py");
+ PythonFile pythonFile = pythonFile("my_module.py");
  FileInput fileInput = mock(FileInputImpl.class);
 
  PythonVisitorContext pythonVisitorContext = new PythonVisitorContext(fileInput, pythonFile, workingDirectory, myPackage, projectLevelSymbolTable, cacheContext, SonarProduct.SONARLINT);