Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
699 changes: 0 additions & 699 deletions its/ruling/src/test/resources/expected/python-S1720.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,18 @@ private enum DeclarationType {

@Override
public void initialize(Context context) {
context.registerSyntaxNodeConsumer(Kind.FILE_INPUT, ctx -> checkDocString(ctx, ((FileInput) ctx.syntaxNode()).docstring()));
context.registerSyntaxNodeConsumer(Kind.FILE_INPUT, ctx -> checkFileInput(ctx, (FileInput) ctx.syntaxNode()));
context.registerSyntaxNodeConsumer(Kind.FUNCDEF, ctx -> checkDocString(ctx, ((FunctionDef) ctx.syntaxNode()).docstring()));
context.registerSyntaxNodeConsumer(Kind.CLASSDEF, ctx -> checkDocString(ctx, ((ClassDef) ctx.syntaxNode()).docstring()));
}

private static void checkFileInput(SubscriptionContext ctx, FileInput fileInput) {
if ("__init__.py".equals(ctx.pythonFile().fileName()) && fileInput.statements() == null) {
return;
}
checkDocString(ctx, fileInput.docstring());
}

private static void checkDocString(SubscriptionContext ctx, @CheckForNull StringLiteral docstring) {
Tree tree = ctx.syntaxNode();
DeclarationType type = getType(tree);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,22 @@ public class MissingDocstringCheckTest {

@Test
public void test() {
PythonCheckVerifier.verify("src/test/resources/checks/missingDocstring.py", new MissingDocstringCheck());
PythonCheckVerifier.verify("src/test/resources/checks/missing_docstring/missingDocstring.py", new MissingDocstringCheck());
}

@Test
public void testMissingDocStringAtModuleLevel() {
PythonCheckVerifier.verify("src/test/resources/checks/missingDocstringAtModuleLevel.py", new MissingDocstringCheck());
PythonCheckVerifier.verify("src/test/resources/checks/missing_docstring/missingDocstringAtModuleLevel.py", new MissingDocstringCheck());
}

@Test
public void testEmptyModule() {
PythonCheckVerifier.verify("src/test/resources/checks/emptyModule.py", new MissingDocstringCheck());
PythonCheckVerifier.verify("src/test/resources/checks/missing_docstring/emptyModule.py", new MissingDocstringCheck());
}

@Test
public void __init__without_docstring() {
PythonCheckVerifier.verifyNoIssue("src/test/resources/checks/missing_docstring/empty_init/__init__.py", new MissingDocstringCheck());
PythonCheckVerifier.verify("src/test/resources/checks/missing_docstring/nonempty_init/__init__.py", new MissingDocstringCheck());
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#Noncompliant@-1 {{Add a docstring to this module.}}
print("hello!")