Skip to content

Commit 86b0d88

Browse files
echeniquegreciaecheniquegrecia
committed
feat: add rule for loop vs list comprehension
1 parent 458ab17 commit 86b0d88

File tree

5 files changed

+74
-1
lines changed

5 files changed

+74
-1
lines changed

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### Added
1111

12+
- Added rule GCI1200: Detect a loop list and suggest a list comprehension
13+
1214
### Changed
1315

1416
- Correction of various typos in rules documentations

‎RULES.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Some are applicable for different technologies.
7373
| GCI94 | Use orElseGet instead of orElse | Parameter of orElse() is evaluated, even when having a non-empty Optional. Supplier method of orElseGet passed as an argument is only executed when an Optional value isn’t present. Therefore, using orElseGet() will save computing time. | [Optimized use of Java Optional Else](https://github.com/green-code-initiative/creedengo-challenge/issues/77) | ✅ | 🚫 | 🚫 | 🚫 | 🚫 | 🚫 | 🚫 |
7474
| GCI203 | Detect unoptimized file formats | When it is possible, to use svg format image over other image format | | 🚧 | 🚀 | 🚀 | ✅ | 🚀 | 🚀 | 🚫 |
7575
| GCI404 | Avoid list comprehension in iterations | Use generator comprehension instead of list comprehension in for loop declaration | | 🚫 | 🚫 | 🚫 | ✅ | 🚫 | 🚫 | 🚫 |
76-
| GCI522 | Sobriety: Brightness Override | To avoid draining the battery, iOS and Android devices adapt the brightness of the screen depending on the environment light. | | 🚫 | 🚫 | ✅ | 🚫 | 🚫 | 🚫 | 🚫 |
76+
| GCI522 | Sobriety: Brightness Override | To avoid draining the battery, iOS and Android devices adapt the brightness of the screen depending on the environment light.| 🚫 | 🚫 | ✅ | 🚫 | 🚫 | 🚫 | 🚫 |
7777
| GCI523 | Sobriety: Thrifty Geolocation (minTime) | High-precision geolocation typically requires more power from the device's GPS hardware. | | 🚫 | 🚫 | ✅ | 🚫 | 🚫 | 🚫 | 🚫 |
7878
| GCI530 | Sobriety: Torch Free | Turning on the torch mode programmatically must absolutely be avoided because the flashlight is one of the most energy-intensive component. | | 🚫 | 🚫 | ✅ | 🚫 | 🚫 | 🚫 | 🚫 |
7979
| | Use official social media sharing buttons | These JavaScript plugins are very resource-intensive: to work, they require a large number of requests and download heavy files. It is better to prefer direct links. | [cnumr best practices (3rd edition) BP_019](https://github.com/cnumr/best-practices/blob/main/chapters/BP_019_fr.md) | 🚫 | 🚫 | 🚀 | 🚫 | 🚫 | 🚫 | 🚀 |
@@ -83,6 +83,9 @@ Some are applicable for different technologies.
8383
| | Resize images browser-side | Do not resize images using the HEIGHT and WIDTH attributes of the HTML code. This approach requires transferring these images to their original size, wasting bandwidth and CPU cycles. | [cnumr best practices (3rd edition) BP_034](https://github.com/cnumr/best-practices/blob/main/chapters/BP_034_fr.md) | 🚫 | 🚫 | 🚧 | 🚫 | 🚫 | 🚫 | 🚀 |
8484
| | Modify the DOM when traversing it | Modifying the DOM (Document Object Model) as you traverse it can lead to situations where the loop becomes very resource-intensive, especially CPU cycles. | [cnumr best practices (3rd edition) BP_041](https://github.com/cnumr/best-practices/blob/main/chapters/BP_041_fr.md) | 🚫 | 🚫 | 🚧 | 🚫 | 🚫 | 🚫 | 🚫 |
8585
| | Edit DOM elements to make it invisible | When an element of the Document Object Model (DOM) needs to be modified by several properties, each change in style or content will generate a repaint or reflow. | [cnumr best practices (3rd edition) BP_042](https://github.com/cnumr/best-practices/blob/main/chapters/BP_042_fr.md) | 🚫 | 🚫 | 🚀 | 🚫 | 🚫 | 🚫 | 🚫 |
86+
| GSI1200 | To use list comprehension instead for loop in simple iterations | | | ❓ | ❓ | 🚀 | ❓ | ❓ |❓ |❓ |
87+
88+
8689

8790
## Rules to be reworked / measured / clarified
8891

‎src/main/rules/GCI1200/GCI1200.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"title": "To use list comprehension instead for loop in simple iterations",
3+
"type": "CODE_SMELL",
4+
"status": "ready",
5+
"remediation": {
6+
"func": "Constant\/Issue",
7+
"constantCost": "5min"
8+
},
9+
"tags": [
10+
"creedengo",
11+
"eco-design",
12+
"performance",
13+
"comprehension",
14+
"loop",
15+
"iteration"
16+
],
17+
"defaultSeverity": "Minor"
18+
}

‎src/main/rules/GCI1200/python/GCI1200.asciidoc‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
When you use a for loop, on every iteration, you have to look up the variable holding
2+
the list and then call its append() function. A list comprehension can be faster
3+
than a for loop because it’s optimized for performance by Python’s internal mechanisms.
4+
5+
== Non Compliant Code Example
6+
[source,python]
7+
----
8+
list = []
9+
for i in range(0,20):
10+
list.append(i)
11+
----
12+
13+
== Compliant Solution
14+
[source,python]
15+
----
16+
list = [i for i in range(0,20)]
17+
----
18+
19+
== Relevance Analysis
20+
21+
This rule is relevant for scenarios where is needed a simple iteration.
22+
The list comprehensions are often not only more readable
23+
but also faster than using "for loops."
24+
They can simplify the code, but if you put too much logic inside,
25+
they will instead become harder to read and understand.
26+
27+
=== Configuration
28+
29+
* Processor: Apple M1
30+
* RAM: 16 Go
31+
* CO2 Emissions Measurement: Using https://mlco2.github.io/codecarbon/[CodeCarbon]
32+
33+
=== Context
34+
35+
Two approaches were benchmarked:
36+
- *Non-compliant:* For loop
37+
- *Compliant:* List comprehension
38+
39+
=== Impact Analysis
40+
41+
image::results.png[]
42+
43+
== Conclusion
44+
45+
The result of the tests determinated that the list comprehensions
46+
can be more readable, but also an alternative to reduce reduce the C02 emissions.
47+
48+
== References
49+
50+
- https://realpython.com/list-comprehension-python/

‎src/main/rules/GCI1200/python/results.png‎

306 KB
Loading

0 commit comments

Comments
 (0)