SONARPY-2153: S6978: Fix False Negative related to resolving torch.nn.Module (#2057)

* SONARPY-2153 update torch typshed

* SONARPY-2153 add CustomStubBase to torchvision class

Author: Seppli11

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

@@ -1,73 +1,81 @@
-import torch.nn as nn
+def import_torch_nn():
+    import torch.nn as nn
 
-class NonCompliantModule(nn.Module):
-     #^^^^^^^^^^^^^^^^^^> {{Inheritance happens here}}
-    def __init__(self): #Noncompliant {{Add a call to super().__init__().}}
-       #^^^^^^^^
-        ...
+    class NonCompliantModule(nn.Module):
+         #^^^^^^^^^^^^^^^^^^> {{Inheritance happens here}}
+        def __init__(self): #Noncompliant {{Add a call to super().__init__().}}
+           #^^^^^^^^
+            ...
 
 
-class NonCompliantModule(OtherModule, nn.Module):
-    def __init__(self): #Noncompliant
-        ...
+    class NonCompliantModule(OtherModule, nn.Module):
+        def __init__(self): #Noncompliant
+            ...
 
-class CompliantModule(NonExistantClass):
-    def __init__(self, encoder, decoder):
-        ...
+    class CompliantModule(NonExistantClass):
+        def __init__(self, encoder, decoder):
+            ...
 
-class CompliantModule(nn.Module):
-    def __init__(self):
-        super().__init__()
-class CompliantModule(nn.Module):
-    pass
+    class CompliantModule(nn.Module):
+        def __init__(self):
+            super().__init__()
+    class CompliantModule(nn.Module):
+        pass
 
-class CompliantModule(nn.Module):
-    def __init__(self, cond):
-        if cond:
+    class CompliantModule(nn.Module):
+        def __init__(self, cond):
+            if cond:
+                super().__init__()
+
+    class CompliantModule(nn.Module):
+        def __init__(self, super):
             super().__init__()
 
-class CompliantModule(nn.Module):
-    def __init__(self, super):
-        super().__init__()
+    class CompliantModule(nn.Module):
+        def __init__(self):
+            (lambda x: x)()
+            (lambda x: x)().test()
+            self.call_super()
 
-class CompliantModule(nn.Module):
-    def __init__(self):
-        (lambda x: x)()
-        (lambda x: x)().test()
-        self.call_super()
+        def call_super(self):
+            super().__init__()
 
-    def call_super(self):
-        super().__init__()
 
+    class CompliantModule(nn.Module):
+        def __init__(self, fake_super):
+            fake_super().__init__()
+            super().not_init()
 
-class CompliantModule(nn.Module):
-    def __init__(self, fake_super):
-        fake_super().__init__()
-        super().not_init()
+        def call_super(self):
+            super().__init__()
 
-    def call_super(self):
-        super().__init__()
+    class CompliantModule2(nn.Module):
+        def __init__(self): #FN
+            do_something()
 
-class CompliantModule2(nn.Module):
-    def __init__(self): #FN
-        do_something()
+        class Nested(Other):
+            def __init__(self):
+                super().__init__()
 
-    class Nested(Other):
+    class UnrelatedCompliantModule:
         def __init__(self):
-            super().__init__()
+            ...
 
-class UnrelatedCompliantModule:
-    def __init__(self):
-        ...
+    def __init__(test):
+        pass
 
-def __init__(test):
-    pass
+    def some_other_func():
+        pass
+
+    class CompliantModule(nn.Module):
+        if cond:
+            class some_func: pass
+        else:
+            def some_func(): pass
 
-def some_other_func():
-    pass
+def import_torch():
+    import torch
 
-class CompliantModule(nn.Module):
-    if cond:
-        class some_func: pass
-    else:
-        def some_func(): pass
+    class TorchNonCompliantModule(torch.nn.Module):
+        def __init__(self): #Noncompliant
+            ...

python-frontend/src/main/resources/org/sonar/python/types/custom_protobuf/torch.nn.modules.module.protobuf

@@ -1,7 +1,7 @@
 
-torch.nn.modules.moduleO
-_IncompatibleKeys)torch.nn.modules.module._IncompatibleKeys"builtins.object�
-_WrappedHook$torch.nn.modules.module._WrappedHook"builtins.object*�
+torch.nn.modules.modulej
+_IncompatibleKeys)torch.nn.modules.module._IncompatibleKeys"*SonarPythonAnalyzerFakeStub.CustomStubBase�
+_WrappedHook$torch.nn.modules.module._WrappedHook"*SonarPythonAnalyzerFakeStub.CustomStubBase*�
 __init__-torch.nn.modules.module._WrappedHook.__init__"
 None*V
 self
