CheckAnalysisErrors.java

package org.python.pydev.editor.correctionassist;

import java.util.HashMap;
import java.util.Map;

import org.python.pydev.core.IMiscConstants;

public class CheckAnalysisErrors {

    private final static Map<String, String> pyLintMessageIdToCodeAnalysisError = new HashMap<>();
    private final static Map<String, String> codeAnalysisErrorToPyLintMessageId = new HashMap<>();
    private final static Map<Integer, String> codeAnalysisTypePyLintMessageId = new HashMap<>();

    // PyLint && PyDev analysis messages.
    // See: com.python.pydev.analysis.IAnalysisPreferences

    static {
        pyLintMessageIdToCodeAnalysisError.put("unused-import", "@UnusedImport");
        pyLintMessageIdToCodeAnalysisError.put("unused-variable", "@UnusedVariable");
        pyLintMessageIdToCodeAnalysisError.put("undefined-variable", "@UndefinedVariable");
        pyLintMessageIdToCodeAnalysisError.put("no-self-argument", "@NoSelf");
        pyLintMessageIdToCodeAnalysisError.put("redefined-builtin", "@ReservedAssignment");
        pyLintMessageIdToCodeAnalysisError.put("pointless-statement", "@NoEffect");
        pyLintMessageIdToCodeAnalysisError.put("function-redefined", "@DuplicatedSignature");
        pyLintMessageIdToCodeAnalysisError.put("unused-wildcard-import", "@UnusedWildImport");
        pyLintMessageIdToCodeAnalysisError.put("reimported", "@Reimport");
        pyLintMessageIdToCodeAnalysisError.put("no-name-in-module", "@UnresolvedImport");
        pyLintMessageIdToCodeAnalysisError.put("arguments-differ", "@ArgumentMismatch");
        pyLintMessageIdToCodeAnalysisError.put("bad-indentation", "@IndentOk");

        for (Map.Entry<String, String> entry : pyLintMessageIdToCodeAnalysisError.entrySet()) {
            codeAnalysisErrorToPyLintMessageId.put(entry.getValue(), entry.getKey());
        }

        codeAnalysisTypePyLintMessageId.put(IMiscConstants.TYPE_UNUSED_IMPORT, "unused-import");
        codeAnalysisTypePyLintMessageId.put(IMiscConstants.TYPE_UNUSED_VARIABLE, "unused-variable");
        codeAnalysisTypePyLintMessageId.put(IMiscConstants.TYPE_UNDEFINED_VARIABLE, "undefined-variable");
        codeAnalysisTypePyLintMessageId.put(IMiscConstants.TYPE_NO_SELF, "no-self-argument");
        codeAnalysisTypePyLintMessageId.put(IMiscConstants.TYPE_ASSIGNMENT_TO_BUILT_IN_SYMBOL, "redefined-builtin");
        codeAnalysisTypePyLintMessageId.put(IMiscConstants.TYPE_NO_EFFECT_STMT, "pointless-statement");
        codeAnalysisTypePyLintMessageId.put(IMiscConstants.TYPE_DUPLICATED_SIGNATURE, "function-redefined");
        codeAnalysisTypePyLintMessageId.put(IMiscConstants.TYPE_UNUSED_WILD_IMPORT, "unused-wildcard-import");
        codeAnalysisTypePyLintMessageId.put(IMiscConstants.TYPE_REIMPORT, "reimported");
        codeAnalysisTypePyLintMessageId.put(IMiscConstants.TYPE_UNRESOLVED_IMPORT, "no-name-in-module");
        codeAnalysisTypePyLintMessageId.put(IMiscConstants.TYPE_ARGUMENTS_MISATCH, "arguments-differ");
        codeAnalysisTypePyLintMessageId.put(IMiscConstants.TYPE_INDENTATION_PROBLEM, "bad-indentation");
    }

    public static boolean isPyLintErrorHandledAtLine(String line, String messageId) {
        String codeAnalysisIgnoreMessage = pyLintMessageIdToCodeAnalysisError.get(messageId);
        return isErrorHandledAtLine(line, messageId, codeAnalysisIgnoreMessage);
    }

    private static boolean isErrorHandledAtLine(String line, String pyLintMessageId, String codeAnalysisIgnoreMessage) {
        if (pyLintMessageId != null) {
            int pos = -1;
            // Old format.
            if ((pos = line.indexOf("IGNORE:")) != -1) {
                String lintW = line.substring(pos + "IGNORE:".length());
                if (lintW.startsWith(pyLintMessageId)) {
                    return true;
                }
            }

            // The message is actually something as "# pylint: disable=" + messageId
            if (line.contains(pyLintMessageId) && line.contains("disable=") && line.contains("pylint:")) {
                return true;
            }
        }

        if (codeAnalysisIgnoreMessage != null) {
            if (line.contains(codeAnalysisIgnoreMessage)) {
                return true;
            }
        }
        return false;
    }

    public static boolean isCodeAnalysisErrorHandled(String line, String messageToIgnore) {
        String pyLintMessageId = codeAnalysisErrorToPyLintMessageId.get(messageToIgnore);
        return isErrorHandledAtLine(line, pyLintMessageId, messageToIgnore);
    }

    public static String getPyLintMessageIdForPyDevAnalysisType(int analysisType) {
        return codeAnalysisTypePyLintMessageId.get(analysisType);
    }

}