Python tools support

Go to Python | Tools | Ruff in the Settings dialog (Ctrl+Alt+S) .

Select the Enable checkbox to start configuring Ruff settings.

In the Execution mode setting, select how PyCharm should search for the Ruff executable:

• Interpreter mode: PyCharm searches for a Ruff executable installed in your interpreter. To install the Ruff package for the selected interpreter, click Install Ruff.

• Path mode: PyCharm searches for a Ruff executable in $PATH. If the executable is not found, you can specify the path by clicking the Browse... icon.

Select which Ruff options should be enabled:

• Inspections

• Formatting

• Import optimizer

Click All actions on save... to configure additional options. If Ruff integration is enabled in the settings, it will be used when you run Reformat code or Optimize imports.

Ruff settings can also be configured using a pyproject.toml, ruff.toml, or .ruff.toml file. For more information, refer to the Ruff documentation.

Go to Python | Tools | Pyrefly in the Settings dialog (Ctrl+Alt+S) .

Select the Enable checkbox to start configuring Pyrefly settings.

In the Execution mode setting, select how PyCharm should search for the Pyrefly executable:

• Interpreter mode: PyCharm searches for a Pyrefly executable installed in your interpreter. To install the Pyrefly package for the selected interpreter, click Install Pyrefly.

• Path mode: PyCharm searches for a Pyrefly executable in $PATH. If the executable is not found, you can specify the path by clicking the Browse... icon.

Select which Pyrefly options should be enabled:

• Inspections

• Completions

• Inlay hints

Pyrefly settings can be configured using a pyrefly.toml or pyproject.toml file. For more information, refer to the Pyrefly documentation.

Go to Python | Tools | Pyright in the Settings dialog (Ctrl+Alt+S) .

Select the Enable checkbox to start configuring Pyright settings.

In the Execution mode setting, select how PyCharm should search for the Pyright executable:

• Interpreter mode: PyCharm searches for a Pyright executable installed in your interpreter. To install the basedpyright package for the selected interpreter, click Install basedpyright.

  If you want to use plain Pyright, install pyright[nodejs].

• Path mode: PyCharm searches for a Pyright executable in $PATH. If the executable is not found, you can specify the path by clicking the Browse... icon.

Select which Pyright options should be enabled:

• Inspections

• Completions

• Inlay hints (available for basedpyright only)

Pyright settings can be configured using a pyrightconfig.json or pyproject.toml file. For more information, refer to the Pyright and basedpyright documentation.

Go to Python | Tools | ty in the Settings dialog (Ctrl+Alt+S) .

Select the Enable checkbox to start configuring ty settings.

In the Execution mode setting, select how PyCharm should search for the ty executable:

• Interpreter mode: PyCharm searches for a ty executable installed in your interpreter. To install the ty package for the selected interpreter, click Install ty.

• Path mode, PyCharm searches for a ty executable in $PATH. If the executable is not found, you can specify the path by clicking the Browse... icon.

Select which ty options should be enabled:

• Inspections

• Completions

• Inlay hints

ty settings can be configured using a pyproject.toml or ty.toml file. For more information, refer to the ty documentation.

Go to Python | Tools | Black in the Settings dialog (Ctrl+Alt+S) .

In the Execution mode drop-down, select how PyCharm should run the Black formatter:

• Binary mode: PyCharm uses the Black executable installed in your system. If the executable is not found, you can specify the path by clicking the Browse... icon:

  

• Package mode: PyCharm uses the Black package installed in the project interpreter. To install the Black package for the selected interpreter, click Install Black:

  

Select when do you want to run the Black formatter:

• Enable the On code reformat checkbox to use Black instead of the built-in formatter when you press Ctrl+Alt+L or select Code | Reformat Code from the main menu.

• Select On save if you want to run Black formatter automatically when your changes are saved. To configure additional actions, click All actions on save....

The settings of the Black formatter can be configured in a pyproject.toml file. For Black v21.4.0 and higher, they are applied automatically. For more information, refer to the Black documentation.

You can also use the Settings field to specify additional options or override the settings from pyproject.toml:

For more information, refer to the Black CLI reference.