PyCharm 2025.3 Help

运行检查

PyCharm 会在编辑器中打开的文件中 分析代码 ,并在您输入时高亮显示存在问题的代码。 此外,您还可以在所选文件作用域上 手动 运行所需的检查或一组检查。 在这种情况下,您将获得文件中检测到的所有问题的全面报告。

当前文件的即时分析

IDE 会持续检查您的代码并查找问题。 编辑器右上角的小部件会显示当前文件中检测到的各个 严重程度 的问题数量:

检查小部件

点击该小部件,可在 问题工具窗口文件 选项卡中打开问题列表。 您还可以通过选择 视图 | 工具窗口 | 问题 或按 Alt+6 来打开 问题 工具窗口。

对于每个问题,您可以通过按 Alt+Enter 或点击 显示快速修复 查看建议的快速修复。 要跳转到编辑器中的相应行,请按 F4 ,或在工具窗口中双击该问题。

点击 打开编辑器预览 ,即可直接在工具窗口中查看并修复问题。

滚动条中的彩色条纹也会标记检测到的代码问题,帮助您无需滚动文件即可快速访问相应的行。 将鼠标悬停在条纹上的标记,即可在工具提示中查看检测到的问题。 点击某个标记以跳转到相应的行。

即时分析结果

在文件内,您可以在该小部件中点击 下一个高亮错误按钮 下一个高亮错误按钮 ,或分别按 F2Shift+F2 ,在高亮问题之间跳转。 默认情况下, IDE 将根据问题的 严重程度 为您导航:错误 > 警告 > 弱警告 > 服务器问题 > 拼写错误。

您可以将 PyCharm 配置为不考虑严重程度,逐个查看问题。 将鼠标悬停在编辑器右上角的小部件上,点击 更多按钮 ,选择 'Next Error' 操作 (F2) 遍历 ,然后启用 所有问题

手动运行检查

某些检查需要全局代码分析,因此在编辑器中被禁用。 这些检查列在 设置 | 编辑器 | 检查 中。 点击 筛选检查 并选择 仅显示批处理模式检查

如果您希望获得代码中所有问题的完整报告,请手动运行检查。 在这种情况下, IDE 将运行您在 检查配置文件 中启用的所有检查,并在专用工具窗口中向您显示结果。 完成分析所需的时间取决于已启用检查的数量以及您正在分析的作用域大小。

运行所有检查

  1. 在主菜单中,转到 代码 | 检查代码(I)…

  2. 选择要分析的 作用域

    点击 浏览按钮 图标以配置新作用域。

  3. 选择您要应用的 检查配置文件

    若要创建新配置文件或修改现有配置文件之一,请点击 配置…

  4. 点击 分析 开始分析。

指定检查作用域对话框

指定检查作用域对话框

说明

整个项目

检查整个项目。

模块 <name>

检查当前在 项目 工具窗口 Alt+1 中选定的模块。

文件 <name>

检查当前在 项目 工具窗口中选定或在编辑器中打开的文件。

所选文件

检查当前在 项目 工具窗口中选定的文件。

未提交的文件

此作用域仅适用于受版本控制的项目。

仅检查尚未提交到版本控制系统的文件。

目录

检查当前在 项目 工具窗口中选定的目录。

自定义范围

检查自定义文件作用域。 从列表中选择预定义作用域,或点击 浏览按钮 ,并在打开的 作用域对话框 中定义作用域。

检查注入的代码

检查嵌入在您的代码中的其他语言的 代码片段

检查配置文件

选择要用于检查代码的 配置文件

如果所需的配置文件不在列表中,请点击 配置 并创建新配置文件。

运行单个检查

