PyCharm 2025.3 Help

从命令行运行代码检查

PyCharm 运行代码检查 ,以查找并突出显示语法错误、死代码、可能的错误、不良的编码风格及其他问题。 您还可以从命令行为特定项目运行所有已配置的检查,并将结果连同报告保存为 XML、JSON 或纯文本文件。

命令行检查器会在后台启动一个 PyCharm 实例,并在其中运行检查。 如果另一个 PyCharm 实例已在运行,则无法工作。 在这种情况下,您可以在正在运行的实例中使用检查。 对于拥有众多参与者的大型项目,请使用命令行检查器进行自动化的常规代码分析。

您可以在安装目录的 bin 下找到用于运行 PyCharm 的可执行文件。 要将此可执行文件用作命令行启动器,请按照 命令行界面 中的说明将其添加到系统的 PATH

语法
pycharm64.exe inspect <project> <inspection-profile> <output> [<options>]
示例

以最大详细程度使用 C:\MyProject\.idea\inspectionProfiles\MyProfile.xml 配置文件检查 C:\MyProject 项目的 C:\MyProject\src 目录,并将结果保存到 C:\MyProject\InspectionResults 下的 XML 文件:

pycharm64.exe inspect C:\MyProject C:\MyProject\.idea\inspectionProfiles\MyProfile.xml C:\MyProject\InspectionResults -v2 -d C:\MyProject\src

PyCharm 包含一个用于运行命令行代码检查器的脚本。 默认情况下,它位于应用程序包中: PyCharm.app/Contents/bin/inspect.sh

语法
inspect.sh <project> <inspection-profile> <output> [<options>]
示例

以最大详细程度使用 ~/MyProject/.idea/inspectionProfiles/MyProfile.xml 配置文件检查 ~/MyProject 项目的 ~/MyProject/src 目录,并将结果保存到 ~/MyProject/InspectionResults 下的 XML 文件:

inspect.sh ~/MyProject ~/MyProject/.idea/inspectionProfiles/MyProfile.xml ~/MyProject/InspectionResults -v2 -d ~/MyProject/src

您可以在安装目录的 bin 下找到用于运行 PyCharm 的脚本。 要将此脚本用作命令行启动器,请按照 命令行界面 中的说明将其添加到系统的 PATH

语法
pycharm.sh inspect <project> <inspection-profile> <output> [<options>]
示例

以最大详细程度使用 ~/MyProject/.idea/inspectionProfiles/MyProfile.xml 配置文件检查 ~/MyProject 项目的 ~/MyProject/src 目录,并将结果保存到 ~/MyProject/InspectionResults 下的 XML 文件:

pycharm.sh inspect ~/MyProject ~/MyProject/.idea/inspectionProfiles/MyProfile.xml ~/MyProject/InspectionResults -v2 -d ~/MyProject/src

选项

选项

说明

-changes

仅对本地未提交的更改运行检查。

-d

如果您不想检查整个项目,请指定子目录的完整路径。

-format

指定包含检查结果的输出文件格式: xml (默认)、 jsonplain

-v

设置输出的详细程度级别:

  • -v0 为默认的低详细程度。

  • -v1 为中等详细程度。

  • -v2 为最大详细程度。

检查配置文件

一个 检查配置文件 是一个 .xml 文件,用于指定启用的检查及其选项。

默认情况下, 项目检查配置文件 存储在项目目录: .idea/inspectionProfiles

全局 IDE 检查配置文件 存储在 IDE 配置目录中,该目录位于 检查 下。

检查结果

您可以在 PyCharm 或任何文本编辑器中像普通文件一样打开生成的包含检查结果的 XML 文件。 不过,使用 问题工具窗口离线查看 来分析它会更方便:

查看检查结果

  1. 打开您运行检查的项目。

  2. 在主菜单中,转到 代码 | 分析代码 | 查看离线检查结果

  3. 选择包含检查结果的目录,然后点击 确定

最后修改日期: 2025年 12月 2日