插件
插件扩展 PyCharm 的核心功能。 例如,安装插件可将 IDE 与版本控制系统、问题跟踪器、构建管理服务器集成,获取对各种语言和框架的编码辅助支持等。
大多数插件可用于任何 JetBrains 产品。 部分仅限于商业产品,另一些需要单独的许可证。
安装插件
默认情况下,PyCharm 包含随 IDE 安装提供的捆绑插件。 可以从 JetBrains Marketplace 或本地归档文件(ZIP 或 JAR)安装其他插件。 这些附加插件称为非捆绑插件或已下载插件。
从 JetBrains Marketplace 安装插件
打开设置 ,或在 IDE 中按 Ctrl+Alt+S ,然后选择 。
在搜索字段中输入要安装的插件名称。
在搜索字段中点击
显示 Marketplace 结果 ,查看用于对搜索结果排序的选项。 点击 筛选插件 以查看可用的筛选选项。
要安装该插件,请点击 安装 ,并在出现提示时重启 IDE。
要安装特定版本,请转到该插件在 JetBrains Marketplace 上的页面,并按照 从磁盘安装插件 中的说明下载并安装它。 例如,当插件的最新版本存在问题时,您可以这样做。
打开插件设置
打开设置 ,或在 IDE 中按 Ctrl+Alt+S ,然后选择 。
可在此处找到几个插件类别:
已安装 :从 JetBrains Marketplace、自定义插件仓库或本地归档安装的其他插件。
内置 :PyCharm 默认包含的插件。 可以启用或禁用其中大多数插件,但无法卸载它们。
建议 :PyCharm 根据当前项目中检测到的技术 推荐的插件。
插件市场 :可从 JetBrains Marketplace 安装的插件。 搜索插件时,这些插件会显示为搜索结果。
来自所使用的 自定义仓库的插件。

如果某个插件依赖其他插件,您可以在 其他信息 选项卡中找到依赖项列表。 如果您的 项目 依赖某些插件,请将它们添加到 必需插件 列表中。
从磁盘安装插件
如果需要已从 JetBrains Marketplace 下载的特定插件版本,或第三方提供的插件,可以从磁盘安装插件。 在这种情况下,请从本地 ZIP 或 JAR 归档安装该插件。
下载插件归档文件(ZIP 或 JAR)。
打开设置 ,或在 IDE 中按 Ctrl+Alt+S ,然后选择 。
在 插件 页面上,点击
管理仓库、配置代理或从磁盘安装插件 ,然后点击 从磁盘安装插件。