在需要跟踪特定问题时,运行单个检查很有用。 如果您在某个文件中发现警告,您可以检查整个项目或所需的文件作用域,以确保代码库中不再存在此类警告。

  1. Ctrl+Alt+Shift+I ,或在主菜单中转到 代码 | 分析代码 | 通过名称运行检查(R)…

  2. 在弹出窗口中输入检查名称。 使用 CamelHumps 通过单词首字母匹配驼峰式大小写的单词以及由空白字符分隔的单词。 建议列表将显示与您的搜索请求匹配的检查。

    如果您不确定选择的是正确的检查,可以查看其说明。 为此,请在弹出窗口中选择一个检查并按 Ctrl+Q

  3. 双击所需的检查。

  4. 在打开的对话框中,选择要分析的文件作用域。

    文件掩码(K) 选项可帮助您缩小将要检查的文件数量。

    选中复选框,并指定一个由字符与通配符组成的模式,以匹配您要分析的文件名。 使用逗号分隔多个文件掩码。

  5. 某些检查可能包含其他选项, IDE 会提示您进行配置。

    这些设置仅适用于此次运行,不会影响当前配置文件中此检查的配置。

    IDE 将在专用工具窗口中向您显示检查结果。 在其中,您可以检查并修复检测到的问题。

在提交时分析代码

如果您的项目受 Git 或 Mercurial 版本控制,您可以将 IDE 配置为在提交前分析已修改的文件。

  1. Alt+0 打开 提交 工具窗口,然后点击 显示提交选项 设置按钮

  2. 提交检查 区域,选中 分析代码(A) 复选框。

  3. 点击 选择配置文件 ,并选择 IDE 将用于运行检查的 检查配置文件

    提交前运行检查:提交工具窗口
  4. 点击 提交(I)

    PyCharm 会通过运行所选检查配置文件中的检查来分析已修改文件的代码。

    如果检测到任何错误或警告,您将看到通知。

    检测到问题的通知
  5. 在通知中,点击 检查代码分析(R) ,即可在 消息 工具窗口中查看检测到的问题列表。 点击 忽略 以在不修复检测到的问题的情况下提交您的更改。

使用 Qodana 运行代码检查

它在 PyCharm 中默认捆绑并启用。 如果相关功能不可用,请确保您未禁用该插件。 有关详细信息,请参阅 打开插件设置

您可以使用 Qodana 在本地或远程检查您的代码。 Qodana 的主要用例是在 CI/CD 服务器上远程执行资源密集型代码分析。 不过,您也可以在 IDE 中运行相同的分析,以确保获得相同的结果,并能够在源代码中定位检测到的问题。

  1. 在主菜单中,转到 工具 | Qodana | 尝试使用 Qodana 进行代码分析

  2. 选择您希望运行检查的位置:本地或您的 CI/CD 服务器上。

    要在服务器上运行检查,您需要先在 CI 上设置 Qodana。

  3. 将打开 Qodana 配置文件。 在此文件中,您可以指定 Qodana 检查配置文件、启用或禁用特定检查,并指定在分析前应安装的插件列表。

    点击 运行

分析完成后,报告将显示在 问题 工具窗口的 Qodana 选项卡上。 您可以在本地处理结果,或将其发送到 Qodana Cloud

Qodana 结果

所有本地运行的 Qodana 分析报告都会保存,并可通过主菜单获取: 工具 | Qodana | [report name]。 当前打开的报告旁带有复选标记,您可以点击它以关闭该报告。

有关 Qodana 的更多信息,请参阅其 文档

离线运行检查

除了在 IDE 中运行代码检查外,您还可以在不实际运行 PyCharm 的情况下从命令行启动检查。 检查结果将存储在一个 XML 文件中。 有关详细信息,请参阅 从命令行运行代码检查

更改作用域顺序

默认情况下,所有已启用的代码检查都会分析项目中的所有文件。 根据需要,您可以在多个文件作用域中以不同设置运行同一检查。

如果某个文件包含在多个作用域中,并且您在这些作用域中启用了检查,PyCharm 将根据它们在列表中的顺序进行处理。 位于顶部的作用域具有最高优先级,并将首先进行分析。

  1. 设置 对话框(Ctrl+Alt+S )中,选择 编辑器 | 检查

  2. 在列表中选择任意检查。

  3. 在所有作用域中 列表中,选择 编辑范围顺序

  4. 选择所需的作用域,并使用 上移按钮下移按钮 在列表中上移或下移它。

    更改作用域顺序
  5. 如有需要,创建新作用域。 为此,点击 编辑按钮编辑作用域… ),指定作用域设置,并选择要包含在其中的文件和文件夹。

    创建新作用域
最后修改日期: 2025年 12月 2日