Ruff PyCharm Plugin

Help

See documentation for more details.

Sponsors

JetBrains

Astral

Quick Installation

ScreenShots

Features

• [x] Inspection and highlighting
• [x] Integrating Reformat Code with ⌥⇧ ⌘ L or Ctrl+Alt+L
• [x] Quick Fix (from mouse-over, ⌥⏎ or Alt+Enter)
• [x] Show fix message
• [x] Suppressing warnings with # noqa:
• [x] Show code explanation tooltips when hovering # noqa: <code>
• [x] Run ruff --fix as an action
• [x] Run ruff --fix for a file when the file is saved
• [x] Detect both global and project-specific instances of ruff
• [x] Always use global ruff command
• [x] Custom global ruff executable path
• [x] Detect a project ruff after packages refreshed
• [x] Execute ruff command as a new process
• [x] Support ruff config file path as an option
• [x] Detect ruff executable in Conda environment
• [x] Detect ruff executable in WSL
• [x] Support Ruff LSP feature
• LSP Client
  • [x] JetBrains LSP integration for unified PyCharm, including free mode
  • [x] LSP4IJ by RedHat (Requires installation of the LSP4IJ plugin)
• LSP Server
  • [x] ruff-lsp integration
  • [x] ruff server integration
• [x] Live Config Reload: Automatically updates from pyproject.toml and ruff.toml without restarting
• [x] Support ruff format for ruff version 0.0.289 or later [Experimental]

JetBrains LSP client support

In unified PyCharm builds, including free mode, you can enable the JetBrains LSP client in Preferences/Settings -> Tools -> Ruff.

PyCharm made the LSP client APIs available without a paid subscription starting with 2025.1: https://platform.jetbrains.com/t/update-on-lsp-and-template-language-apis-in-pycharm/1453

The lsp integration applies only below features: - Errors/warnings highlighting (textDocument/publishDiagnostics) - Quick-fixes for these errors/warnings (textDocument/codeAction

This is experimental feature.

Contribute

We are waiting for your contributions to ruff-pycharm-plugin.

Links

JetBrains Plugin Page

Other PyCharm plugin projects

Pydantic PyCharm Plugin