Skip to content

Localizing inspection, intentions and quick fixes (part 2) #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VISTALL merged 1 commit into from
Oct 10, 2025
Merged

Localizing inspection, intentions and quick fixes (part 2) #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
324 changes: 151 additions & 173 deletions ...impl/src/main/java/com/jetbrains/python/impl/inspections/PyProtectedMemberInspection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,190 +36,168 @@
import consulo.language.psi.PsiElementVisitor;
import consulo.language.psi.PsiReference;
import consulo.language.psi.util.PsiTreeUtil;
import consulo.localize.LocalizeValue;
import consulo.python.impl.localize.PyLocalize;
import consulo.util.lang.StringUtil;
import org.jetbrains.annotations.Nls;

import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

/**
* User: ktisha
* <p>
* Inspection to detect situations, where
* protected member (i.e. class member with a name beginning with an underscore)
* is access outside the class or a descendant of the class where it's defined.
*
* @author ktisha
*/
@ExtensionImpl
public class PyProtectedMemberInspection extends PyInspection
{
@Nonnull
@Override
public InspectionToolState<?> createStateProvider()
{
return new PyProtectedMemberInspectionState();
}

@Nls
@Nonnull
@Override
public String getDisplayName()
{
return PyBundle.message("INSP.NAME.protected.member.access");
}

@Nonnull
@Override
public PsiElementVisitor buildVisitor(@Nonnull ProblemsHolder holder,
boolean isOnTheFly,
@Nonnull LocalInspectionToolSession session,
Object state)
{
PyProtectedMemberInspectionState inspectionState = (PyProtectedMemberInspectionState) state;
return new Visitor(holder, session, inspectionState);
}


private class Visitor extends PyInspectionVisitor
{
private final PyProtectedMemberInspectionState myState;

public Visitor(@Nullable ProblemsHolder holder, @Nonnull LocalInspectionToolSession session, PyProtectedMemberInspectionState inspectionState)
{
super(holder, session);
myState = inspectionState;
}

@Override
public void visitPyImportElement(PyImportElement node)
{
final PyStatement statement = node.getContainingImportStatement();
if(!(statement instanceof PyFromImportStatement))
{
return;
}
final PyReferenceExpression importReferenceExpression = node.getImportReferenceExpression();
final PyReferenceExpression importSource = ((PyFromImportStatement) statement).getImportSource();
if(importReferenceExpression != null && importSource != null && !isImportFromTheSamePackage(importSource))
{
checkReference(importReferenceExpression, importSource);
}
}

private boolean isImportFromTheSamePackage(PyReferenceExpression importSource)
{
PsiDirectory directory = importSource.getContainingFile().getContainingDirectory();
if(directory != null && PyUtil.isPackage(directory, true, importSource.getContainingFile()) &&
directory.getName().equals(importSource.getName()))
{
return true;
}
return false;
}

@Override
public void visitPyReferenceExpression(PyReferenceExpression node)
{
final PyExpression qualifier = node.getQualifier();
if(myState.ignoreAnnotations && PsiTreeUtil.getParentOfType(node, PyAnnotation.class) != null)
{
return;
}
if(qualifier == null || PyNames.CANONICAL_SELF.equals(qualifier.getText()))
{
return;
}
checkReference(node, qualifier);
}

private void checkReference(@Nonnull final PyReferenceExpression node, @Nonnull final PyExpression qualifier)
{
if(myTypeEvalContext.getType(qualifier) instanceof PyNamedTupleType)
{
return;
}
final String name = node.getName();
final List<LocalQuickFix> quickFixes = new ArrayList<>();
quickFixes.add(new PyRenameElementQuickFix());

if(name != null && name.startsWith("_") && !name.startsWith("__") && !name.endsWith("__"))
{
final PsiReference reference = node.getReference(getResolveContext());
for(final PyInspectionExtension inspectionExtension : PyInspectionExtension.EP_NAME.getExtensions())
{
if(inspectionExtension.ignoreProtectedSymbol(node, myTypeEvalContext))
{
return;
}
}
final PsiElement resolvedExpression = reference.resolve();
final PyClass resolvedClass = getClassOwner(resolvedExpression);
if(resolvedExpression instanceof PyTargetExpression)
{
final String newName = StringUtil.trimLeading(name, '_');
if(resolvedClass != null)
{
final String qFixName =
resolvedClass.getProperties().containsKey(newName) ? PyBundle.message("QFIX.use.property") : PyBundle.message(
"QFIX.add.property");
quickFixes.add(new PyAddPropertyForFieldQuickFix(qFixName));

final Collection<String> usedNames = PyRefactoringUtil.collectUsedNames(resolvedClass);
if(!usedNames.contains(newName))
{
quickFixes.add(new PyMakePublicQuickFix());
}
}
}

final PyClass parentClass = getClassOwner(node);
if(parentClass != null)
{
if(PyTestUtil.isPyTestClass(parentClass, null) && myState.ignoreTestFunctions)
{
return;
}

if(parentClass.isSubclass(resolvedClass, myTypeEvalContext))
{
return;
}

PyClass outerClass = getClassOwner(parentClass);
while(outerClass != null)
{
if(outerClass.isSubclass(resolvedClass, myTypeEvalContext))
{
return;
}

outerClass = getClassOwner(outerClass);
}
}
final PyType type = myTypeEvalContext.getType(qualifier);
final String bundleKey =
type instanceof PyModuleType ? "INSP.protected.member.$0.access.module" : "INSP.protected.member.$0.access";
registerProblem(node,
PyBundle.message(bundleKey, name),
ProblemHighlightType.GENERIC_ERROR_OR_WARNING,
null,
quickFixes.toArray(new LocalQuickFix[quickFixes.size() - 1]));
}
}

@Nullable
private PyClass getClassOwner(@Nullable PsiElement element)
{
for(ScopeOwner owner = ScopeUtil.getScopeOwner(element); owner != null; owner = ScopeUtil.getScopeOwner(owner))
{
if(owner instanceof PyClass)
{
return (PyClass) owner;
}
}
return null;
}
}
public class PyProtectedMemberInspection extends PyInspection {
@Nonnull
@Override
public InspectionToolState<?> createStateProvider() {
return new PyProtectedMemberInspectionState();
}

@Nonnull
@Override
public LocalizeValue getDisplayName() {
return PyLocalize.inspNameProtectedMemberAccess();
}

@Nonnull
@Override
public PsiElementVisitor buildVisitor(
@Nonnull ProblemsHolder holder,
boolean isOnTheFly,
@Nonnull LocalInspectionToolSession session,
Object state
) {
PyProtectedMemberInspectionState inspectionState = (PyProtectedMemberInspectionState) state;
return new Visitor(holder, session, inspectionState);
}


private class Visitor extends PyInspectionVisitor {
private final PyProtectedMemberInspectionState myState;

public Visitor(
@Nullable ProblemsHolder holder,
@Nonnull LocalInspectionToolSession session,
PyProtectedMemberInspectionState inspectionState
) {
super(holder, session);
myState = inspectionState;
}

@Override
public void visitPyImportElement(PyImportElement node) {
final PyStatement statement = node.getContainingImportStatement();
if (!(statement instanceof PyFromImportStatement)) {
return;
}
final PyReferenceExpression importReferenceExpression = node.getImportReferenceExpression();
final PyReferenceExpression importSource = ((PyFromImportStatement) statement).getImportSource();
if (importReferenceExpression != null && importSource != null && !isImportFromTheSamePackage(importSource)) {
checkReference(importReferenceExpression, importSource);
}
}

private boolean isImportFromTheSamePackage(PyReferenceExpression importSource) {
PsiDirectory directory = importSource.getContainingFile().getContainingDirectory();
if (directory != null && PyUtil.isPackage(directory, true, importSource.getContainingFile()) &&
directory.getName().equals(importSource.getName())) {
return true;
}
return false;
}

@Override
public void visitPyReferenceExpression(PyReferenceExpression node) {
final PyExpression qualifier = node.getQualifier();
if (myState.ignoreAnnotations && PsiTreeUtil.getParentOfType(node, PyAnnotation.class) != null) {
return;
}
if (qualifier == null || PyNames.CANONICAL_SELF.equals(qualifier.getText())) {
return;
}
checkReference(node, qualifier);
}

private void checkReference(@Nonnull final PyReferenceExpression node, @Nonnull final PyExpression qualifier) {
if (myTypeEvalContext.getType(qualifier) instanceof PyNamedTupleType) {
return;
}
final String name = node.getName();
final List<LocalQuickFix> quickFixes = new ArrayList<>();
quickFixes.add(new PyRenameElementQuickFix());

if (name != null && name.startsWith("_") && !name.startsWith("__") && !name.endsWith("__")) {
final PsiReference reference = node.getReference(getResolveContext());
for (final PyInspectionExtension inspectionExtension : PyInspectionExtension.EP_NAME.getExtensions()) {
if (inspectionExtension.ignoreProtectedSymbol(node, myTypeEvalContext)) {
return;
}
}
final PsiElement resolvedExpression = reference.resolve();
final PyClass resolvedClass = getClassOwner(resolvedExpression);
if (resolvedExpression instanceof PyTargetExpression) {
final String newName = StringUtil.trimLeading(name, '_');
if (resolvedClass != null) {
LocalizeValue qFixName = resolvedClass.getProperties().containsKey(newName)
? PyLocalize.qfixUseProperty()
: PyLocalize.qfixAddProperty();
quickFixes.add(new PyAddPropertyForFieldQuickFix(qFixName));

final Collection<String> usedNames = PyRefactoringUtil.collectUsedNames(resolvedClass);
if (!usedNames.contains(newName)) {
quickFixes.add(new PyMakePublicQuickFix());
}
}
}

final PyClass parentClass = getClassOwner(node);
if (parentClass != null) {
if (PyTestUtil.isPyTestClass(parentClass, null) && myState.ignoreTestFunctions) {
return;
}

if (parentClass.isSubclass(resolvedClass, myTypeEvalContext)) {
return;
}

PyClass outerClass = getClassOwner(parentClass);
while (outerClass != null) {
if (outerClass.isSubclass(resolvedClass, myTypeEvalContext)) {
return;
}

outerClass = getClassOwner(outerClass);
}
}
final PyType type = myTypeEvalContext.getType(qualifier);
final String bundleKey =
type instanceof PyModuleType ? "INSP.protected.member.$0.access.module" : "INSP.protected.member.$0.access";
registerProblem(
node,
PyBundle.message(bundleKey, name),
ProblemHighlightType.GENERIC_ERROR_OR_WARNING,
null,
quickFixes.toArray(new LocalQuickFix[quickFixes.size() - 1])
);
}
}

@Nullable
private PyClass getClassOwner(@Nullable PsiElement element) {
for (ScopeOwner owner = ScopeUtil.getScopeOwner(element); owner != null; owner = ScopeUtil.getScopeOwner(owner)) {
if (owner instanceof PyClass) {
return (PyClass) owner;
}
}
return null;
}
}
}
Loading
Loading