PyCharm 2016.2 Help

Running Inspection by NameAnalyzing Inspection Results

Running Inspections Offline

On this page:

Basics

In addition to running code inspections from the main menu, or from the context menus of the Project tool window, you can also launch the inspector from the command line, without actually running PyCharm.

This way you can perform regular code inspections as a part of your development process, which is especially important for large projects. Inspection results are stored in the XML format.

Launching a code inspection from the command line

To launch a code inspection from the command line

  • Specify the following command line arguments:
    • Path to the launcher: specify the full path to one of the following launchers (which reside under the bin directory of your PyCharm installation):
      • For Windows: inspect.bat
      • For UNIX and OS X: inspect.sh
    • Project file path is the full path to the directory that contains the project to be inspected.
    • Inspection profile path is the full path to the profile, against which the project should be inspected. The inspection profiles are stored under USER_HOME\.PyCharmXX\config\inspection
    • Output path is the full path to an existing directory where the report will be stored.
    • Options. You can specify:
      • The directory to be inspected -d <full path to the subdirectory>
      • The verbosity level of output -vX, where X is 0 for quiet, 1 for noisy and 2 for extra noisy.

Examples

Windows

C:\Program Files (x86)\JetBrains\<PyCharm home>\bin\inspect.bat E:\SampleProjects\MetersToInchesConverter E:\Work\MyProject\.idea\inspectionProfiles\Project_Default.xml E:\Work\MyProject\inspection-results-dir -v2 -d E:\SampleProjects\MetersToInchesConverter\subdirectory

OS X

/Applications/PyCharm.app/Contents/bin/inspect.sh ~/PyCharmProjects/MyTestProject ~/Library/Preferences/pycharmXX/inspection/Default.xml ~/PyCharmProjects/MyTestProject/results-dir -v2

Viewing the results of an offline inspection

If you have performed an offline inspection and exported the inspection results to a directory in the XML format you can always download and view these results.

To view the results of an offline inspection, follow these steps

  1. Open the project against which the inspection was performed.
  2. On the main menu, choose Code | View Offline Inspection Results.
  3. In the Select Path dialog box that opens, navigate to the directory that contains inspection results in XML format.
  4. Click OK. Inspection results display in the Offline View tab in the Inspection tool window.
Running Inspection by NameAnalyzing Inspection Results

See Also

Reference:

Last modified: 23 November 2016