选择插件归档文件,然后点击 确定。
点击 确定 以应用更改,并在提示时重启 IDE。
通过命令行安装插件
如果想自动化 IDE 设置或在不使用图形界面的情况下安装插件,可以从命令行安装插件。
退出您要安装插件的 IDE。
在 JetBrains Marketplace中,找到要安装的插件页面,向下滚动到 附加信息 部分,并从 插件 ID 参数复制其值,例如
org.jetbrains.plugins.github。安装插件:
导航到 PyCharm bin 目录下的 安装目录 ,并运行以下命令:
pycharm64.exe installPlugins <PluginID>例如:
pycharm64.exe installPlugins org.jetbrains.plugins.github运行以下命令:
open -na "PyCharm.app" --args installPlugins <PluginID>例如:
open -na "PyCharm.app" --args installPlugins org.jetbrains.plugins.github导航到 PyCharm bin 目录下的 安装目录 ,并运行以下命令:
pycharm.sh installPlugins <PluginID>例如:
pycharm.sh installPlugins org.jetbrains.plugins.github
有关更多信息,请参见 从命令行安装插件。
更新插件
手动更新插件
具有 已配置更新源的插件有可用的插件更新。
打开设置 ,或在 IDE 中按 Ctrl+Alt+S ,然后选择 。
如果已安装的插件有新版本,插件设置中会出现 更新 按钮。 点击该按钮以更新插件。
要配置 IDE 是否应检查更新,请打开 设置 Ctrl+Alt+S ,然后转到 。 在此页面,您也可以点击 检查更新 手动检查插件存储库中的可用插件更新。
如果您希望 IDE 自动更新所有插件,您可以 进行相应配置。
有关 IDE 和插件更新的更多信息,请参阅 更新 PyCharm。
自动更新插件
默认情况下,当插件有新版本可用时,PyCharm 会通知您手动更新该插件。 您可以将 PyCharm 配置为自动下载插件更新,并在下次重启 IDE 时应用这些更新。
具有 已配置更新源的插件可以自动更新。 在这种情况下,PyCharm 会在指定仓库中检查更新,并且不会自动安装其他仓库的更新。
打开设置 ,或在 IDE 中按 Ctrl+Alt+S ,然后选择 。
点击
管理仓库、配置代理或从磁盘安装插件 ,然后选择 自动更新插件。
或者,转到 ,然后选择 自动更新插件。
插件更新源
PyCharm 仅在知道插件来源时更新插件。 从 JetBrains Marketplace 或自定义插件仓库安装插件时,PyCharm 会将该仓库记录为插件来源。
如果插件未配置更新源,PyCharm 不会自动更新该插件,也不会在有可用更新时通知。 例如,从磁盘安装插件,或者 IDE 无法确定先前安装的插件的来源时,就可能发生这种情况。
如果 PyCharm 停止更新插件,将看到一条通知,其中包含用于设置来源的链接。 否则,可以在设置中检查来源。
检查或更改插件更新源
打开设置 ,或在 IDE 中按 Ctrl+Alt+S ,然后选择 。
选择已安装的插件并打开 其他信息 选项卡。
找到 更新来源 字段以查看或更改插件更新源。
选择一个受信任且希望从中接收该插件更新的仓库。
停用插件
禁用插件
如果不需要相应功能,但又不想从 IDE 中卸载插件,可以禁用插件而不将其移除。
打开设置 ,或在 IDE 中按 Ctrl+Alt+S ,然后选择 。
找到并选择要禁用的插件。
在插件的描述窗格中,点击 禁用。
或者,可以使用插件列表中的切换按钮,或使用插件类别的 全部禁用 按钮。
可以在 管理仓库、配置代理或从磁盘安装插件 下的菜单中一次性禁用或启用所有非捆绑插件。

卸载插件
打开设置 ,或在 IDE 中按 Ctrl+Alt+S ,然后选择 。
找到并选择要卸载的插件。
展开 禁用 列表,并选择 卸载。

必需的插件
项目可能需要提供对某些技术或框架支持的插件。 您可以将此类插件添加到当前项目的 必需插件 列表中,以便 PyCharm 将验证这些插件是否已安装并已启用。 如果您忘记某个插件,或者团队中的某人在处理项目时未意识到该依赖项,PyCharm 会通知您。
为当前项目添加必需插件
按下 Ctrl+Alt+S 以打开设置,然后选择 。
在 必需插件 页面上,点击
添加 ,然后选择插件。 (可选)指定该插件的最低和最高版本。

必需插件列表存储在项目的 .idea/externalDependencies.xml 文件中。 在 PyCharm 中打开 项目 时,如果必需插件被禁用、未安装或需要更新,PyCharm 将通知您。

点击通知消息中的链接,以启用、安装或更新所需插件。
建议的插件
当您打开 项目 时,PyCharm 可根据您的 项目 中使用的库建议安装并启用插件。 请勿将 建议的插件 与 必需插件 混淆;您可以将后者手动添加到 项目,以便您的队友也使用它。
如果不需要某个特定插件,可以阻止 PyCharm 建议该插件。 您还可以使用您的 通知设置 来禁用或启用所有插件建议的通知及其显示方式。
禁用某个插件的建议
当出现建议插件的通知时,点击 不再建议。
下次打开 项目 时,PyCharm 将不再建议该插件。
检查项目中的建议插件
您可以检查项目中的建议插件,但对于您已 禁用建议的插件除外。
请按 Ctrl+Shift+A 并开始键入 Check Suggested Plugins。
选择 检查推荐的插件 操作。

