MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

PY-1416: saner missing docstring inspection.

Browse Source
This commit is contained in:
Dmitry Cheryasov
2010-09-03 18:58:14 +03:00
parent e79ce743bc
commit 2a6368d98b
2 changed files with 26 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
python/src/com/jetbrains/python/PyBundle.properties
+2
View File
@@ -214,6 +214,8 @@ INSP.NAME.raising.new.style.class=Raising a new style class
# PyDocstringInspection
INSP.NAME.docstring=Missing or empty docstring
INSP.no.docstring=Missing docstring
INSP.empty.docstring=Empty docstring
# PyStatementEffectInspection
INSP.NAME.statement.effect=Statement has no effect
python/src/com/jetbrains/python/inspections/PyDocstringInspection.java
+24 -5
View File
@@ -2,8 +2,11 @@ package com.jetbrains.python.inspections;
import com.intellij.codeInspection.LocalInspectionTool;
import com.intellij.codeInspection.ProblemsHolder;
import com.intellij.lang.ASTNode;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiElementVisitor;
import com.intellij.psi.PsiNamedElement;
import com.jetbrains.python.PyBundle;
import com.jetbrains.python.console.PydevConsoleRunner;
import com.jetbrains.python.psi.*;
@@ -45,12 +48,14 @@ public class PyDocstringInspection extends PyInspection {
@Override
public void visitPyFunction(PyFunction node) {
checkDocString(node);
final String name = node.getName();
if (name != null && !name.startsWith("_")) checkDocString(node);
}
@Override
public void visitPyClass(PyClass node) {
checkDocString(node);
final String name = node.getName();
if (name != null && !name.startsWith("_")) checkDocString(node);
}
private void checkDocString(PyDocStringOwner node) {
@@ -59,9 +64,23 @@ public class PyDocstringInspection extends PyInspection {
}
final PyStringLiteralExpression docStringExpression = node.getDocStringExpression();
if (docStringExpression == null) {
registerProblem(node, "Missing docstring"); // node?
} else if (StringUtil.isEmptyOrSpaces(docStringExpression.getStringValue())) {
registerProblem(docStringExpression, "Empty docstring");
PsiElement marker = null;
if (node instanceof PyClass) {
final ASTNode n = ((PyClass)node).getNameNode();
if (n != null) marker = n.getPsi();
}
else if (node instanceof PyFunction) {
final ASTNode n = ((PyFunction)node).getNameNode();
if (n != null) marker = n.getPsi();
}
else if (node instanceof PyFile) {
marker = node.findElementAt(0);
}
if (marker == null) marker = node;
registerProblem(marker, PyBundle.message("INSP.no.docstring"));
}
else if (StringUtil.isEmptyOrSpaces(docStringExpression.getStringValue())) {
registerProblem(docStringExpression, PyBundle.message("INSP.empty.docstring"));
}
}
}