SONARPY-2182 Fix FP on S5756 when calling TypedDict (#2036)

Author: guillaume-dequenne

its/ruling/src/test/resources/expected/python-S5756.json

@@ -383,13 +383,19 @@ def no_fp_on_decorated_classes():
     employee() # FN
 
 
-def fp_typed_dict():
+def typing_extensions_typed_dict():
     from typing_extensions import TypedDict
     # TypedDict is defined as "TypedDict: object" in typing_extensions.pyi
     # Despite actually being a function
-    x = TypedDict('x', {'a': int, 'b': str}) # Noncompliant
+    x = TypedDict('x', {'a': int, 'b': str}) # OK
 
 
+def typing_typed_dict():
+    from typing_extensions import TypedDict
+    # TypedDict is defined as "TypedDict: object" in typing.pyi
+    # Despite actually being a function
+    x = TypedDict('x', {'a': int, 'b': str}) # OK
+
 def function_type_is_callable():
     import unittest
     # unittest.skip() returns a Callable

python-checks/src/test/resources/checks/nonCallableCalled.py

@@ -28,7 +28,15 @@ public class VarSymbolToDescriptorConverter {
   public Descriptor convert(SymbolsProtos.VarSymbol varSymbol) {
     var fullyQualifiedName = TypeShedUtils.normalizedFqn(varSymbol.getFullyQualifiedName());
     var typeAnnotation = TypeShedUtils.getTypesNormalizedFqn(varSymbol.getTypeAnnotation());
+    if (isTypeAnnotationKnownToBeIncorrect(fullyQualifiedName)) {
+      return new VariableDescriptor(varSymbol.getName(), fullyQualifiedName, null);
+    }
     return new VariableDescriptor(varSymbol.getName(), fullyQualifiedName, typeAnnotation);
   }
 
+  private static boolean isTypeAnnotationKnownToBeIncorrect(String fullyQualifiedName) {
+    // TypedDict is defined to have type "object" in Typeshed, which is incorrect and leads to FPs
+    return "typing.TypedDict".equals(fullyQualifiedName) || "typing_extensions.TypedDict".equals(fullyQualifiedName);
+  }
+
 }

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

@@ -60,4 +60,47 @@ void builtinVarTest() {
     Assertions.assertThat(descriptor.annotatedType()).isEqualTo("int");
   }
 
+  @Test
+  void test_typed_dict_exception() {
+    var converter = new VarSymbolToDescriptorConverter();
+    var symbol = SymbolsProtos.VarSymbol.newBuilder()
+      .setName("TypedDict")
+      .setFullyQualifiedName("typing.TypedDict")
+      .setTypeAnnotation(SymbolsProtos.Type.newBuilder()
+        .setFullyQualifiedName("something")
+        .build())
+      .build();
+
+    var descriptor = (VariableDescriptor) converter.convert(symbol);
+    Assertions.assertThat(descriptor.name()).isEqualTo("TypedDict");
+    Assertions.assertThat(descriptor.fullyQualifiedName()).isEqualTo("typing.TypedDict");
+    Assertions.assertThat(descriptor.annotatedType()).isNull();
+
+    symbol = SymbolsProtos.VarSymbol.newBuilder()
+      .setName("TypedDict")
+      .setFullyQualifiedName("typing_extensions.TypedDict")
+      .setTypeAnnotation(SymbolsProtos.Type.newBuilder()
+        .setFullyQualifiedName("something")
+        .build())
+      .build();
+
+    descriptor = (VariableDescriptor) converter.convert(symbol);
+    Assertions.assertThat(descriptor.name()).isEqualTo("TypedDict");
+    Assertions.assertThat(descriptor.fullyQualifiedName()).isEqualTo("typing_extensions.TypedDict");
+    Assertions.assertThat(descriptor.annotatedType()).isNull();
+
+    symbol = SymbolsProtos.VarSymbol.newBuilder()
+      .setName("TypedDict")
+      .setFullyQualifiedName("unrelated.TypedDict")
+      .setTypeAnnotation(SymbolsProtos.Type.newBuilder()
+        .setFullyQualifiedName("something")
+        .build())
+      .build();
+
+    descriptor = (VariableDescriptor) converter.convert(symbol);
+    Assertions.assertThat(descriptor.name()).isEqualTo("TypedDict");
+    Assertions.assertThat(descriptor.fullyQualifiedName()).isEqualTo("unrelated.TypedDict");
+    Assertions.assertThat(descriptor.annotatedType()).isEqualTo("something");
+  }
+
 }