SONARPY-3855 Fix typo in the Django Model class stub file (#902)

GitOrigin-RevId: 801fa94069c36f85b167800511af38f63c1946d2

Author: marc-jasper-sonarsource

python-checks/src/main/java/org/sonar/python/checks/django/DjangoModelStrMethodCheck.java

@@ -16,14 +16,17 @@
  */
 package org.sonar.python.checks.django;
 
-import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
 import org.sonar.check.Rule;
 import org.sonar.plugins.python.api.PythonSubscriptionCheck;
+import org.sonar.plugins.python.api.SubscriptionContext;
 import org.sonar.plugins.python.api.symbols.Symbol;
 import org.sonar.plugins.python.api.tree.ClassDef;
+import org.sonar.plugins.python.api.tree.RegularArgument;
 import org.sonar.plugins.python.api.tree.Tree;
+import org.sonar.plugins.python.api.types.v2.matchers.TypeMatcher;
+import org.sonar.plugins.python.api.types.v2.matchers.TypeMatchers;
 import org.sonar.python.checks.utils.Expressions;
 import org.sonar.python.tree.TreeUtils;
 
@@ -34,14 +37,13 @@
 public class DjangoModelStrMethodCheck extends PythonSubscriptionCheck {
 
   public static final String MESSAGE = "Define a \"__str__\" method for this Django model.";
-  private static final List<String> DJANGO_MODEL_FQN = List.of("django.db.models.Model");
+  private static final TypeMatcher IS_DJANGO_MODEL = TypeMatchers.isType("django.db.models.base.Model");
 
   @Override
   public void initialize(Context context) {
     context.registerSyntaxNodeConsumer(Tree.Kind.CLASSDEF, ctx -> {
       var classDef = (ClassDef) ctx.syntaxNode();
-      var parentClassesFQN = TreeUtils.getParentClassesFQN(classDef);
-      if (DJANGO_MODEL_FQN.equals(parentClassesFQN)) {
+      if (isDirectDjangoModelSubclass(classDef, ctx)) {
         if (isAbstractModel(classDef)) {
           return;
         }
@@ -54,6 +56,18 @@ public void initialize(Context context) {
     });
   }
 
+  private static boolean isDirectDjangoModelSubclass(ClassDef classDef, SubscriptionContext ctx) {
+    var args = classDef.args();
+    if (args == null) {
+      return false;
+    }
+    return args.arguments().stream()
+      .filter(RegularArgument.class::isInstance)
+      .map(RegularArgument.class::cast)
+      .map(RegularArgument::expression)
+      .anyMatch(expr -> IS_DJANGO_MODEL.isTrueFor(expr, ctx));
+  }
+
   private static boolean isAbstractModel(ClassDef classDef) {
     return getMetaClass(classDef)
       .flatMap(metaClass -> getFieldAssignment(metaClass, "abstract"))

python-checks/src/main/java/org/sonar/python/checks/django/DjangoModelStringFieldCheck.java

@@ -34,6 +34,8 @@
 import org.sonar.plugins.python.api.tree.Statement;
 import org.sonar.plugins.python.api.tree.StatementList;
 import org.sonar.plugins.python.api.tree.Tree;
+import org.sonar.plugins.python.api.types.v2.matchers.TypeMatcher;
+import org.sonar.plugins.python.api.types.v2.matchers.TypeMatchers;
 import org.sonar.python.quickfix.TextEditUtils;
 import org.sonar.python.tree.TreeUtils;
 
@@ -45,7 +47,7 @@ public class DjangoModelStringFieldCheck extends PythonSubscriptionCheck {
   private static final String REPLACE_QUICK_FIX_MESSAGE = "Replace with \"blank=True\"";
   private static final String REMOVE_QUICK_FIX_MESSAGE = "Remove the \"null=true\" flag";
 
-  private static final String DJANGO_MODEL_FQN = "django.db.models.Model";
+  private static final TypeMatcher IS_DJANGO_MODEL = TypeMatchers.isOrExtendsType("django.db.models.base.Model");
   public static final Set<String> FIELD_TYPES_FQN = Set.of(
     "django.db.models.CharField",
     "django.db.models.TextField"
@@ -55,7 +57,7 @@ public class DjangoModelStringFieldCheck extends PythonSubscriptionCheck {
   public void initialize(Context context) {
     context.registerSyntaxNodeConsumer(Tree.Kind.CLASSDEF, ctx -> {
       var classDef = (ClassDef) ctx.syntaxNode();
-      if (TreeUtils.getParentClassesFQN(classDef).contains(DJANGO_MODEL_FQN)) {
+      if (IS_DJANGO_MODEL.isTrueFor(classDef.name(), ctx)) {
         var modelClassBodyStatements = classDef.body().statements();
 
         if (isNotManaged(modelClassBodyStatements)) {

python-frontend/src/main/resources/org/sonar/python/types/custom_protobuf/django.apps.config.protobuf

@@ -1,5 +1,5 @@
 
-django.apps.config�
+django.apps.config�
 	AppConfigdjango.apps.config.AppConfig"builtins.object*�

 __init__%django.apps.config.AppConfig.__init__"
 None*F
@@ -8,22 +8,22 @@
 args
 Any*
 kwargs
-Any*�

-	get_model&django.apps.config.AppConfig.get_model"
-	Type[Any]
-Any"type*F
+Any*�
+	get_model&django.apps.config.AppConfig.get_model"g
+!Type[django.db.models.base.Model]:
+django.db.models.base.Model"django.db.models.base.Model"type*F
 self
<
 django.apps.config.AppConfig"django.apps.config.AppConfig*,
 
 model_name

 builtins.str"builtins.str*3
 require_ready

-builtins.bool"builtins.bool 
*�
+builtins.bool"builtins.bool 
*�
 
-get_models'django.apps.config.AppConfig.get_models"K
-typing.Iterator[Type[Any]]
-	Type[Any]
-Any"type"typing.Iterator*F
+get_models'django.apps.config.AppConfig.get_models"�

+2typing.Iterator[Type[django.db.models.base.Model]]g
+!Type[django.db.models.base.Model]:
+django.db.models.base.Model"django.db.models.base.Model"type"typing.Iterator*F
 self
<
 django.apps.config.AppConfig"django.apps.config.AppConfig*:
 include_auto_created

@@ -33,6 +33,4 @@ get_models'django.apps.config.AppConfig.get_models"K
 __annotations__"django.apps.config.__annotations__W
 builtins.dict[builtins.str,Any]
 builtins.str"builtins.str
-Any"builtins.dict**
-Modeldjango.apps.config.Model
-Any
+Any"builtins.dict

python-frontend/src/main/resources/org/sonar/python/types/custom_protobuf/django.apps.protobuf

@@ -1,5 +1,5 @@
 
-django.apps�
+django.apps�
 	AppConfigdjango.apps.config.AppConfig"builtins.object*�

 __init__%django.apps.config.AppConfig.__init__"
 None*F
@@ -8,22 +8,22 @@
 args
 Any*
 kwargs
-Any*�

-	get_model&django.apps.config.AppConfig.get_model"
-	Type[Any]
-Any"type*F
+Any*�
+	get_model&django.apps.config.AppConfig.get_model"g
+!Type[django.db.models.base.Model]:
+django.db.models.base.Model"django.db.models.base.Model"type*F
 self
<
 django.apps.config.AppConfig"django.apps.config.AppConfig*,
 
 model_name

 builtins.str"builtins.str*3
 require_ready

-builtins.bool"builtins.bool 
*�
+builtins.bool"builtins.bool 
*�
 
-get_models'django.apps.config.AppConfig.get_models"K
-typing.Iterator[Type[Any]]
-	Type[Any]
-Any"type"typing.Iterator*F
+get_models'django.apps.config.AppConfig.get_models"�

+2typing.Iterator[Type[django.db.models.base.Model]]g
+!Type[django.db.models.base.Model]:
+django.db.models.base.Model"django.db.models.base.Model"type"typing.Iterator*F
 self
<
 django.apps.config.AppConfig"django.apps.config.AppConfig*:
 include_auto_created


python-frontend/src/main/resources/org/sonar/python/types/custom_protobuf/django.apps.registry.protobuf

@@ -1,5 +1,5 @@
 
-django.apps.registry�
+django.apps.registry�
 Appsdjango.apps.registry.Apps"builtins.object*�

 __init__"django.apps.registry.Apps.__init__"
 None*@
@@ -8,21 +8,21 @@
 args
 Any*
 kwargs
-Any*�
+Any*�
 
-get_models$django.apps.registry.Apps.get_models"G
-builtins.list[Type[Any]]
-	Type[Any]
-Any"type"builtins.list*@
+get_models$django.apps.registry.Apps.get_models"�

+0builtins.list[Type[django.db.models.base.Model]]g
+!Type[django.db.models.base.Model]:
+django.db.models.base.Model"django.db.models.base.Model"type"builtins.list*@
 self
6
 django.apps.registry.Apps"django.apps.registry.Apps*:
 include_auto_created

 builtins.bool"builtins.bool 
*5
 include_swapped

-builtins.bool"builtins.bool 
*�
-	get_model#django.apps.registry.Apps.get_model"
-	Type[Any]
-Any"type*@
+builtins.bool"builtins.bool 
*�
+	get_model#django.apps.registry.Apps.get_model"g
+!Type[django.db.models.base.Model]:
+django.db.models.base.Model"django.db.models.base.Model"type*@
 self
6
 django.apps.registry.Apps"django.apps.registry.Apps*+
 	app_label

@@ -37,8 +37,6 @@ model_name
D
 __annotations__$django.apps.registry.__annotations__W
 builtins.dict[builtins.str,Any]
 builtins.str"builtins.str
-Any"builtins.dict*,
-Modeldjango.apps.registry.Model
-Any*Y
+Any"builtins.dict*Y
 appsdjango.apps.registry.apps6
 django.apps.registry.Apps"django.apps.registry.Apps

python-frontend/src/main/resources/org/sonar/python/types/custom_protobuf/django.db.models.base.protobuf

@@ -0,0 +1,16 @@
+
+django.db.models.base;
+	ModelBasedjango.db.models.base.ModelBase"builtins.type�
+Modeldjango.db.models.base.Model"builtins.object*�

+__init__$django.db.models.base.Model.__init__"
+None*D
+self
:
+django.db.models.base.Model"django.db.models.base.Model*
+args
+Any*
+kwargs
+Any@
bdjango.db.models.base.ModelBase*�

+__annotations__%django.db.models.base.__annotations__W
+builtins.dict[builtins.str,Any]
+builtins.str"builtins.str
+Any"builtins.dict

python-frontend/src/main/resources/org/sonar/python/types/custom_protobuf/django.db.models.protobuf

@@ -10,14 +10,21 @@
 kwargs
 Anyrw
 object'django.db.models.manager.Manager.objectD
- django.db.models.manager.Manager" django.db.models.manager.Manager*q
+ django.db.models.manager.Manager" django.db.models.manager.Manager�
+Modeldjango.db.models.base.Model"builtins.object*�

+__init__$django.db.models.base.Model.__init__"
+None*D
+self
:
+django.db.models.base.Model"django.db.models.base.Model*
+args
+Any*
+kwargs
+Any@
bdjango.db.models.base.ModelBase*q
 __path__django.db.models.__path__J
 builtins.list[builtins.str]
 builtins.str"builtins.str"builtins.list*�

 __annotations__ django.db.models.__annotations__W
 builtins.dict[builtins.str,Any]
 builtins.str"builtins.str
 Any"builtins.dict*%
-managerdjango.db.models.manager 
*(
-Modeldjango.db.models.Model
-Any
+managerdjango.db.models.manager 

python-frontend/typeshed_serializer/checksums/custom.checksum

@@ -1,2 +1,2 @@
 ff99a5ab4ee8349e8b21eeb3668e2e4990aa198e31cc27ca31aee9299e0bed67
-5ed498acd62426c597e0c2ab3ff0ab186b5cc72f27538e9d7627a996c36f4568
+7886ceeda4958304a326174baba1ff7ac6c0298352b3e9699aa7322185d94f69

…sources/custom/django/db/models/base.ipy …sources/custom/django/db/models/base.pyipython-frontend/typeshed_serializer/resources/custom/django/db/models/base.ipy renamed to python-frontend/typeshed_serializer/resources/custom/django/db/models/base.pyi python-frontend/typeshed_serializer/resources/custom/django/db/models/base.ipy renamed to python-frontend/typeshed_serializer/resources/custom/django/db/models/base.pyi

@@ -74,7 +74,7 @@ def test_custom_stubs_serializer(typeshed_custom_stubs):
         custom_stubs_serializer.serialize()
         assert custom_stubs_serializer.get_build_result.call_count == 1
         # Not every files from "typeshed_custom_stubs" build are serialized, as some are builtins
-        assert symbols.save_module.call_count == 335
+        assert symbols.save_module.call_count == 336
 
 
 def test_importer_serializer():