在Intellij中创建自定义python检查

Question

有没有办法在Intellij中为Python代码创建自定义检查？我需要将Python函数列入黑名单，以便每当有人导入或输入它时都会发出警告。

Answer 1

我只有使用IntelliJ的JavaScript插件的经验，但它对Python应该是一样的。

您可以编写一个提供检查的插件。当然有学习曲线，但是一旦你获得了环境设置，它就会很顺利。

首先，您需要查看the plugin development page from JetBrains。 以下是我要采取的步骤：

• 下载IntelliJ IDEA Community Edition source。这不是必需的，但搜索源代码很有用。
• 尝试关注basic plugin tutorial。它是一个Java插件，但它是一个好的开始。对于Python，您可能需要在插件jar上添加依赖项。
• 特定于您的情况，read up on PsiElements。使用PsiElements是您导航和修改源代码的方式。
• 对于实际示例，browse the plugin repository并查找开源插件。在开发自己的插件时，我发现它们最有用。

完成后，您就可以开始编写插件了。对于检查，您会关注几个课程：

• LocalInspectionTool是搜索文件并标记问题的实际检查。你扩展这个类
• InspectionToolProvider是您实现的接口，用于确定文件是否将运行特定检查。
• ProblemDescriptor是代表您的错误消息的类。您可以选择提供修复以删除相关元素。

您将获得代表源文件的PsiFile。使用此功能，您可以搜索有问题的功能并将其标记为错误。

最后一个很棒的资源是plugin development forum。通常，如果其他人没有回答您的问题，其中一位开发人员会做出回应，所以请不要犹豫在那里发帖。