外部工具

添加本地外部工具

pylint是一个代码分析工具，可以检查您的代码并检测任何样式、逻辑和使用问题。它可能是 PyCharm 提供的代码验证功能的一个很好的补充。

1. 按Ctrl+Alt+S打开 IDE 设置并选择Project | Python 解释器。

2. 单击以安装新软件包。

3. 在可用包窗口中，搜索“pylint”，然后在包列表中选择它，然后单击安装包。

   

   等到安装包并关闭窗口。

4. 现在您已经在系统上安装了 pylint，您可以配置它与 PyCharm 的集成。

5. 按Ctrl+Alt+S打开 IDE 设置并选择工具 | 外部工具。

6. 单击按钮以添加新的外部工具。

7. 添加配置选项，如下图：

   

   • Group ：要在工具 |中显示的外部工具组的名称 外部工具菜单

   • Name : 外部工具名称

   • 描述：可选描述

   • Program：pylint 可执行文件的路径（$PyInterpreterDirectory$是放置当前项目的Python解释器的目录）。例子：

     $PyInterpreterDirectory$\pylint

     $PyInterpreterDirectory$/pylint

   • 参数：指定应检查哪些文件和文件夹（本例中为car.py和test ）并设置 pylint 错误的输出格式。例子：

     --msg-template="$FileDir$\{path}:{line}:{column}:{C}:({symbol}){msg}" car.py test

     --msg-template="$FileDir$/{path}:{line}:{column}:{C}:({symbol}){msg}" car.py test

   • 工作目录：项目根目录

   • 建议启用“高级选项”部分中的所有选项并设置“输出”过滤器以将错误文件的链接插入到 pylint 输出中，以便您可以快速跳转到代码中的错误或警告。

8. 单击确定以保存更改。通过单击外部工具窗口中的应用和确定来完成添加外部工具。

现在您可以从工具 |访问这个外部工具。外部工具。

您可以使用此菜单运行 pylint。但是，您可能还希望将其添加到应用程序的运行/调试配置中。

运行外部工具

1. 从主菜单中，选择运行 | Edit Configurations，然后在Edit Configurations对话框中，单击Before launch部分。

2. 从添加新配置列表中选择运行外部工具并指定 pylint。它将被添加到应用程序启动之前要执行的脚本列表中。

   

3. 单击确定以保存更改

4. 运行运行/调试配置Shift+F10。

   

   您应该会在“工具”窗口中看到 pylint 选项卡，其中包含以下示例输出：

   

您可以检查报告的错误，单击相应的链接以导航到有问题的代码，并进行所需的更改。

添加远程外部工具

远程 SSH 外部工具的配置类似于本地外部工具，但也定义了执行它们的远程服务器，并且需要凭据才能通过 SSH 连接到它。

此示例演示如何添加date作为远程 SSH 外部工具，该工具在远程服务器上执行并返回其上的当前日期和时间。

1. 按Ctrl+Alt+S打开 IDE 设置并选择工具 | 远程 SSH 外部工具。

2. 单击并指定以下设置：

   

   此对话框提供与添加本地外部工具时相同的设置集，但也建议选择远程服务器。

   这可以是您配置的SSH 配置之一或Vagrant框。

   默认情况下，每次您在服务器上运行该工具时，PyCharm 都会要求您提供主机、端口和相关的 SSH 凭据。

3. 单击确定添加工具，然后应用更改。

在远程服务器上运行添加的工具

• 从主菜单中，选择工具 | 远程工具 | 日期和时间。

• 在Settings/Preferences对话框 ( Ctrl+Alt+S) 中，选择Keymap，找到Date and time操作并为其分配快捷方式。使用快捷方式运行该工具。

指定主机、端口和凭据后，PyCharm 将通过 SSH 连接到服务器并运行date命令，将输出返回到 PyCharm 中的运行工具窗口。