SONARPY-778 Fix FPs for TypedDict on S5890 (SonarSource#848)

guillaume-dequenne · web-flow · commit a66a41529988 · 2020-08-21T10:58:29.000+02:00
diff --git a/python-checks/src/main/java/org/sonar/python/checks/InconsistentTypeHintCheck.java b/python-checks/src/main/java/org/sonar/python/checks/InconsistentTypeHintCheck.java
@@ -52,6 +52,10 @@ private static void checkAnnotatedAssignment(SubscriptionContext ctx, AnnotatedA
     InferredType inferredType = assignedExpression.type();
     TypeAnnotation annotation = annotatedAssignment.annotation();
     InferredType expectedType = InferredTypes.fromTypeAnnotation(annotation);
+    if (expectedType.mustBeOrExtend("typing.TypedDict")) {
+      // Avoid FPs for TypedDict
+      return;
+    }
     if (!inferredType.isCompatibleWith(expectedType) || isTypeUsedInsteadOfInstance(assignedExpression, expectedType)) {
       String inferredTypeName = InferredTypes.typeName(inferredType);
       String inferredTypeNameMessage = inferredTypeName != null ? String.format(" instead of \"%s\"", inferredTypeName) : "";
diff --git a/python-checks/src/test/resources/checks/inconsistentTypeHint.py b/python-checks/src/test/resources/checks/inconsistentTypeHint.py
@@ -1,4 +1,4 @@
-from typing import SupportsFloat, List, Iterable, Generator, Set, Union, Type
+from typing import SupportsFloat, List, Iterable, Generator, Set, Union, Type, TypedDict
 
 def assigned_directly():
   my_int_nok: int = "hello"  # Noncompliant  {{Assign to "my_int_nok" a value of type "int" instead of "str" or update its type hint.}}
@@ -107,3 +107,14 @@ def metaclasses():
   def a_function(): ...
   another_var: Type = a_function  # Accepted FN
   another_var: Type = unknown_symbol
+
+def type_dict():
+  class MyCustomDict(TypedDict):
+    user_ids: Set[int]
+    message_ids: Set[int]
+
+  def my_dict() -> MyCustomDict:
+    users = {1,2,3}
+    messages = {1,2,3}
+    my_dict: MyCustomDict = dict(user_ids=users, message_ids=messages)  # OK
+    return my_dict
