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

Added ignore shadowed built-in quick-fix (PY-8672)

Browse Source
This commit is contained in:
Andrey Vlasovskikh
2013-09-03 16:34:42 +04:00
parent d6faed247d
commit 46bebeb151
1 changed files with 77 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
python/src/com/jetbrains/python/inspections/PyShadowingBuiltinsInspection.java
+77 -8
View File
@@ -1,15 +1,17 @@
package com.jetbrains.python.inspections;
import com.intellij.codeInspection.LocalInspectionToolSession;
import com.intellij.codeInspection.LocalQuickFix;
import com.intellij.codeInspection.ProblemDescriptor;
import com.intellij.codeInspection.ProblemsHolder;
import com.google.common.collect.ImmutableSet;
import com.intellij.codeInsight.intention.LowPriorityAction;
import com.intellij.codeInspection.*;
import com.intellij.codeInspection.ui.ListEditForm;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.fileEditor.FileEditorManager;
import com.intellij.openapi.fileEditor.OpenFileDescriptor;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.JDOMExternalizableStringList;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.profile.codeInspection.InspectionProjectProfileManager;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiElementVisitor;
import com.intellij.psi.PsiNameIdentifierOwner;
@@ -18,12 +20,17 @@ import com.intellij.refactoring.rename.PsiElementRenameHandler;
import com.intellij.refactoring.rename.RenameProcessor;
import com.intellij.refactoring.rename.RenamePsiElementProcessor;
import com.intellij.refactoring.rename.inplace.VariableInplaceRenamer;
import com.intellij.util.Consumer;
import com.jetbrains.python.codeInsight.dataflow.scope.ScopeUtil;
import com.jetbrains.python.psi.*;
import com.jetbrains.python.psi.impl.PyBuiltinCache;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.swing.*;
import java.util.Collection;
import java.util.Set;
/**
* Warns about shadowing built-in names.
*
@@ -32,17 +39,34 @@ import org.jetbrains.annotations.Nullable;
* @author vlan
*/
public class PyShadowingBuiltinsInspection extends PyInspection {
public JDOMExternalizableStringList ignoredNames = new JDOMExternalizableStringList();
@NotNull
@Override
public String getDisplayName() {
return "Shadowing built-ins";
}
@Override
public JComponent createOptionsPanel() {
final ListEditForm form = new ListEditForm("Ignore built-ins", ignoredNames);
return form.getContentPanel();
}
@NotNull
@Override
public PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder,
boolean isOnTheFly,
@NotNull LocalInspectionToolSession session) {
return new Visitor(holder, session);
return new Visitor(holder, session, ignoredNames);
}
private static class Visitor extends PyInspectionVisitor {
public Visitor(@Nullable ProblemsHolder holder, @NotNull LocalInspectionToolSession session) {
private final Set<String> myIgnoredNames;
public Visitor(@Nullable ProblemsHolder holder, @NotNull LocalInspectionToolSession session, @NotNull Collection<String> ignoredNames) {
super(holder, session);
myIgnoredNames = ImmutableSet.copyOf(ignoredNames);
}
@Override
@@ -71,13 +95,16 @@ public class PyShadowingBuiltinsInspection extends PyInspection {
private void processElement(@NotNull PsiNameIdentifierOwner element) {
final String name = element.getName();
if (name != null) {
if (name != null && !myIgnoredNames.contains(name)) {
final PyBuiltinCache builtinCache = PyBuiltinCache.getInstance(element);
final PsiElement builtin = builtinCache.getByName(name);
if (builtin != null && !PyUtil.inSameFile(builtin, element)) {
final PsiElement identifier = element.getNameIdentifier();
registerProblem(identifier != null ? identifier : element, "Shadows a built-in with the same name",
new PyRenameElementQuickFix());
ProblemHighlightType.GENERIC_ERROR_OR_WARNING,
null,
new PyRenameElementQuickFix(),
new PyIgnoreBuiltinQuickFix(name));
}
}
}
@@ -128,5 +155,47 @@ public class PyShadowingBuiltinsInspection extends PyInspection {
}
}
}
private static class PyIgnoreBuiltinQuickFix implements LocalQuickFix, LowPriorityAction {
@NotNull private final String myName;
private PyIgnoreBuiltinQuickFix(@NotNull String name) {
myName = name;
}
@NotNull
@Override
public String getName() {
return getFamilyName() + " \"" + myName + "\"";
}
@NotNull
@Override
public String getFamilyName() {
return "Ignore shadowed built-in name";
}
@Override
public void applyFix(@NotNull Project project, @NotNull ProblemDescriptor descriptor) {
final PsiElement element = descriptor.getPsiElement();
if (element != null) {
final InspectionProfile profile = InspectionProjectProfileManager.getInstance(project).getInspectionProfile();
// For changing persistent inspection settings we should use the old serializer (put the inspection into
// inspection-black-list.txt) and modify settings inside profile.modifyProfile()
profile.modifyProfile(new Consumer<ModifiableModel>() {
@Override
public void consume(ModifiableModel model) {
final String toolName = PyShadowingBuiltinsInspection.class.getSimpleName();
final PyShadowingBuiltinsInspection inspection = (PyShadowingBuiltinsInspection)model.getUnwrappedTool(toolName, element);
if (inspection != null) {
if (!inspection.ignoredNames.contains(myName)) {
inspection.ignoredNames.add(myName);
}
}
}
});
}
}
}
}
}