fix: resolve 5 SonarQube code quality issues

[sonarqube-agent]

Fixed 5 code quality issues including removal of unused variables, elimination of unnecessary function calls, variable naming convention compliance, and code simplification through merging nested conditionals. These changes reduce code complexity, improve maintainability, and enhance memory efficiency while following Python naming conventions.

View Project in SonarCloud

---

Fixed Issues

python:S1481 - Remove the unused local variable "mapping_ids". • MINOR • View issue

Location: PlantUML/construct_mapping_global.py:96

Why is this an issue?

An unused local variable is a variable that has been declared but is not used anywhere in the block of code where it is defined. It is dead code, contributing to unnecessary complexity and leading to confusion when reading the code. Therefore, it should be removed from your code to maintain clarity and efficiency.

What changed

Removes the unused local variable mapping_ids which was declared as an empty list but never used anywhere in the function. This eliminates dead code that contributed to unnecessary complexity and potential confusion when reading the code.

--- a/PlantUML/construct_mapping_global.py
+++ b/PlantUML/construct_mapping_global.py
@@ -96,1 +95,0 @@ def generate_plantuml_global(extracted_data, output_path, colors):
-            mapping_ids = []

python:S7504 - Remove this unnecessary `list()` call on an already iterable object. • MINOR • View issue

Location: PlantUML/construct_mappings.py:131

Why is this an issue?

When iterating over an already iterable object with a for loop or a comprehension, wrapping it with list() adds meaningless clutter that doesn’t provide any functional value. Additionally, it creates unnecessary overhead by generating an intermediate list in memory, which inefficiently consumes memory and can degrade performance, especially with large data structures. Iterating directly over the original object is cleaner and more efficient.

What changed

Removes the unnecessary list() call wrapping extracted_data['resources'].values(), which is already an iterable object. The for loop can iterate directly over .values() without first converting it to a list, eliminating the unnecessary intermediate list allocation and improving both clarity and memory efficiency.

--- a/PlantUML/construct_mappings.py
+++ b/PlantUML/construct_mappings.py
@@ -131,1 +131,1 @@ def structure_data(extracted_data):
-    for mapping in list(extracted_data['resources'].values()):
+    for mapping in extracted_data['resources'].values():

python:S117 - Rename this local variable "cptClass" to match the regular expression ^[_a-z][a-z0-9_]*$. • MINOR • View issue

Location: PlantUML/construct.py:56

Why is this an issue?

A naming convention in software development is a set of guidelines for naming code elements like variables, functions, and classes.
Local variables and function parameters hold the meaning of the written code. Their names should be meaningful and follow a consistent and easily recognizable pattern.
Adhering to a consistent naming convention helps to make the code more readable and understandable, which makes it easier to maintain and debug. It also ensures consistency in the code, especially when multiple developers are working on the same project.

What changed

Renames the local variable 'cptClass' to 'cpt_class' at line 56, which is the exact location flagged by the naming convention rule. The new name 'cpt_class' follows the snake_case pattern (^[a-z][a-z0-9]*$) required by the project's naming convention.

--- a/PlantUML/construct.py
+++ b/PlantUML/construct.py
@@ -56,1 +56,1 @@ def write_to_plantuml_file(data, file_path):
-        cptClass = 0
+        cpt_class = 0

python:S1854 - Remove this assignment to local variable 'resource'; the value is never used. • MAJOR • View issue

Location: PlantUML/construct.py:89

Why is this an issue?

Dead stores refer to assignments made to local variables that are subsequently never used or immediately overwritten. Such assignments are unnecessary and don’t contribute to the functionality or clarity of the code. They may even negatively impact performance. Removing them enhances code cleanliness and readability. Even if the unnecessary operations do not do any harm in terms of the program’s correctness, they are - at best - a waste of computing resources.

What changed

Removes the dead store assignment 'resource = row[0]' at line 89 that was flagged because the value was never used before being reassigned. The variable 'resource' was immediately overwritten later in the code, making this assignment unnecessary.

--- a/PlantUML/construct.py
+++ b/PlantUML/construct.py
@@ -89,1 +88,0 @@ def write_to_plantuml_file(data, file_path):
-            resource = row[0]

python:S1066 - Merge this if statement with the enclosing one. • MAJOR • View issue

Location: PlantUML/construct.py:126

Why is this an issue?

Nested code - blocks of code inside blocks of code - is eventually necessary, but increases complexity. This is why keeping the code as flat as possible, by avoiding unnecessary nesting, is considered a good practice.

What changed

Merges two nested if statements ('if(resource!=row[0])' and 'if(row[2] != "Extension")') into a single combined condition 'if(resource!=row[0]) and (row[2] != "Extension")', reducing unnecessary nesting and improving code readability as recommended by the collapsible-if rule.

--- a/PlantUML/construct.py
+++ b/PlantUML/construct.py
@@ -125,4 +124,3 @@ def write_to_plantuml_file(data, file_path):
-            if(resource!=row[0]) :
-                if(row[2] != 'Extension') : 
-                    f.write( '\n class "' +   row[2] +'" as  ' +  f"class{hashlib.md5(row[2].encode()).hexdigest()}" +" \n")
-                    f.write( "\n    "  +  f"class{hashlib.md5((row[2].encode())).hexdigest()}"  + " --> " +  row[0] +"\n")
+            if(resource!=row[0]) and (row[2] != 'Extension') :
+                f.write( '\n class "' +   row[2] +'" as  ' +  f"class{hashlib.md5(row[2].encode()).hexdigest()}" +" \n")
+                f.write( "\n    "  +  f"class{hashlib.md5((row[2].encode())).hexdigest()}"  + " --> " +  row[0] +"\n")

Have a suggestion or found an issue? Share your feedback here.

---

SonarQube Remediation Agent uses AI. Check for mistakes.

[sonarqube-agent]

⚠️ This repository does not have a CODEOWNERS file. The PR has been created but has not been automatically assigned to any reviewer. To ensure PRs are reviewed promptly, consider adding a CODEOWNERS file to your repository.

[sonarqubecloud]

Quality Gate passed

Issues
6 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud