intellij-idea - 在 Intellij 中创建自定义 python 检查

Question

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

Answer 1

我只对 IntelliJ 的 JavaScript 插件有经验，但它应该同样适用于 Python。

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

首先，您需要查看JetBrains 的插件开发页面。以下是我将采取的步骤：

• 下载IntelliJ IDEA 社区版源代码。这不是必需的，但通过源搜索很有用。
• 尝试遵循基本插件教程。这是一个 Java 插件，但它是一个好的开始。对于 Python，您可能需要添加对插件 jar 的依赖项。
• 针对您的情况，请阅读 PsiElements。使用 PsiElements 是您导航和修改源代码的方式。
• 对于实际示例，请浏览插件存储库并查找开源插件。在开发我自己的插件时，我发现它们最有帮助。

完成后，您就可以开始编写插件了。对于检查，您将关注以下几类：

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

您将获得一个代表您的源文件的 PsiFile。使用它，您可以搜索有问题的函数并将其标记为错误。

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