allow running PEP8 inspection from Analyze | Inspect Code (PY-9157)

2026-09-27 10:03:11 +07:00 · 2013-11-04 18:55:33 +01:00
parent 5696efbe24
commit 596244e8d2
2 changed files with 112 additions and 0 deletions
@@ -0,0 +1,92 @@
+package com.intellij.codeInspection;
+
+import com.intellij.codeInsight.daemon.impl.AnnotationHolderImpl;
+import com.intellij.lang.annotation.Annotation;
+import com.intellij.lang.annotation.AnnotationSession;
+import com.intellij.lang.annotation.ExternalAnnotator;
+import com.intellij.lang.annotation.HighlightSeverity;
+import com.intellij.openapi.diagnostic.Logger;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiElementVisitor;
+import com.intellij.psi.PsiFile;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class ExternalAnnotatorInspectionVisitor extends PsiElementVisitor {
+  private static final Logger LOG = Logger.getInstance(ExternalAnnotatorInspectionVisitor.class);
+
+  private final ProblemsHolder myHolder;
+  private final ExternalAnnotator myAnnotator;
+  private boolean myOnTheFly;
+
+  public ExternalAnnotatorInspectionVisitor(ProblemsHolder holder, ExternalAnnotator annotator, boolean onTheFly) {
+    myHolder = holder;
+    myAnnotator = annotator;
+    myOnTheFly = onTheFly;
+  }
+
+  public static ProblemDescriptor[] checkFileWithExternalAnnotator(PsiFile file,
+                                                                   InspectionManager manager,
+                                                                   boolean isOnTheFly, ExternalAnnotator annotator) {
+    if (isOnTheFly) {
+      // concrete JSLinterExternalAnnotator implementation does this work
+      return ProblemDescriptor.EMPTY_ARRAY;
+    }
+
+    Object info = annotator.collectInformation(file);
+    if (info != null) {
+      Object annotationResult = annotator.doAnnotate(info);
+      if (annotationResult == null) {
+        return ProblemDescriptor.EMPTY_ARRAY;
+      }
+      AnnotationHolderImpl annotationHolder = new AnnotationHolderImpl(new AnnotationSession(file));
+      annotator.apply(file, annotationResult, annotationHolder);
+      return convertToProblemDescriptors(annotationHolder, manager, file);
+    }
+    return ProblemDescriptor.EMPTY_ARRAY;
+  }
+
+  private static ProblemDescriptor[] convertToProblemDescriptors(@NotNull final List<Annotation> annotations,
+                                                                 @NotNull final InspectionManager manager,
+                                                                 @NotNull final PsiFile file) {
+    if (annotations.size() == 0) {
+      return ProblemDescriptor.EMPTY_ARRAY;
+    }
+
+    final List<ProblemDescriptor> problems = new ArrayList<ProblemDescriptor>();
+    for (final Annotation annotation : annotations) {
+      if (annotation.getSeverity() == HighlightSeverity.INFORMATION ||
+          annotation.getStartOffset() == annotation.getEndOffset()) {
+        continue;
+      }
+
+      final PsiElement startElement = file.findElementAt(annotation.getStartOffset());
+      final PsiElement endElement = file.findElementAt(annotation.getEndOffset() - 1);
+      if (startElement == null || endElement == null) {
+        continue;
+      }
+
+      problems.add(manager.createProblemDescriptor(startElement, endElement, annotation.getMessage(),
+                                                   ProblemHighlightType.GENERIC_ERROR_OR_WARNING, false));
+    }
+    return problems.toArray(new ProblemDescriptor[problems.size()]);
+  }
+
+  @Override
+  public void visitFile(PsiFile file) {
+    if (!myOnTheFly) {
+      ProblemDescriptor[] descriptors = checkFileWithExternalAnnotator(file, myHolder.getManager(),
+                                                                       false, myAnnotator);
+      addDescriptors(descriptors);
+    }
+  }
+
+  private void addDescriptors(@NotNull ProblemDescriptor[] descriptors) {
+    for (ProblemDescriptor descriptor : descriptors) {
+      LOG.assertTrue(descriptor != null, getClass().getName());
+      myHolder.registerProblem(descriptor);
+    }
+  }
+}
@@ -15,8 +15,14 @@
 */
 package com.jetbrains.python.inspections;

+import com.intellij.codeInspection.*;
 import com.intellij.codeInspection.ui.ListEditForm;
 import com.intellij.openapi.util.Key;
+import com.intellij.psi.PsiElementVisitor;
+import com.intellij.psi.PsiFile;
+import com.jetbrains.python.validation.Pep8ExternalAnnotator;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;

 import javax.swing.*;
 import java.util.ArrayList;
@@ -38,4 +44,18 @@ public class PyPep8Inspection extends PyInspection {
    ListEditForm form = new ListEditForm("Ignore errors", ignoredErrors);
    return form.getContentPanel();
  }
+
+  @NotNull
+  @Override
+  public PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder,
+                                        boolean isOnTheFly,
+                                        @NotNull LocalInspectionToolSession session) {
+    return new ExternalAnnotatorInspectionVisitor(holder, new Pep8ExternalAnnotator(), isOnTheFly);
+  }
+
+  @Nullable
+  @Override
+  public ProblemDescriptor[] checkFile(@NotNull PsiFile file, @NotNull InspectionManager manager, boolean isOnTheFly) {
+    return ExternalAnnotatorInspectionVisitor.checkFileWithExternalAnnotator(file, manager, isOnTheFly, new Pep8ExternalAnnotator());
+  }
 }