Skip to content

SONARPY-4539 FP: S1313 should not report version values assigned to __version__ #2300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
erwan-leforestier-sonarsource wants to merge 5 commits into from
Closed

SONARPY-4539 FP: S1313 should not report version values assigned to __version__ #2300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e1d5a77
SONARPY-4539 Ignore version IP values
erwan-leforestier-sonarsource Aug 18, 2026
99febab
SONARPY-4539 Handle parenthesized version targets
erwan-leforestier-sonarsource Aug 18, 2026
51e5557
SONARPY-4539 Reuse parenthesis normalization
erwan-leforestier-sonarsource Aug 18, 2026
9923383
SONARPY-4539 Remove redundant helper documentation
erwan-leforestier-sonarsource Aug 19, 2026
fb3c657
SONARPY-4539 Cover non-name version targets
erwan-leforestier-sonarsource Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion python-checks/src/main/java/org/sonar/python/checks/HardcodedIPCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@
import javax.annotation.Nullable;
import org.sonar.check.Rule;
import org.sonar.plugins.python.api.PythonSubscriptionCheck;
import org.sonar.plugins.python.api.tree.AnnotatedAssignment;
import org.sonar.plugins.python.api.tree.AssignmentStatement;
import org.sonar.plugins.python.api.tree.Expression;
import org.sonar.plugins.python.api.tree.ExpressionList;
import org.sonar.plugins.python.api.tree.Name;
import org.sonar.plugins.python.api.tree.ParenthesizedExpression;
import org.sonar.plugins.python.api.tree.StringLiteral;
import org.sonar.plugins.python.api.tree.Tree;
import org.sonar.python.checks.utils.Expressions;
Expand Down Expand Up @@ -63,7 +69,7 @@ public class HardcodedIPCheck extends PythonSubscriptionCheck {
public void initialize(Context context) {
context.registerSyntaxNodeConsumer(Tree.Kind.STRING_LITERAL, ctx -> {
StringLiteral stringLiteral = (StringLiteral) ctx.syntaxNode();
if (isMultilineString(stringLiteral)) {
if (isMultilineString(stringLiteral) || isVersionLiteral(stringLiteral)) {
return;
}
String content = Expressions.unescape(stringLiteral);
Expand All @@ -88,6 +94,32 @@ public void initialize(Context context) {
});
}

private static boolean isVersionLiteral(StringLiteral stringLiteral) {
Expression assignedValue = stringLiteral;
while (assignedValue.parent() instanceof ParenthesizedExpression parenthesizedExpression) {
assignedValue = parenthesizedExpression;
}
Tree parent = assignedValue.parent();
if (parent instanceof AssignmentStatement assignment) {
return assignment.assignedValue() == assignedValue && hasVersionName(assignment);
}
return parent instanceof AnnotatedAssignment assignment
&& assignment.assignedValue() == assignedValue
&& isVersionName(assignment.variable());
}

private static boolean hasVersionName(AssignmentStatement assignment) {
if (assignment.lhsExpressions().size() != 1) {
return false;
}
ExpressionList lhsExpressions = assignment.lhsExpressions().get(0);
return lhsExpressions.expressions().size() == 1 && isVersionName(lhsExpressions.expressions().get(0));
}

private static boolean isVersionName(Expression expression) {
return Expressions.removeParentheses(expression) instanceof Name name && "__version__".equals(name.name());
}

private static boolean isMultilineString(StringLiteral pyStringLiteralTree) {
return pyStringLiteralTree.stringElements().size() > 1;
}
Expand Down
10 changes: 10 additions & 0 deletions python-checks/src/test/resources/checks/hardcodedIP.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@
fileName = "v0.0.1.200__do_something.sql" # Compliant - suffixed and prefixed
version = "1.0.0.0-1" # Compliant - suffixed

__version__ = "26.8.0.1" # Compliant
__version__ = ("26.8.0.1") # Compliant
__version__: str = "26.8.0.1" # Compliant
(__version__) = "26.8.0.1" # Compliant
version = "26.8.0.1" # Noncompliant
VERSION = "26.8.0.1" # Noncompliant
__version__ = version = "26.8.0.1" # Noncompliant
metadata.__version__ = "26.8.0.1" # Noncompliant
versions["__version__"] = "26.8.0.1" # Noncompliant

"1080:0:0:0:8:800:200C:417A" # Noncompliant {{Make sure using this hardcoded IP address "1080:0:0:0:8:800:200C:417A" is safe here.}}
"[1080::8:800:200C:417A]" # Noncompliant
"::800:200C:417A" # Noncompliant
Expand Down