如果 PyCharm 有适用于您的 项目 的插件,您会看到一条通知消息。 点击通知消息中的链接以安装或启用建议的插件。
或者,可以打开 IDE 设置(Ctrl+Alt+S )并选择 插件 :如果有为项目建议的插件,它们将显示在 建议 部分中。
自定义插件存储库
默认情况下,PyCharm 配置为使用来自 JetBrains Marketplace 的插件。 这是一个公共存储库,任何人都可以在其中托管其插件。 但是,如果您仅为内部使用开发插件,您可以为其设置自定义插件存储库。
有关设置自定义插件存储库的更多信息,请参阅 IntelliJ Platform SDK 文档。
设置好插件存储库后,将其添加到 PyCharm:
添加自定义存储库
打开设置 ,或在 IDE 中按 Ctrl+Alt+S ,然后选择 。
在 插件 页面上,点击
管理仓库、配置代理或从磁盘安装插件。

在 自定义插件存储库 对话框中,点击
添加 ,并指定仓库 URL。
该 URL 需要指向 描述您的插件的 XML 文件的位置,例如 updatePlugins.xml 。 该文件可以与您的自定义插件位于同一服务器上,也可以位于专用服务器上。

在 自定义插件存储库 对话框中点击 确定 以保存插件存储库列表。
在 设置 对话框中点击 确定 以应用更改。
搜索插件时,PyCharm 将同时显示来自默认 JetBrains Marketplace 和您指定的任何自定义存储库的结果。 若要仅浏览某个自定义插件仓库,请点击 筛选插件 ,选择 仓库 ,然后从列表中选择此仓库。
或者,您可以使用 idea.plugin.hosts 属性添加自定义插件存储库:
转到 。
将
idea.plugin.hosts属性添加到平台属性文件,并指定描述您插件的 XML 文件 的 URL。 例如:idea.plugin.hosts="http://plugins.example.com:8080/updatePlugins.xml"重启 PyCharm。
您可能希望将默认的 JetBrains Marketplace 替换为您的自定义插件存储库。 如果您希望 PyCharm 仅提供来自您的自定义存储库的插件,这将很有帮助。
替换默认插件存储库
转到 。
将
idea.plugins.host属性添加到平台属性文件,并指定能够正确处理来自 PyCharm 请求的应用程序的 URL,即作为默认插件存储库应用程序以替代 JetBrains Marketplace。特别是,它应处理以下请求:
重启 PyCharm。
如果替换默认插件仓库, 插件 对话框的搜索字段将仅浏览新默认仓库以及添加的任何自定义仓库中的插件。
手动配置插件更新源
组织可以直接在 IDE 插件目录中安装或更新插件。 由于这会绕过标准安装过程,PyCharm 可能不知道要在哪里检查更新。 用户可能会看到有关缺少更新源的警告,并且这些插件将不会自动更新。
管理员可以通过编辑 pluginUpdateSources.xml 文件来配置插件更新源。
找到并打开 PyCharm 配置目录。
打开 选项 文件夹。
打开或创建 pluginUpdateSources.xml 文件。
为要配置更新源的每个插件添加一个条目。
<application> <component name="PluginUpdateSources"> <sources> <entry pluginId="pluginId"> <!-- For a custom repository --> <!-- The custom repository URL is exactly the URL of custom repository with trimmed `/` on the end, as it is configured in IDE --> <updateSource host="<custom repository url>" isMarketplace="false" /> </entry> <!-- Plugin2 will be updated from JetBrains Marketplace or Marketplace proxy for users of ToolBox Enterprise --> <entry pluginId="pluginId2"> <updateSource /> </entry> <entry pluginId="pluginId3"> <updateSource .../> </entry> ... </sources> </component> </application>
效率提示
从链接安装插件
一些与 IDE 集成的网站、文档页面和教程可能包含可以打开 IDE 并提示安装插件的链接。 点击安装链接时:
IDE 将打开。
IDE 会检查所请求的插件是否可用。
如果插件兼容,将会提示安装或启用。
安装完成后,插件即可使用。 如果需要重启,IDE 会提醒。
如果链接中包含多个插件,可以一次性安装。
例如,可使用此链接 安装 Mercurial 插件。