如何开发一个 PyCharm 插件
tsxh5249
8年前
<p>PyCharm 是很多 Python 开发者优先选择的 IDE，功能强大，跨平台，提供免费社区版，非常良心。如果你想自己给PyCharm添加一些功能怎么办呢？有两个办法：</p> <ol> <li>通过提需求实现，到 JetBrains 的 <a href="/misc/goto?guid=4959747937958772737" rel="nofollow,noindex">github</a> 去提issue或者自己发Pull Request请他们merge。</li> <li>通过安装插件实现，你可以查找现有的 插件仓库 ，或者，自己写一个。</li> </ol> <p>今天我们说说怎么搭建环境自己写一个 PyCharm 插件。</p> <h2>前期准备</h2> <p>先普及一下知识，开发 PyCharm 插件和开发 IntellJ IDEA 插件需要的环境是一样的，因为 PyCharm 本身就是 IDEA 的一个子集，说白了就是 IDEA 上套了一个 Python 语言支持的插件。其他系列的 IDEA IDE 其实也是一样的道理，都是套了对应语言支持的框架外加一点外观修改，就成了新的产品，比如 WebStrom，PhpStorm，RubyMine。到这里你应该有个印象，JetBrains 这个公司太能玩了，就一个 IDEA 能整出那么多产品来，很厉害吧？</p> <p>开发 PyCharm 插件你需要：</p> <ul> <li>对 Java 语言有一定了解，因为你只能用 Java 开发插件</li> <li>安装最新版的 <a href="/misc/goto?guid=4958859042026617529" rel="nofollow,noindex">IntelliJ IDEA</a></li> <li>安装 PyCharm Community Edition 到本地</li> <li>确保 IntelliJ 安装并启用了 Plugin DevKit 插件，默认自带</li> <li>配置 IntelliJ Platform SDK， 下文会涉及相关步骤</li> <li>（非必需）将 <a href="/misc/goto?guid=4959747937958772737" rel="nofollow,noindex">IntellJ IDEA Community Edition</a> 的代码克隆到本地，方便调试</li> </ul> <p>如果你英文还可以，也可以阅读官方的帮助文档。</p> <ul> <li><a href="/misc/goto?guid=4959747938095631141" rel="nofollow,noindex">http://www.jetbrains.org/inte…</a></li> </ul> <h2>新建插件工程</h2> <p>从文件菜单选择 <strong>New Project</strong> ， 选择 <strong>IntelliJ Platform Plugin</strong> ，如果你没有配置 <strong>SDK</strong> ，点击 <strong>New</strong> 菜单。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/29ddb37e6e77ddfa32e9bf762c514709.png"></p> <p>选择你本地 PyCharm Community Edition（社区版）的安装路径作为SDK目录，Java SDK 选择 1.8 以上的版本。</p> <p>请注意，你也可以使用 PyCharm Professional (旗舰版) 的安装路径作为SDK目录，不过当你调试插件碰到核心代码时，社区版你可以一步一步跟到最里面，但旗舰版不行，因为旗舰版并不是开源的，你拿不到源代码。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/fb24644dc7c826b76ac6a185ce0a33e5.png"></p> <p>回到 <strong>New Project</strong> 的界面，点击 <strong>Next</strong> ，输入 <strong>Project name</strong> 和 <strong>Project location</strong> ，点击完成。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/2755d70a5988290c8535b72a4b581cdf.png"></p> <p>小贴士：如果你是打开别人的写的插件，那么你直接选择打开工程目录是没有用的，因为 IntelliJ IDEA 不认为这是个插件工程，所以你没法运行和调试这个插件，一个不怎么优雅的办法就是 <strong>从现有代码新建一个插件工程</strong> ，StackOverflow 关于这个的吐槽问题你搜到，如果你有更好的办法请告诉我。当你换一台机器把插件代码克隆下来之后应该就知道我在说什么了。</p> <h2>插件工程目录结构</h2> <p>一个典型的插件目录结构就像下图。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/d4a70c2ef889f178a7f7bcccc96566e1.png"></p> <ul> <li><strong>.idea</strong> 目录 – JetBrains IDE 生成的工程都会有这么一个目录，存放用户配置和缓存，无需关心。</li> <li><strong>doc</strong> 目录 – 插件的文档，可选。</li> <li><strong>out</strong> 目录 – 编译后的代码字节，无需关心。</li> <li><strong>resources</strong> 目录 – 资源存放目录，插件的配置文件在此。</li> <li><strong>src</strong> 目录 – 代码存放的位置。</li> <li><strong>*.iml</strong> 文件 – 项目的配置文件。</li> </ul> <h2>修改插件信息</h2> <p>打开 /resources/META-INF/plugin.xml ， 更新插件信息，举例说明。</p> <pre> <code class="language-python"><idea-pluginversion="2"> <id>com.eflabs.plugin.efcommon</id> <name>EFCommonfor PyCharm</name> <version>3.1</version> <vendoremail="toby.qin@live.com">TobyQin</vendor> <description><![CDATA[ <b>Ableto runand debugefcommontestseasily.</b><br> <br> <ul> <li>Supportrun/debugef-commontestsviacontextmenu.</li> <li>Showrunbuttonin thelineoftestcase.</li> </ul>]]> </description> <change-notes><![CDATA[ <b>v3.0</b><br> <p>SupportPyCharm 171.*</p> <p>Supportnestedef-commonproject.</p> <br> <b>Earlyversion</b><br> <p>Bugfix: failedto getrun.templatein resource.</p> <p>Thebabyversion.</p> <br>]]> </change-notes> <!-- pleaseseehttp://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/build_number_ranges.html for description --> <idea-versionsince-build="171.1"/> <!-- pleaseseehttp://confluence.jetbrains.com/display/IDEADEV/Plugin+Compatibility+with+IntelliJ+Platform+Products onhowto targetdifferentproducts --> <depends>com.intellij.modules.python</depends> <extensionsdefaultExtensionNs="com.intellij"> <!-- Addyourextensionshere --> <configurationTypeimplementation="com.eflabs.efcommon.runConfiguration.EfCommonConfigurationType" order="FIRST"/> <runConfigurationProducerimplementation="com.eflabs.efcommon.runConfiguration.EfCommonConfigurationProducer" order="FIRST"/> <runLineMarkerContributor implementationClass="com.eflabs.efcommon.runLineMarker.EfCommonRunLineMarkerContributor" language="Python"/> </extensions> <actions> <!-- Addyouractionshere --> </actions> </idea-plugin> </code></pre> <p>这个配置文件里有几点要注意的：</p> <ol> <li><id> 和 <version> 用于声明你的插件唯一标识，同id和version的插件不能够重复上传。</li> <li><depends> 节点声明了此插件的依赖条件，如果是PyCharm 适用的，那么就写 com.intellij.modules.python</li> <li><extenstions 节点用于声明你要扩展的类，只要继承和实现对应的接口就可以了。</li> <li><actions> 节点用于注册你要实现的 Action，比如你先写一些 Action，然后 注册到某个菜单 。</li> </ol> <h2>实现具体的业务代码</h2> <p>这里我略过最核心的部分，因为每个人的需求和代码能力都不一样，这应该去查阅Java编程规范。</p> <p>简而言之，就是根据你自己的需求用Java实现一些接口和方法。</p> <h2>运行和调试你的插件</h2> <p>如果你的代码已经实现了，那么运行和调试就比较简单。</p> <ul> <li>使用 <strong>Run | Run</strong> 菜单来运行你的插件，这时候会启动一个新的PyCharm，默认安装好你的插件。</li> <li>使用 <strong>Run | Debug</strong> 菜单来调试你的插件，你可以设置断点进行调试。</li> </ul> <h2>发布你的插件</h2> <p>你可以选择本地发布你的插件，也可以选择上传到 JetBrains 的插件仓库。</p> <h3>本地发布安装</h3> <p>如果你的插件是内部小范围使用，并且可能带有敏感信息，那么这样的方式会比较适合你。从主菜单选择 <strong>Build > Prepare plugin ‘my_plugin’ For Deployment</strong> 。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/19c7fa2b2abae73181d8526ce7dd2fad.png"></p> <p>如果成功那么在工程目录就会生成一个同名的 jar 文件。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/073e58f06355481644f3a7d316f0cfdb.png"></p> <p>将这个文件 copy 到目标机器就可以通过 <strong>Install Plugin from disk …</strong> 完成安装。</p> <h3>发布插件到 JetBrains Plugin 仓库</h3> <p>生成插件的步骤和本地发布是一样的，唯一不同的就是你需要到 JetBrains Plugins 网站去注册一个账号。</p> <ul> <li><a href="/misc/goto?guid=4959747938182417580" rel="nofollow,noindex">https://plugins.jetbrains.com/</a></li> </ul> <p>登录之后选择 <strong>UPLOAD PLUGIN</strong> 菜单，上传之后大概需要2个工作日审核。</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/a1741e2dcb822657376c5805a0082e4d.png"></p> <p>审核通过后其他用户就可以直接从 <strong>Browse Repositories…</strong> 里搜索到你的插件并安装。通过插件仓库安装的插件，一旦有新版本发布，用户将收到更新提示。</p> <h2>写在最后</h2> <p>关于如何实现具体的插件业务代码，一个偷懒的办法就是去看现有功能大概是怎么实现的，你既然可以拿到 PyCharm Community Edition 的所有代码，还有啥看不到的，看懂只是时间问题。再或者去 github 搜搜看，万一有惊喜呢？</p> <p>就 PyCharm 本身来说，我觉得作为 IDE 提供的功能已经很丰富了，为啥还要写插件呢？对啊，哪里来的需求，会不会是一个伪需求呢。写插件前请你想一想这个问题。</p> <p> </p> <p>来自：http://python.jobbole.com/87660/</p> <p> </p>