SONARPY-1510 Address the missing TODO fields, and enhance the corresp…

…onding tests.
SonarSource · Oct 20, 2023 · 777a113 · 777a113
1 parent b8423a1
commit 777a113
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 26 deletions.
diff --git a/python-checks/src/main/java/org/sonar/python/checks/GenericClassTypeParameterCheck.java b/python-checks/src/main/java/org/sonar/python/checks/GenericClassTypeParameterCheck.java
@@ -41,7 +41,9 @@
 @Rule(key = "S6792")
 public class GenericClassTypeParameterCheck extends PythonSubscriptionCheck {
 
-  private static final String MESSAGE = "Use the type parameter syntax to declare this generic class.";
+  private static final String MESSAGE = "Use the \"type\" parameter syntax to declare this generic class.";
+  private static final String SECONDARY_MESSAGE_PARENT = "\"Generic\" parent.";
+  private static final String SECONDARY_MESSAGE_ASSIGNMENT = "\"Generic\" is assigned here.";
 
   @Override
   public void initialize(Context context) {
@@ -74,15 +76,15 @@ private static List<IssueLocation> checkGenericValue(Argument argument) {
     Expression expression = ((RegularArgument) argument).expression();
 
     if (isTypingGeneric(expression)) {
-      return List.of(IssueLocation.preciseLocation(argument, "TODO"));
+      return List.of(IssueLocation.preciseLocation(argument, SECONDARY_MESSAGE_PARENT));
     }
     if (expression.is(Tree.Kind.NAME)) {
       Name name = (Name) expression;
       Expression assignedValue = Expressions.singleAssignedValue(name);
       if (assignedValue != null && isTypingGeneric(assignedValue)) {
         return List.of(
-          IssueLocation.preciseLocation(argument, "TODO"),
-          IssueLocation.preciseLocation(assignedValue, "TODO"));
+          IssueLocation.preciseLocation(argument, SECONDARY_MESSAGE_PARENT),
+          IssueLocation.preciseLocation(assignedValue, SECONDARY_MESSAGE_ASSIGNMENT));
       }
     }
     return Collections.emptyList();

diff --git a/python-checks/src/test/resources/checks/genericClassTypeParameter.py b/python-checks/src/test/resources/checks/genericClassTypeParameter.py
@@ -2,38 +2,38 @@
 def class_with_generic_in_declaration():
     from typing import Generic, TypeVar
     _T_co = TypeVar("_T_co", covariant=True, bound=str)
-    class ClassA(Generic[_T_co]):  # Noncompliant {{Use the type parameter syntax to declare this generic class.}}
-        # ^^^^^^ ^^^^^^^^^^^^^^<
+    class ClassA(Generic[_T_co]):  # Noncompliant {{Use the "type" parameter syntax to declare this generic class.}}
+        # ^^^^^^ ^^^^^^^^^^^^^^<                  {{"Generic" parent.}}
         ...
 
 def class_with_typing_generic_in_declaration():
     import typing
     _T_co = typing.TypeVar("_T_co", covariant=True, bound=str)
-    class ClassA(typing.Generic[_T_co]):  # Noncompliant {{Use the type parameter syntax to declare this generic class.}}
-        # ^^^^^^ ^^^^^^^^^^^^^^^^^^^^^<
+    class ClassA(typing.Generic[_T_co]):  # Noncompliant {{Use the "type" parameter syntax to declare this generic class.}}
+        # ^^^^^^ ^^^^^^^^^^^^^^^^^^^^^<                  {{"Generic" parent.}}
         ...
 
 
 def class_with_generic_from_variable():
     from typing import Generic, TypeVar
     _T_co = TypeVar("_T_co", covariant=True, bound=str)
     generic = Generic[_T_co]
-    #         ^^^^^^^^^^^^^^>
-    class ClassA(generic):  # Noncompliant {{Use the type parameter syntax to declare this generic class.}}
-        # ^^^^^^ ^^^^^^^<
+    #         ^^^^^^^^^^^^^^>              {{"Generic" is assigned here.}}
+    class ClassA(generic):  # Noncompliant {{Use the "type" parameter syntax to declare this generic class.}}
+        # ^^^^^^ ^^^^^^^<                  {{"Generic" parent.}}
         ...
 
 def class_with_generic_without_subscription():
     from typing import Generic
-    class ClassA(Generic):  # Noncompliant {{Use the type parameter syntax to declare this generic class.}}
-        # ^^^^^^ ^^^^^^^<
+    class ClassA(Generic):  # Noncompliant {{Use the "type" parameter syntax to declare this generic class.}}
+        # ^^^^^^ ^^^^^^^<                  {{"Generic" parent.}}
         ...
 
 def class_with_generic_multiple_parents(xx):
     from typing import Generic, TypeVar
     _T_co = TypeVar("_T_co", covariant=True, bound=str)
-    class ClassA(xx, Generic[_T_co]):  # Noncompliant {{Use the type parameter syntax to declare this generic class.}}
-        # ^^^^^^     ^^^^^^^^^^^^^^<
+    class ClassA(xx, Generic[_T_co]):  # Noncompliant {{Use the "type" parameter syntax to declare this generic class.}}
+        # ^^^^^^     ^^^^^^^^^^^^^^<                  {{"Generic" parent.}}
         ...
 
 def compliants(xx):
@@ -56,16 +56,9 @@ class ClassWithFunctionCallParent(foo()):
     class ClassWithUnrelatedAssignedValueParent(generic):
         ...
 
+    class Generic:
+        ...
 
-def compliant_3(xx):
-    # Test case where we create a class called Generic, which coincidentally is a subscription expression,
-    # but is not the Generic class that we are interested in.
-    pass
-
-
-def compliant_4(xx):
-    # Test case where we try to instantiate Generic without the subscription check.
-    pass
-
+    class ClassWithDifferentGenericParent(Generic):
+        ...
 
-# Define a class called Generic from a separate module.