SONARPY-2185 Avoid converting return types from ProjectLevelSymbolTable to PythonType (#2042)

Author: guillaume-dequenne

python-checks/src/test/java/org/sonar/python/checks/GenericExceptionRaisedCheckTest.java

@@ -19,14 +19,26 @@
  */
 package org.sonar.python.checks;
 
+import java.util.List;
 import org.junit.jupiter.api.Test;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
 
 class GenericExceptionRaisedCheckTest {
 
   @Test
   void test() {
-    PythonCheckVerifier.verify("src/test/resources/checks/genericExceptionRaised.py", new GenericExceptionRaisedCheck());
+    PythonCheckVerifier.verify("src/test/resources/checks/genericException/genericExceptionRaised.py", new GenericExceptionRaisedCheck());
+  }
+
+  @Test
+  void test_multiple_files() {
+    PythonCheckVerifier.verify(
+      List.of(
+        "src/test/resources/checks/genericException/genericExceptionImported.py",
+        "src/test/resources/checks/genericException/genericExceptionImporter.py"
+      ),
+      new GenericExceptionRaisedCheck()
+    );
   }
 
 }

python-checks/src/test/resources/checks/genericException/genericExceptionImported.py

@@ -0,0 +1,2 @@
+class CustomException(Exception):
+    ...

python-checks/src/test/resources/checks/genericException/genericExceptionImporter.py

@@ -0,0 +1,8 @@
+from genericExceptionImported import CustomException
+
+def no_issue_on_method_annotated_with_Self_return_type():
+    raise CustomException().with_traceback("foo")
+
+
+def issue():
+    raise BaseException()  # Noncompliant

python-checks/src/test/resources/checks/genericExceptionRaised.py renamed to python-checks/src/test/resources/checks/genericException/genericExceptionRaised.py

@@ -44,3 +44,7 @@ def python2_multiple_expressions(cond):
         raise 42, BaseException
     else:
         raise BaseException, 42 # Noncompliant
+
+
+def no_issue_with_self_return_type():
+    raise MyException().with_traceback("foo")

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

@@ -38,17 +38,13 @@
 import org.sonar.python.semantic.FunctionSymbolImpl;
 import org.sonar.python.semantic.ProjectLevelSymbolTable;
 import org.sonar.python.semantic.v2.converter.AnyDescriptorToPythonTypeConverter;
-import org.sonar.python.types.InferredTypes;
-import org.sonar.python.types.protobuf.SymbolsProtos;
 import org.sonar.python.types.v2.ClassType;
 import org.sonar.python.types.v2.FunctionType;
 import org.sonar.python.types.v2.LazyTypeWrapper;
 import org.sonar.python.types.v2.Member;
 import org.sonar.python.types.v2.ModuleType;
-import org.sonar.python.types.v2.ObjectType;
 import org.sonar.python.types.v2.ParameterV2;
 import org.sonar.python.types.v2.PythonType;
-import org.sonar.python.types.v2.SimpleTypeWrapper;
 import org.sonar.python.types.v2.TypeOrigin;
 import org.sonar.python.types.v2.TypeWrapper;
 import org.sonar.python.types.v2.UnionType;
@@ -131,7 +127,7 @@ private PythonType convertToFunctionType(FunctionSymbol symbol, Map<Symbol, Pyth
       .map(this::convertParameter)
       .toList();
 
-    var returnType = getReturnTypeFromSymbol(symbol);
+    var returnType = PythonType.UNKNOWN;
 
     TypeOrigin typeOrigin = symbol.isStub() ? TypeOrigin.STUB : TypeOrigin.LOCAL;
 
@@ -151,14 +147,6 @@ private PythonType convertToFunctionType(FunctionSymbol symbol, Map<Symbol, Pyth
     return functionType;
   }
 
-  private TypeWrapper getReturnTypeFromSymbol(FunctionSymbol symbol) {
-    var returnTypeFqns = getReturnTypeFqn(symbol);
-    var returnTypeList = returnTypeFqns.stream().map(lazyTypesContext::getOrCreateLazyTypeWrapper).map(ObjectType::new).toList();
-    //TODO Support type unions (SONARPY-2132)
-    var type = returnTypeList.size() == 1 ? returnTypeList.get(0) : PythonType.UNKNOWN;
-    return new SimpleTypeWrapper(type);
-  }
-
   PythonType resolvePossibleLazyType(String fullyQualifiedName) {
     if (rootModule == null) {
       // If root module has not been created yet, return lazy type
@@ -243,59 +231,4 @@ private PythonType convertToType(Symbol symbol, Map<Symbol, PythonType> createdT
       case OTHER -> PythonType.UNKNOWN;
     };
   }
-
-  private List<String> getReturnTypeFqn(FunctionSymbol symbol) {
-    List<String> fqnList = List.of();
-    if (symbol.annotatedReturnTypeName() != null && !OBJECT_TYPE_FQN.equals(symbol.annotatedReturnTypeName())) {
-      fqnList = List.of(symbol.annotatedReturnTypeName());
-    } else if (symbol instanceof FunctionSymbolImpl functionSymbol && functionSymbol.protobufReturnType() != null) {
-      var protoReturnType = functionSymbol.protobufReturnType();
-      fqnList = getSymbolTypeFqn(protoReturnType);
-    }
-    return fqnList;
-  }
-
-  List<String> getSymbolTypeFqn(SymbolsProtos.Type type) {
-    if (OBJECT_TYPE_FQN.equals(type.getFullyQualifiedName())) {
-      return List.of();
-    }
-    switch (type.getKind()) {
-      case INSTANCE:
-        String typeName = type.getFullyQualifiedName();
-        // _SpecialForm is the type used for some special types, like Callable, Union, TypeVar, ...
-        // It comes from CPython impl: https://github.com/python/cpython/blob/e39ae6bef2c357a88e232dcab2e4b4c0f367544b/Lib/typing.py#L439
-        // This doesn't seem to be very precisely specified in typeshed, because it has special semantic.
-        // To avoid FPs, we treat it as ANY
-        if ("typing._SpecialForm".equals(typeName)) {
-          return List.of();
-        }
-        typeName = typeName.replaceFirst("^builtins\\.", "");
-        return typeName.isEmpty() ? List.of() : List.of(typeName);
-      case TYPE:
-        return List.of("type");
-      case TYPE_ALIAS:
-        return getSymbolTypeFqn(type.getArgs(0));
-      case CALLABLE:
-        // this should be handled as a function type - see SONARPY-953
-        // Creates FPs with `sys.gettrace`
-        return List.of();
-      case UNION:
-        return type.getArgsList().stream().map(this::getSymbolTypeFqn).flatMap(Collection::stream).toList();
-      case TUPLE:
-        return List.of("tuple");
-      case NONE:
-        return List.of("NoneType");
-      case TYPED_DICT:
-        return List.of("dict");
-      case TYPE_VAR:
-        return Optional.of(type)
-          .filter(InferredTypes::filterTypeVar)
-          .map(SymbolsProtos.Type::getFullyQualifiedName)
-          .map(List::of)
-          .orElseGet(List::of);
-      default:
-        return List.of();
-    }
-  }
-
 }