PyCharm 2024.1 Help

Running with coverage

PyCharm provides a dedicated action for performing run with the code coverage measurement. The code coverage data is processed according to the option selected on the Coverage page of the Settings dialog (Ctrl+Alt+S) .

Run with code coverage

  1. Do one of the following:

    • Open the desired file in the editor, and choose Run <name> with Coverage from the context menu. When running tests with coverage, note that you can run the entire test class, or each individual test method, depending on the caret location.

    • Open the desired file in the Project tool window and choose Run <name> with Coverage from the context menu. You can also select a directory with test files and choose the corresponding command from the context menu to run several tests with coverage.

    • Select the desired run/debug configuration, and then from the main menu choose Run | Run <run/debug configuration name> with coverage.

    • On the main toolbar, click the More Actions | Run <run/debug configuration name> with Coverage. This will launch the selected run/debug configuration.

  2. If the Show options before applying coverage to the editor checkbox has been selected in Settings Ctrl+Alt+S | Build, Execution, Deployment | Coverage, a dialog appears where you can choose whether you want to replace the active coverage suites, add the collected data to the active suites, or not apply coverage data. You can also opt to skip this dialog in the future. In case any other option has been selected, the respective action will be performed silently.

  3. Explore the collected coverage data in the Coverage Tool Window


Hide coverage results

  • To hide coverage results, you can do the following:

    • Close a tab with coverage statistics in the Coverage tool window.

    • Click a coverage highlighting in a gutter and select Hide coverage.

Last modified: 28 March 2024