L
@@ -26,8 +26,8 @@ $torch.nn.modules.module._WrappedHook"$torch.nn.modules.module._WrappedHook*
 with_module0torch.nn.modules.module._WrappedHook.with_module
 builtins.bool"builtins.boolr>
 module+torch.nn.modules.module._WrappedHook.module
-Any��

-Moduletorch.nn.modules.module.Module"builtins.object*�

+Any҃

+Moduletorch.nn.modules.module.Module"*SonarPythonAnalyzerFakeStub.CustomStubBase*�

 __init__'torch.nn.modules.module.Module.__init__"
 None*J
 self
@

python-frontend/src/main/resources/org/sonar/python/types/custom_protobuf/torch.nn.modules.protobuf

@@ -1,6 +1,6 @@
 
-torch.nn.modules��

-Moduletorch.nn.modules.module.Module"builtins.object*�

+torch.nn.modules҃

+Moduletorch.nn.modules.module.Module"*SonarPythonAnalyzerFakeStub.CustomStubBase*�

 __init__'torch.nn.modules.module.Module.__init__"
 None*J
 self
@

python-frontend/src/main/resources/org/sonar/python/types/custom_protobuf/torch.nn.protobuf

@@ -1,6 +1,6 @@
 
-torch.nn��

-Moduletorch.nn.modules.module.Module"builtins.object*�

+torch.nn҃

+Moduletorch.nn.modules.module.Module"*SonarPythonAnalyzerFakeStub.CustomStubBase*�

 __init__'torch.nn.modules.module.Module.__init__"
 None*J
 self
@

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

@@ -0,0 +1,10 @@
+
+torch*f
+__path__torch.__path__J
+builtins.list[builtins.str]
+builtins.str"builtins.str"builtins.list*�

+__annotations__torch.__annotations__W
+builtins.dict[builtins.str,Any]
+builtins.str"builtins.str
+Any"builtins.dict*
+nntorch.nn 

python-frontend/src/main/resources/org/sonar/python/types/custom_protobuf/torchvision.models._api.protobuf

@@ -1,6 +1,6 @@
 
-torchvision.models._api�
-Weightstorchvision.models._api.Weights"builtins.object*�

+torchvision.models._api�
+Weightstorchvision.models._api.Weights"*SonarPythonAnalyzerFakeStub.CustomStubBase*�

 __eq__&torchvision.models._api.Weights.__eq__"
 builtins.bool"builtins.bool*DB
 torchvision.models._api.Weights"torchvision.models._api.Weights*	
@@ -87,9 +87,9 @@ get_weight"torchvision.models._api.get_weight"J
 CallableType[builtins.function]&
 builtins.function"builtins.function*&
 name

-builtins.str"builtins.strt
-	get_model!torchvision.models._api.get_model"
-Any*&
+builtins.str"builtins.str�

+	get_model!torchvision.models._api.get_model"@
+torch.nn.modules.module.Module"torch.nn.modules.module.Module*&
 name

 builtins.str"builtins.str*
 config

python-frontend/src/main/resources/org/sonar/python/types/custom_protobuf/torchvision.models._utils.protobuf

@@ -41,6 +41,4 @@ classifier-torchvision.models.alexnet.AlexNet.classifier
 builtins.dict[builtins.str,Any]
 builtins.str"builtins.str
 Any"builtins.dict*
-nntorch.nn 
*2
-torch torchvision.models.alexnet.torch
-Any
+nntorch.nn 

python-frontend/src/main/resources/org/sonar/python/types/custom_protobuf/torchvision.models.alexnet.protobuf

@@ -6,8 +6,8 @@
 self
R
 'torchvision.models.convnext.LayerNorm2d"'torchvision.models.convnext.LayerNorm2d*
 
x

-Any�
-CNBlock#torchvision.models.convnext.CNBlock"builtins.object*�
+Any�
+CNBlock#torchvision.models.convnext.CNBlock"torch.nn.modules.module.Module*�
 __init__,torchvision.models.convnext.CNBlock.__init__"
 None*T
 self
J
@@ -35,8 +35,8 @@ norm_layer

 layer_scale/torchvision.models.convnext.CNBlock.layer_scale
 AnyrQ
 stochastic_depth4torchvision.models.convnext.CNBlock.stochastic_depth
