ContextQMD
Back to Pyrefly

Pyrefly VS Code Extension

lsp/README.md

1.2.03.2 KB
Original Source

Pyrefly VS Code Extension

The Pyrefly extension uses Pyrefly to provide language server features for Python in VS Code. Please see pyrefly.org for more information.

Features

The Pyrefly extension:

  • Adds inline type errors matching the Pyrefly command-line to your editor. By default, a project without a Pyrefly configuration uses the basic preset or auto-migrated settings from a nearby mypy.ini / pyrightconfig.json. Set python.pyrefly.typeCheckingMode to choose a different preset.
  • Adds language features from Pyrefly's analysis like go-to definition, hover, etc. (full list here) and disables Pylance completely (VSCode's built-in Python extension)
  • Adds a Pyrefly: Infer Types for Current File command that writes inferred type annotations to the active Python file.

Customization

By default, Pyrefly should work in the IDE with no configuration necessary. But to ensure your project is set up properly, see configurations.

The following configuration options are IDE-specific and exposed as VSCode settings:

  • python.pyrefly.typeCheckingMode [enum: auto, off, basic, legacy, default, strict, all; default: auto]: Preset to use for files not covered by a pyrefly.toml. The default auto migrates a nearby mypy/pyright config when present, otherwise uses basic.
  • python.pyrefly.disableTypeErrors [boolean: false]: If true, Pyrefly will not provide diagnostics for files in this workspace.
  • python.pyrefly.displayTypeErrors (deprecated): replaced by python.pyrefly.typeCheckingMode and python.pyrefly.disableTypeErrors. Still accepted for backwards compatibility.
  • python.pyrefly.disableLanguageServices [boolean: false]: by default, Pyrefly will provide both type errors and other language features like go-to definition, intellisense, hover, etc. Enable this option to keep type errors from Pyrefly unchanged but use VSCode's Python extension for everything else.
  • python.pyrefly.disabledLanguageServices [json: {}]: a config to disable certain lsp methods from pyrefly. For example, if you want go-to definition but not find-references.
  • pyrefly.lspPath [string: '']: if your platform is not supported, you can build pyrefly from source and specify the binary here.
  • python.pyrefly.configPath [string: '']: path to a pyrefly.toml or pyproject.toml configuration file. When set, the LSP will use this config for all files in your workspace instead of the default Pyrefly config-finding logic wherever possible.
  • python.analysis.showHoverGoToLinks [boolean: true]: Controls whether hover tooltips include "Go to definition" and "Go to type definition" navigation links. Set to false for cleaner tooltips with only type information.
  • python.analysis.autoImportCompletions [boolean: true]: Controls whether completions include symbols that are not yet imported. When enabled, accepting such a completion also inserts the required import statement. Set to false to only complete symbols that are already in scope.