外部工具

添加本地外部工具

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

1. 在主菜单中，转到 查看 | 工具窗口 | Python 包 以打开 Python 包工具窗口。

2. 在搜索字段中搜索 "pylint"，然后在软件包列表中选择它。

3. 点击软件包名称旁边的 安装 并选择版本。

   

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

5. 按下 Ctrl+Alt+S 打开设置，然后选择 工具 | 外部工具。

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

7. 按如下所示添加配置选项：

   

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

   • 名称 ：外部工具名称

   • 描述 ：可选描述

   • 程序 ：pylint 可执行文件的路径（$PyInterpreterDirectory$ 是当前项目的 Python 解释器所在的目录）。 示例：

     $PyInterpreterDirectory$\pylint

     $PyInterpreterDirectory$/pylint （Linux、macOS）

   • 参数 ：指定应检查的文件和文件夹（在此示例中为 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. 转到 运行 | 编辑配置...。

2. 在 运行/调试配置 对话框中，点击 修改选项 链接并选择 添加启动前任务。

   

3. 请从 添加新任务 列表中选择 运行外部工具。

   

4. 在 外部工具 对话框中，选择 pylint 并点击 确定。 Pylint 将被添加到应用启动前要执行的脚本列表中。

   

5. 返回 运行/调试配置 对话框后，再次点击 确定 以保存您的更改。

6. 使用 Shift+F10 快捷键或 运行 按钮运行您的配置。

   脚本运行结束后，您应可在 pylint 选项卡中的 运行 工具窗口查看输出结果。

   

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

添加远程外部工具

远程 SSH 外部工具的配置与本地外部工具类似，但还需要定义执行这些工具的远程服务器，并需要通过 SSH 连接到该服务器的凭证。

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

1. 按下 Ctrl+Alt+S 打开设置，然后选择 工具 | 远程 SSH 外部工具。

2. 点击 以打开 创建工具 对话框。

   

   此对话框提供了与您添加 local external tool时相同的设置集，但还允许您选择远程连接。 如果您不指定连接设置，每次在服务器上运行该工具时，PyCharm 都会要求您提供主机、端口和相关的 SSH 凭证。 更多信息请参阅 远程 SSH 外部工具。

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

在远程服务器上运行新增的工具

请执行以下操作之一：

• 在主菜单中，转到 工具 | 远程工具 并查看所添加的远程外部工具的名称。

• 创建一个快捷方式来运行该工具。

  按下 Ctrl+Alt+S 打开设置，然后选择 键位图。 找到已配置的远程外部工具的名称，并为其分配一个快捷键。

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