python/src/com/jetbrains/python/inspections/PyProtectedMemberInspection.java

   1 /*
   2  * Copyright 2000-2014 JetBrains s.r.o.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package com.jetbrains.python.inspections;
  17
  18 import com.intellij.codeInspection.LocalInspectionToolSession;
  19 import com.intellij.codeInspection.LocalQuickFix;
  20 import com.intellij.codeInspection.ProblemHighlightType;
  21 import com.intellij.codeInspection.ProblemsHolder;
  22 import com.intellij.codeInspection.ui.MultipleCheckboxOptionsPanel;
  23 import com.intellij.openapi.util.text.StringUtil;
  24 import com.intellij.psi.PsiElement;
  25 import com.intellij.psi.PsiElementVisitor;
  26 import com.intellij.psi.PsiReference;
  27 import com.intellij.psi.util.PsiTreeUtil;
  28 import com.jetbrains.python.PyBundle;
  29 import com.jetbrains.python.PyNames;
  30 import com.jetbrains.python.codeInsight.controlflow.ScopeOwner;
  31 import com.jetbrains.python.codeInsight.dataflow.scope.ScopeUtil;
  32 import com.jetbrains.python.codeInsight.stdlib.PyNamedTupleType;
  33 import com.jetbrains.python.inspections.quickfix.PyAddPropertyForFieldQuickFix;
  34 import com.jetbrains.python.inspections.quickfix.PyMakePublicQuickFix;
  35 import com.jetbrains.python.inspections.quickfix.PyRenameElementQuickFix;
  36 import com.jetbrains.python.psi.*;
  37 import com.jetbrains.python.psi.types.PyModuleType;
  38 import com.jetbrains.python.psi.types.PyType;
  39 import com.jetbrains.python.refactoring.PyRefactoringUtil;
  40 import com.jetbrains.python.testing.pytest.PyTestUtil;
  41 import org.jetbrains.annotations.Nls;
  42 import org.jetbrains.annotations.NotNull;
  43 import org.jetbrains.annotations.Nullable;
  44
  45 import javax.swing.*;
  46 import java.util.ArrayList;
  47 import java.util.Collection;
  48 import java.util.List;
  49
  50 /**
  51  * User: ktisha
  52  *
  53  * Inspection to detect situations, where
  54  * protected member (i.e. class member with a name beginning with an underscore)
  55  * is access outside the class or a descendant of the class where it's defined.
  56  */
  57 public class PyProtectedMemberInspection extends PyInspection {
  58   public boolean ignoreTestFunctions = true;
  59   public boolean ignoreAnnotations = false;
  60
  61   @Nls
  62   @NotNull
  63   @Override
  64   public String getDisplayName() {
  65     return PyBundle.message("INSP.NAME.protected.member.access");
  66   }
  67
  68   @NotNull
  69   @Override
  70   public PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder,
  71                                         boolean isOnTheFly,
  72                                         @NotNull LocalInspectionToolSession session) {
  73     return new Visitor(holder, session);
  74   }
  75
  76
  77   private class Visitor extends PyInspectionVisitor {
  78     public Visitor(@Nullable ProblemsHolder holder, @NotNull LocalInspectionToolSession session) {
  79       super(holder, session);
  80     }
  81
  82     @Override
  83     public void visitPyImportElement(PyImportElement node) {
  84       final PyStatement statement = node.getContainingImportStatement();
  85       if (!(statement instanceof PyFromImportStatement)) return;
  86       final PyReferenceExpression importReferenceExpression = node.getImportReferenceExpression();
  87       final PyReferenceExpression importSource = ((PyFromImportStatement)statement).getImportSource();
  88       if (importReferenceExpression != null && importSource != null)
  89         checkReference(importReferenceExpression, importSource);
  90     }
  91
  92     @Override
  93     public void visitPyReferenceExpression(PyReferenceExpression node) {
  94       final PyExpression qualifier = node.getQualifier();
  95       if (ignoreAnnotations && PsiTreeUtil.getParentOfType(node, PyAnnotation.class) != null) return;
  96       if (qualifier == null || PyNames.CANONICAL_SELF.equals(qualifier.getText())) return;
  97       checkReference(node, qualifier);
  98     }
  99
 100     private void checkReference(@NotNull final PyReferenceExpression node, @NotNull final PyExpression qualifier) {
 101       if (myTypeEvalContext.getType(qualifier) instanceof PyNamedTupleType) return;
 102       final String name = node.getName();
 103       final List<LocalQuickFix> quickFixes = new ArrayList<LocalQuickFix>();
 104       quickFixes.add(new PyRenameElementQuickFix());
 105
 106       if (name != null && name.startsWith("_") && !name.startsWith("__") && !name.endsWith("__")) {
 107         final PsiReference reference = node.getReference(getResolveContext());
 108         for (final PyInspectionExtension inspectionExtension : PyInspectionExtension.EP_NAME.getExtensions()) {
 109           if (inspectionExtension.ignoreProtectedSymbol(node, myTypeEvalContext)) {
 110             return;
 111           }
 112         }
 113         final PsiElement resolvedExpression = reference.resolve();
 114         final PyClass resolvedClass = getClassOwner(resolvedExpression);
 115         if (resolvedExpression instanceof PyTargetExpression) {
 116           final String newName = StringUtil.trimLeading(name, '_');
 117           if (resolvedClass != null) {
 118             final String qFixName = resolvedClass.getProperties().containsKey(newName) ?
 119                               PyBundle.message("QFIX.use.property") : PyBundle.message("QFIX.add.property");
 120             quickFixes.add(new PyAddPropertyForFieldQuickFix(qFixName));
 121
 122             final Collection<String> usedNames = PyRefactoringUtil.collectUsedNames(resolvedClass);
 123             if (!usedNames.contains(newName)) {
 124               quickFixes.add(new PyMakePublicQuickFix());
 125             }
 126           }
 127         }
 128
 129         final PyClass parentClass = getClassOwner(node);
 130         if (parentClass != null) {
 131           if (PyTestUtil.isPyTestClass(parentClass) && ignoreTestFunctions) return;
 132
 133           if (parentClass.isSubclass(resolvedClass, null))
 134             return;
 135
 136           PyClass outerClass = getClassOwner(parentClass);
 137           while (outerClass != null) {
 138             if (outerClass.isSubclass(resolvedClass, null))
 139               return;
 140
 141             outerClass = getClassOwner(outerClass);
 142           }
 143         }
 144         final PyType type = myTypeEvalContext.getType(qualifier);
 145         final String bundleKey = type instanceof PyModuleType ? "INSP.protected.member.$0.access.module" : "INSP.protected.member.$0.access";
 146         registerProblem(node, PyBundle.message(bundleKey, name), ProblemHighlightType.GENERIC_ERROR_OR_WARNING,  null, quickFixes.toArray(new LocalQuickFix[quickFixes.size()-1]));
 147       }
 148     }
 149
 150     @Nullable
 151     private PyClass getClassOwner(@Nullable PsiElement element) {
 152       for (ScopeOwner owner = ScopeUtil.getScopeOwner(element); owner != null; owner = ScopeUtil.getScopeOwner(owner)) {
 153         if (owner instanceof PyClass) {
 154           return (PyClass)owner;
 155         }
 156       }
 157       return null;
 158     }
 159   }
 160
 161   @Nullable
 162   @Override
 163   public JComponent createOptionsPanel() {
 164     MultipleCheckboxOptionsPanel panel = new MultipleCheckboxOptionsPanel(this);
 165     panel.addCheckbox("Ignore test functions", "ignoreTestFunctions");
 166     panel.addCheckbox("Ignore annotations", "ignoreAnnotations");
 167     return panel;
 168   }
 169 }