SONARPY-1756 exclude function from the built-in shadowing check (#2023)

Author: Seppli11

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

@@ -284,19 +284,9 @@
 546,
 555
 ],
-"project:django-2.2.3/django/contrib/gis/db/models/functions.py": [
-54,
-248,
-342,
-356,
-391
-],
 "project:django-2.2.3/django/contrib/messages/storage/cookie.py": [
 155
 ],
-"project:django-2.2.3/django/contrib/postgres/search.py": [
-158
-],
 "project:django-2.2.3/django/contrib/sessions/backends/base.py": [
 96,
 103
@@ -340,9 +330,6 @@
 "project:django-2.2.3/django/utils/http.py": [
 184
 ],
-"project:django-2.2.3/django/views/debug.py": [
-417
-],
 "project:django-2.2.3/django/views/generic/dates.py": [
 618
 ],
@@ -374,26 +361,20 @@
 ],
 "project:mypy-0.782/mypy/checker.py": [
 2728,
-2996,
 4826
 ],
 "project:mypy-0.782/mypy/checkexpr.py": [
 945,
 1893
 ],
-"project:mypy-0.782/mypy/checkmember.py": [
-388,
-475
-],
 "project:mypy-0.782/mypy/checkstrformat.py": [
 86,
 807,
 835,
 875
 ],
 "project:mypy-0.782/mypy/errors.py": [
-291,
-294
+291
 ],
 "project:mypy-0.782/mypy/find_sources.py": [
 107
@@ -411,9 +392,6 @@
 "project:mypy-0.782/mypy/nodes.py": [
 893
 ],
-"project:mypy-0.782/mypy/scope.py": [
-113
-],
 "project:mypy-0.782/mypy/semanal.py": [
 729
 ],
@@ -456,17 +434,11 @@
 "project:mypy-0.782/mypyc/codegen/emitmodule.py": [
 113
 ],
-"project:mypy-0.782/mypyc/irbuild/builder.py": [
-746
-],
 "project:mypy-0.782/mypyc/irbuild/expression.py": [
-154,
-219,
 310,
 349
 ],
 "project:mypy-0.782/mypyc/irbuild/ll_builder.py": [
-378,
 589
 ],
 "project:mypy-0.782/mypyc/irbuild/statement.py": [
@@ -566,9 +538,6 @@
 84,
 190
 ],
-"project:numpy-1.16.4/numpy/lib/arraypad.py": [
-1214
-],
 "project:numpy-1.16.4/numpy/lib/histograms.py": [
 1021
 ],
@@ -595,9 +564,6 @@
 185,
 192
 ],
-"project:numpy-1.16.4/tools/cythonize.py": [
-197
-],
 "project:numpy-1.16.4/tools/npy_tempita/__init__.py": [
 131,
 241,
@@ -607,34 +573,10 @@
 "project:pecos/test/pecos/apps/text2text/test_text2text.py": [
 139
 ],
-"project:tensorflow/python/data/experimental/kernel_tests/optimization/filter_fusion_test.py": [
-54
-],
-"project:tensorflow/python/data/experimental/kernel_tests/optimization/map_and_filter_fusion_test.py": [
-69,
-109
-],
-"project:tensorflow/python/data/experimental/kernel_tests/optimization/map_parallelization_test.py": [
-50
-],
-"project:tensorflow/python/framework/convert_to_constants.py": [
-192,
-543
-],
 "project:tensorflow/python/framework/dtypes.py": [
 167,
 167
 ],
-"project:tensorflow/python/keras/layers/core.py": [
-1001,
-1047,
-1392
-],
-"project:tensorflow/python/keras/layers/legacy_rnn/rnn_cell_wrapper_impl.py": [
-302,
-386,
-484
-],
 "project:tensorflow/python/kernel_tests/conv_ops_test.py": [
 2980,
 2987,
@@ -708,29 +650,10 @@
 "project:tensorflow/python/ops/signal/dct_ops.py": [
 101
 ],
-"project:tensorflow/python/profiler/pprof_profiler.py": [
-135
-],
-"project:tensorflow/python/saved_model/function_deserialization.py": [
-235,
-355
-],
-"project:tensorflow/python/saved_model/load_v1_in_v2_test.py": [
-296,
-321,
-354
-],
-"project:tensorflow/python/saved_model/signature_serialization.py": [
-42
-],
-"project:tensorflow/python/tools/saved_model_cli_test.py": [
-250
-],
 "project:tornado-2.3/demos/appengine/markdown.py": [
 577,
 585,
-1504,
-1541
+1504
 ],
 "project:tornado-2.3/demos/blog/blog.py": [
 112,
@@ -739,8 +662,7 @@
 "project:tornado-2.3/demos/blog/markdown.py": [
 577,
 585,
-1504,
-1541
+1504
 ],
 "project:tornado-2.3/demos/s3server/s3server.py": [
 111
@@ -899,7 +821,6 @@
 ],
 "project:twisted-12.1.0/twisted/manhole/explorer.py": [
 71,
-326,
 525
 ],
 "project:twisted-12.1.0/twisted/manhole/gladereactor.py": [
@@ -1001,9 +922,6 @@
 820,
 837
 ],
-"project:twisted-12.1.0/twisted/python/threadpool.py": [
-163
-],
 "project:twisted-12.1.0/twisted/python/versions.py": [
 212
 ],
@@ -1017,9 +935,6 @@
 179,
 271
 ],
-"project:twisted-12.1.0/twisted/spread/jelly.py": [
-884
-],
 "project:twisted-12.1.0/twisted/spread/pb.py": [
 888
 ],
@@ -1081,9 +996,6 @@
 52,
 66
 ],
-"project:twisted-12.1.0/twisted/web/soap.py": [
-63
-],
 "project:twisted-12.1.0/twisted/web/static.py": [
 147
 ],
@@ -1126,9 +1038,6 @@
 833,
 853
 ],
-"project:twisted-12.1.0/twisted/web/xmlrpc.py": [
-160
-],
 "project:twisted-12.1.0/twisted/words/protocols/jabber/error.py": [
 174,
 309

python-checks/src/main/java/org/sonar/python/checks/BuiltinShadowingAssignmentCheck.java

@@ -58,7 +58,7 @@ public class BuiltinShadowingAssignmentCheck extends PythonSubscriptionCheck {
   public static final String RENAME_PREFIX = "_";
   public static final String QUICK_FIX_MESSAGE_FORMAT = "Rename to " + RENAME_PREFIX+ " %s";
   private final Map<Symbol, PreciseIssue> variableIssuesRaised = new HashMap<>();
-  public static final String ELLIPSIS = "ellipsis";
+  private static final Set<String> notBuiltins = Set.of("ellipsis", "function");
 
   @Override
   public void initialize(Context context) {
@@ -185,8 +185,7 @@ private boolean shouldReportIssue(Tree tree) {
   }
 
   private boolean isBuiltInName(Name name) {
-    // Workaround to fix the FP raised. A definite fix should be implemented as part of SONARPY-1531.
-    if (ELLIPSIS.equals(name.name())) {
+    if (notBuiltins.contains(name.name())) {
       return false;
     }
     return TypeShed.builtinSymbols().containsKey(name.name());

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

@@ -38,3 +38,6 @@ def ellipsis_test():
     ellipsis = "" # OK
     Ellipsis = 42 # Noncompliant {{Rename this variable; it shadows a builtin.}}
     ellipsis = "..." # OK
+
+def function_test():
+    function = "" # OK