Skip to content

SONARPY-343 Rewrite rules on PyCharm AST #251

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

Merged
andrea-guarino-sonarsource merged 2 commits into from
Jul 17, 2019
Merged

SONARPY-343 Rewrite rules on PyCharm AST #251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d52921a
SONARPY-343 S1716: Rewrite on PyCharm AST
mpaladin Jul 16, 2019
3b5dd2d
SONARPY-343 CommentRegularExpression: Rewrite on PyCharm AST
mpaladin Jul 16, 2019
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
46 changes: 20 additions & 26 deletions python-checks/src/main/java/org/sonar/python/checks/BreakContinueOutsideLoopCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,41 +19,35 @@
*/
package org.sonar.python.checks;

import com.sonar.sslr.api.AstNode;
import com.sonar.sslr.api.AstNodeType;
import java.util.Set;
import com.jetbrains.python.PyElementTypes;
import com.jetbrains.python.psi.PyBreakStatement;
import com.jetbrains.python.psi.PyContinueStatement;
import com.jetbrains.python.psi.PyLoopStatement;
import com.jetbrains.python.psi.PyStatement;
import javax.annotation.Nullable;
import org.sonar.check.Rule;
import org.sonar.python.PythonCheck;
import org.sonar.python.api.PythonGrammar;
import org.sonar.python.SubscriptionContext;

@Rule(key = BreakContinueOutsideLoopCheck.CHECK_KEY)
@Rule(key = "S1716")
public class BreakContinueOutsideLoopCheck extends PythonCheck {

private static final String MESSAGE = "Remove this \"%s\" statement";
public static final String CHECK_KEY = "S1716";

@Override
public Set<AstNodeType> subscribedKinds() {
return immutableSet(PythonGrammar.BREAK_STMT, PythonGrammar.CONTINUE_STMT);
public void initialize(Context context) {
context.registerSyntaxNodeConsumer(PyElementTypes.BREAK_STATEMENT, ctx -> {
PyBreakStatement node = (PyBreakStatement) ctx.syntaxNode();
checkLoopStatement(ctx, node, node.getLoopStatement(), "Remove this \"break\" statement");
});
context.registerSyntaxNodeConsumer(PyElementTypes.CONTINUE_STATEMENT, ctx -> {
PyContinueStatement node = (PyContinueStatement) ctx.syntaxNode();
checkLoopStatement(ctx, node, node.getLoopStatement(), "Remove this \"continue\" statement");
});
}

@Override
public void visitNode(AstNode node) {
AstNode currentParent = node.getParent();
while (currentParent != null){
if (currentParent.is(PythonGrammar.WHILE_STMT, PythonGrammar.FOR_STMT)){
return;
} else if (currentParent.is(PythonGrammar.FUNCDEF, PythonGrammar.CLASSDEF)){
raiseIssue(node);
return;
}
currentParent = currentParent.getParent();
private static void checkLoopStatement(SubscriptionContext ctx, PyStatement node, @Nullable PyLoopStatement loopStatement, String message) {
if (loopStatement == null) {
ctx.addIssue(node.getNode().getFirstChildNode().getPsi(), message);
}
raiseIssue(node);
}

private void raiseIssue(AstNode node) {
addIssue(node, String.format(MESSAGE, node.getToken().getValue()));
}
}

18 changes: 7 additions & 11 deletions python-checks/src/main/java/org/sonar/python/checks/CommentRegularExpressionCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,14 @@
*/
package org.sonar.python.checks;

import com.sonar.sslr.api.Token;
import com.sonar.sslr.api.Trivia;
import com.jetbrains.python.PyTokenTypes;
import java.util.regex.Pattern;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;
import org.sonar.python.PythonCheck;

@Rule(key = CommentRegularExpressionCheck.CHECK_KEY)
@Rule(key = "CommentRegularExpression")
public class CommentRegularExpressionCheck extends PythonCheck {
public static final String CHECK_KEY = "CommentRegularExpression";
private static final String DEFAULT_REGULAR_EXPRESSION = "";
private static final String DEFAULT_MESSAGE = "The regular expression matches this comment";

Expand Down Expand Up @@ -61,14 +59,12 @@ private Pattern pattern() {
}

@Override
public void visitToken(Token token) {
if (pattern() != null) {
for (Trivia trivia : token.getTrivia()) {
if (trivia.isComment() && pattern().matcher(trivia.getToken().getOriginalValue()).matches()) {
addIssue(trivia.getToken(), message);
}
public void initialize(Context context) {
context.registerSyntaxNodeConsumer(PyTokenTypes.END_OF_LINE_COMMENT, ctx -> {
if (pattern().matcher(ctx.syntaxNode().getText()).matches()) {
ctx.addIssue(ctx.syntaxNode(), message);
}
}
});
}

}
1 change: 1 addition & 0 deletions sonar-python-plugin/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -721,6 +721,7 @@
<include>com/intellij/psi/PsiBinaryFile.class</include>
<include>com/intellij/psi/PsiCheckedRenameElement.class</include>
<include>com/intellij/psi/PsiComment.class</include>
<include>com/intellij/psi/PsiDirectory.class</include>
<include>com/intellij/psi/PsiElement.class</include>
<include>com/intellij/psi/PsiElementVisitor$1.class</include>
<include>com/intellij/psi/PsiElementVisitor.class</include>
Expand Down