org.sonar.python.checks.WrongAssignmentOperatorCheck Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of python-checks Show documentation

There is a newer version: 4.23.0.17664

/*
 * SonarQube Python Plugin
 * Copyright (C) 2011-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
 *
 * 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 Sonar Source-Available License for more details.
 *
 * You should have received a copy of the Sonar Source-Available License
 * along with this program; if not, see https://sonarsource.com/license/ssal/
 */
package org.sonar.python.checks;

import org.sonar.check.Rule;
import org.sonar.plugins.python.api.PythonSubscriptionCheck;
import org.sonar.plugins.python.api.tree.AssignmentStatement;
import org.sonar.plugins.python.api.tree.Token;
import org.sonar.plugins.python.api.tree.Tree;
import org.sonar.plugins.python.api.tree.UnaryExpression;

@Rule(key = "S2757")
public class WrongAssignmentOperatorCheck extends PythonSubscriptionCheck {

  private static final String MESSAGE = "Was %s= meant instead?";

  @Override
  public void initialize(Context context) {
    context.registerSyntaxNodeConsumer(Tree.Kind.ASSIGNMENT_STMT, ctx -> {
      AssignmentStatement assignment = (AssignmentStatement) ctx.syntaxNode();
      if (assignment.assignedValue().is(Tree.Kind.UNARY_PLUS) || assignment.assignedValue().is(Tree.Kind.UNARY_MINUS)) {
        if (assignment.equalTokens().size() > 1) {
          return;
        }
        UnaryExpression unaryExpression = (UnaryExpression) assignment.assignedValue();
        Token equalToken = assignment.equalTokens().get(0);
        Token unaryOperator = unaryExpression.operator();
        Token variableLastToken = assignment.lhsExpressions().get(0).lastToken();
        if (noSpacingBetween(variableLastToken, equalToken)
          && noSpacingBetween(unaryOperator, unaryExpression.expression().firstToken())) {
          return;
        }
        if (noSpacingBetween(equalToken, unaryOperator)) {
          ctx.addIssue(equalToken, unaryOperator, String.format(MESSAGE, unaryOperator.value()));
        }
      }
    });
  }

  private static boolean noSpacingBetween(Token first, Token second) {
    return first.line() == second.line()
      && first.column() + first.value().length() == second.column();
  }
}