-Any�
-CNBlockConfig)torchvision.models.convnext.CNBlockConfig"builtins.object*�
+Any�
+CNBlockConfig)torchvision.models.convnext.CNBlockConfig"*SonarPythonAnalyzerFakeStub.CustomStubBase*�
 __init__2torchvision.models.convnext.CNBlockConfig.__init__"
 None*`
 self
V
@@ -56,8 +56,9 @@ num_layers

 AnyrK
 
 num_layers4torchvision.models.convnext.CNBlockConfig.num_layers
-Any�	
-ConvNeXt$torchvision.models.convnext.ConvNeXt"builtins.object*�
+Any�
+
+ConvNeXt$torchvision.models.convnext.ConvNeXt"torch.nn.modules.module.Module*�
 __init__-torchvision.models.convnext.ConvNeXt.__init__"
 None*V
 self
L

python-frontend/src/main/resources/org/sonar/python/types/custom_protobuf/torchvision.models.convnext.protobuf

@@ -1,6 +1,6 @@
 
-#torchvision.models.detection._utils�	
-BalancedPositiveNegativeSamplerCtorchvision.models.detection._utils.BalancedPositiveNegativeSampler"builtins.object*�
+#torchvision.models.detection._utils�	
+BalancedPositiveNegativeSamplerCtorchvision.models.detection._utils.BalancedPositiveNegativeSampler"*SonarPythonAnalyzerFakeStub.CustomStubBase*�
 __init__Ltorchvision.models.detection._utils.BalancedPositiveNegativeSampler.__init__"
 None*�

 self
�

@@ -23,8 +23,8 @@ Ctorchvision.models.detection._utils.BalancedPositiveNegativeSampler"Ctorchvisio
 batch_size_per_imageXtorchvision.models.detection._utils.BalancedPositiveNegativeSampler.batch_size_per_image
 Anyrs
 positive_fractionUtorchvision.models.detection._utils.BalancedPositiveNegativeSampler.positive_fraction
-Any�
-BoxCoder,torchvision.models.detection._utils.BoxCoder"builtins.object*�
+Any�
+BoxCoder,torchvision.models.detection._utils.BoxCoder"*SonarPythonAnalyzerFakeStub.CustomStubBase*�
 __init__5torchvision.models.detection._utils.BoxCoder.__init__"
 None*f
 self
\
@@ -76,8 +76,8 @@ BTuple[builtins.float,builtins.float,builtins.float,builtins.float]
 weights4torchvision.models.detection._utils.BoxCoder.weights
 AnyrX
 bbox_xform_clip<torchvision.models.detection._utils.BoxCoder.bbox_xform_clip
-Any�
-BoxLinearCoder2torchvision.models.detection._utils.BoxLinearCoder"builtins.object*�

+Any�
+BoxLinearCoder2torchvision.models.detection._utils.BoxLinearCoder"*SonarPythonAnalyzerFakeStub.CustomStubBase*�

 __init__;torchvision.models.detection._utils.BoxLinearCoder.__init__"
 None*r
 self
h
@@ -101,8 +101,8 @@ BTuple[builtins.float,builtins.float,builtins.float,builtins.float]
 boxes

 Anyrb
 normalize_by_sizeDtorchvision.models.detection._utils.BoxLinearCoder.normalize_by_size
-Any�
-Matcher+torchvision.models.detection._utils.Matcher"builtins.object*�
+Any�
+Matcher+torchvision.models.detection._utils.Matcher"*SonarPythonAnalyzerFakeStub.CustomStubBase*�
 __init__4torchvision.models.detection._utils.Matcher.__init__"
 None*d
 self
Z
@@ -162,18 +162,18 @@ SSDMatcher.torchvision.models.detection._utils.SSDMatcher"+torchvision.models.d
 	proposals

 Any*
 weights

-Any�

+Any�

 overwrite_eps1torchvision.models.detection._utils.overwrite_eps"
-None*
-model

-Any*)
+None*K
+model
@
+torch.nn.modules.module.Module"torch.nn.modules.module.Module*)
 eps
 
-builtins.float"builtins.float�
+builtins.float"builtins.float�
 retrieve_out_channels9torchvision.models.detection._utils.retrieve_out_channels"J
 builtins.list[builtins.int]
-builtins.int"builtins.int"builtins.list*
-model

-Any*j
+builtins.int"builtins.int"builtins.list*K
+model
@
+torch.nn.modules.module.Module"torch.nn.modules.module.Module*j
 size
`
  Tuple[builtins.int,builtins.int]
 builtins.int"builtins.int