Overview

The plugin provides two configuration panels, one IDE-level and one project-level. They can be found under the Tools section of the Settings panel.

Project-level configurations only override the IDE-level counterparts when the corresponding "Override" checkboxes are selected.

Project-level settings are stored in the pyright.xml file under the .idea directory and can be shared with other people (for example, via version-control systems) to serve as the default settings for the project.

Override settings are stored in the pyright-overrides.xml file in the same directory. This file should not be committed, as its purpose is to allow overriding project defaults.

Note

To configure highlight severity levels, use the inspection entry's corresponding pane.

Minimum requirements

For the plugin to work, at least one executable needs to be specified. Note that different running modes require different executables.