Merge pull request #381 from cleophass/PreferAppendLeft

GCI97 PreferAppendLeft #Python #DLG #RulesSpecifications

Author: dedece35

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- [#381](https://github.com/green-code-initiative/creedengo-rules-specifications/pull/381) Add rule GCI 108 Prefer Append Left
 - [#380](https://github.com/green-code-initiative/creedengo-rules-specifications/pull/380) Added rule GCI107 : DATA - Avoid Iterative Matrix Operations
 
 ### Changed

RULES.md

@@ -84,6 +84,7 @@ Some are applicable for different technologies.
 | GCI105   | Python String Concatenation                                                         | Python String Concatenation - Use Join Instead or f-Strings instead of +=                                                                                                                                                                                                                                                                                                                                                     |                                                                                                                                                                                                                                               | 🚫   | 🚫  | 🚫 | 🚧     | 🚫   | 🚫 | 🚫   |
 | GCI106   | Avoid Square Root Operations In Loop                                                | Using scalar `math.sqrt` (or `numpy.sqrt` on individual values) inside loops leads to inefficient code                                                                                                                                                                                                                                                                                                                        |                                                                                                                                                                                                                                               | 🚫   | 🚫  | 🚫 | ✅      | 🚫   | 🚫 | 🚫   |
 | GCI107   | Data : Avoid Iterative Matrix Operations                                            | Use vectorization by the usage of the built-in functions of TensorFlow, NumPy or Pandas                                                                                                                                                                                                                                                                                                                                       |                                                                                                                                                                                                                                               | 🚫   | 🚫  | 🚫 | 🚧     | 🚫   | 🚫 | 🚫   |
+| GCI108   | Prefer Append Left                                                                  | When you want to insert an element at the beginning of a list, it's better to use a deques or a double linkedlist.                                                                                                                                                                                                                                                                                                            |                                                                                                                                                                                                                                               | ❓  | ❓  | ❓  | 🚀     | ❓  | ❓  | ❓   |
 | GCI203   | Detect unoptimized file formats                                                     | When it is possible, to use svg format image over other image format                                                                                                                                                                                                                                                                                                                                                          |                                                                                                                                                                                                                                               | 🚧   | 🚀  | 🚀 | ✅      | 🚀   | 🚀 | 🚫   |
 | GCI404   | Avoid list comprehension in iterations                                              | Use generator comprehension instead of list comprehension in for loop declaration                                                                                                                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                               | 🚫   | 🚫  | 🚫 | ✅      | 🚫   | 🚫 | 🚫   |
 | GCI522   | Sobriety: Brightness Override                                                       | To avoid draining the battery, iOS and Android devices adapt the brightness of the screen depending on the environment light.                                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                               | 🚫   | 🚫  | ✅  | 🚫     | 🚫   | 🚫 | 🚫   |

src/main/rules/GCI108/GCI108.json

@@ -0,0 +1,16 @@
+{
+    "title": "DATA: Prefer AppendLeft Over Insert(0)",
+    "type": "CODE_SMELL",
+    "status": "ready",
+    "remediation": {
+      "func": "Constant\/Issue",
+      "constantCost": "10min"
+    },
+    "tags": [
+      "creedengo",
+      "eco-design",
+      "performance",
+      "data"
+    ],
+    "defaultSeverity": "Minor"
+  }

src/main/rules/GCI108/python/GCI108.asciidoc

@@ -0,0 +1,48 @@
+When you want to insert an element at the beginning of a list, it's better to use a deques or a double linked list.
+
+== Non compliant Code Example
+
+[source,python]
+----
+numbers.insert(0,val) 
+----
+
+== Compliant Solution
+
+[source,python]
+----
+numbers.appendleft(val)
+----
+
+== Relevance Analysis
+
+The following results were obtained through local experiments.
+
+=== Configuration
+
+* Processor: Intel(R) Core(TM) Ultra 5 135U, 2100 MHz, 12 cores, 14 logical processors
+* RAM: 16 GB
+* CO2 Emissions Measurement: Using CodeCarbon
+
+=== Context
+
+We'll analyze the impact of inserting 10**6 elements at index 0 of a list and compare this with inserting the same number of elements using a deque (deque stands for Double-Ended Queue. It is a data structure that allows adding and removing elements from both ends efficiently. Unlike regular queues, which are typically operated on using FIFO (First In, First Out) principles, a deque supports both FIFO and LIFO (Last In, First Out))
+
+
+=== Impact Analysis
+
+*1. Carbon emissions:*
+
+image::carbon.png[]
+
+*2. Execution time:*
+
+image::time.png[]
+
+=== Conclusion
+
+The results show that using a deque is significantly more efficient than using a list for inserting elements at the beginning. The carbon emissions and execution time are both much lower when using a deque, making it the preferred choice for this operation.
+
+=== References
+https://www.geeksforgeeks.org/deque-in-python/
+https://github.com/green-code-initiative/creedengo-challenge/issues/46

src/main/rules/GCI108/python/carbon.png

@@ -13,4 +13,4 @@
     ],
     "defaultSeverity": "Minor"
   }
-  
+  

src/main/rules/GCI108/python/time.png

@@ -93,4 +93,4 @@ the rule is relevant, it also applies to the case where the user wishes to set h
 
 === References
 
-https://chrissardegna.com/blog/python-expontentiation-performance/
+https://chrissardegna.com/blog/python-expontentiation-performance/