Merge pull request #70 from cleophass/GCI97-python

GCI108 PreferAppendLeft #Python #DLG #Build

Author: dedece35

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- [#70](https://github.com/green-code-initiative/creedengo-python/pull/70) Add rule GCI97 Prefer Append Left (a rule to prefer the use of `append` over `insert` for list, using deques)
 - [#78](https://github.com/green-code-initiative/creedengo-python/pull/78) Add rule GCI105 on String Concatenation. This rule may also apply to other rules
 - [#74](https://github.com/green-code-initiative/creedengo-python/pull/74) Add rule GCI101 Avoid Conv Bias Before Batch Normalization, a rule specific to Deeplearning
 - [#75](https://github.com/green-code-initiative/creedengo-python/pull/75) Add rule GCI102 avoid non pinned memory for dataloader. This rule is specific to PyTorch and so AI

src/it/java/org/greencodeinitiative/creedengo/python/integration/tests/GCIRulesIT.java

@@ -414,4 +414,19 @@ void testGCI107(){
         checkIssuesForFile(filePath, ruleId, ruleMsg, startLines, endLines, SEVERITY, TYPE, EFFORT_10MIN);
     }
 
+    @Test
+    void testGCI108(){
+        String filePath = "src/preferAppendLeft.py";
+        String ruleId = "creedengo-python:GCI108";
+        String ruleMsg = "Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list";
+        int[] startLines = new int[]{
+            5, 8, 11, 14, 17, 20, 23, 25, 31, 35, 42
+        };
+        int[] endLines = new int[]{
+            5, 8, 11, 14, 17, 20, 23, 25, 31, 35, 42
+        };
+
+        checkIssuesForFile(filePath, ruleId, ruleMsg, startLines, endLines, SEVERITY, TYPE, EFFORT_10MIN);
+    }
+
 }

src/it/test-projects/creedengo-python-plugin-test-project/src/preferAppendLeft.py

@@ -0,0 +1,61 @@
+from collections import deque
+
+# Cas non conformes
+numbers = []
+numbers.insert(0, val)  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+items = []
+items.insert(0, "start")  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+lst = []
+(lst).insert(0, 'x')  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+x = []
+(x).insert(0, value)  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+def insert_first(l, v):
+    l.insert(0, v)  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+some_list = []
+some_list.insert(index=0, object=val)  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+deque_like = []
+deque_like.insert(0, "bad")  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+[1, 2, 3].insert(0, 9)  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+class MyList(list):
+    pass
+
+custom_list = MyList()
+custom_list.insert(0, 'z')  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+def wrapper():
+    lst = []
+    lst.insert(0, "wrapped")  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+
+dq = deque()
+dq.appendleft("start")
+
+mylist = []
+mylist.insert(0.0, val) # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+
+data = []
+data.insert(1, "something")
+
+real_deque = deque()
+real_deque.appendleft("good")
+
+
+other_list = []
+position = 1
+other_list.insert(position, "ok")
+
+
+
+val = "new"
+queue = deque()
+queue.appendleft(val)
+

src/main/java/org/greencodeinitiative/creedengo/python/PythonRuleRepository.java

@@ -49,7 +49,8 @@ public class PythonRuleRepository implements RulesDefinition, PythonCustomRuleRe
             AvoidIterativeMatrixOperations.class,
             AvoidNonPinnedMemoryForDataloaders.class,
             AvoidConvBiasBeforeBatchNorm.class,
-            StringConcatenation.class
+            StringConcatenation.class,
+            PreferAppendLeft.class
     );
 
     public static final String LANGUAGE = "py";

src/main/java/org/greencodeinitiative/creedengo/python/checks/PreferAppendLeft.java

@@ -0,0 +1,78 @@
+/*
+ * creedengo - Python language - Provides rules to reduce the environmental footprint of your Python programs
+ * Copyright © 2024 Green Code Initiative (https://green-code-initiative.org)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.greencodeinitiative.creedengo.python.checks;
+
+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.tree.CallExpression;
+import org.sonar.plugins.python.api.tree.Expression;
+import org.sonar.plugins.python.api.tree.QualifiedExpression;
+import org.sonar.plugins.python.api.tree.RegularArgument;
+import org.sonar.plugins.python.api.tree.NumericLiteral;
+
+import java.util.List;
+
+import static org.sonar.plugins.python.api.tree.Tree.Kind.*;
+
+
+@Rule(key = "GCI108")
+public class PreferAppendLeft extends PythonSubscriptionCheck {
+    public static final String DESCRIPTION = "Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list";
+
+    @Override
+    public void initialize(Context context) {
+        context.registerSyntaxNodeConsumer(CALL_EXPR, this::visitCallExpression);
+    }
+
+    private void visitCallExpression(SubscriptionContext context) {
+        CallExpression callExpression = (CallExpression) context.syntaxNode();
+        if (callExpression.callee().is(QUALIFIED_EXPR)) {
+            QualifiedExpression qualifiedExpression = (QualifiedExpression) callExpression.callee();
+            
+            if (qualifiedExpression.name().name().equals("insert")) {
+                List<org.sonar.plugins.python.api.tree.Argument> arguments = callExpression.arguments();
+                if (arguments.size() >= 2) {
+                    Expression firstArg;
+                    firstArg = ((RegularArgument) arguments.get(0)).expression();
+                     if (arguments.get(0) instanceof RegularArgument) {
+                        firstArg = ((RegularArgument) arguments.get(0)).expression();
+                            if (firstArg.is(NUMERIC_LITERAL)) {
+                                if (isZeroLiteral(firstArg)) {
+                                    context.addIssue(callExpression, DESCRIPTION);
+                                }
+                            }
+                    }
+                }
+            }
+        }
+    }
+    
+    private boolean isZeroLiteral(Expression expression) {
+        if (expression.is(NUMERIC_LITERAL)) {
+            NumericLiteral numericLiteral = (NumericLiteral) expression;
+            String value = numericLiteral.valueAsString();
+            try {
+                return Double.parseDouble(value) == 0.0;
+            } catch (NumberFormatException e) {
+                return false;
+            }
+        }
+        return false;
+    }
+}

src/main/resources/org/greencodeinitiative/creedengo/python/creedengo_way_profile.json

@@ -19,6 +19,7 @@
 		"GCI105",
 		"GCI106",
 		"GCI107",
+		"GCI108",
 		"GCI203",
 		"GCI404"
 	]

src/test/java/org/greencodeinitiative/creedengo/python/checks/PreferAppendLeftTest.java

@@ -0,0 +1,29 @@
+/*
+ * creedengo - Python language - Provides rules to reduce the environmental footprint of your Python programs
+ * Copyright © 2024 Green Code Initiative (https://green-code-initiative.org)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.greencodeinitiative.creedengo.python.checks;
+
+import org.junit.Test;
+import org.sonar.python.checks.utils.PythonCheckVerifier;
+
+public class PreferAppendLeftTest {
+
+    @Test
+    public void test() {
+        PythonCheckVerifier.verify("src/test/resources/checks/preferAppendLeft.py", new PreferAppendLeft());
+    }
+}

src/test/resources/checks/preferAppendLeft.py

@@ -0,0 +1,61 @@
+from collections import deque
+
+# Cas non conformes
+numbers = []
+numbers.insert(0, val)  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+items = []
+items.insert(0, "start")  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+lst = []
+(lst).insert(0, 'x')  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+x = []
+(x).insert(0, value)  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+def insert_first(l, v):
+    l.insert(0, v)  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+some_list = []
+some_list.insert(index=0, object=val)  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+deque_like = []
+deque_like.insert(0, "bad")  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+[1, 2, 3].insert(0, 9)  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+class MyList(list):
+    pass
+
+custom_list = MyList()
+custom_list.insert(0, 'z')  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+def wrapper():
+    lst = []
+    lst.insert(0, "wrapped")  # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+
+dq = deque()
+dq.appendleft("start")
+
+mylist = []
+mylist.insert(0.0, val) # Noncompliant {{Use appendleft with deque instead of .insert(0, val) for modification at the beginning of a list}}
+
+
+data = []
+data.insert(1, "something")
+
+real_deque = deque()
+real_deque.appendleft("good")
+
+
+other_list = []
+position = 1
+other_list.insert(position, "ok")
+
+
+
+val = "new"
+queue = deque()
+queue.appendleft(val)
+