ty extension for Visual Studio Code

Notice: This repository is a customized build of the upstream ty VS Code extension. Changes will be listed here(TODO).

working with config(with pixi)

  // needs `pixi g i ty`
  "ty.importStrategy": "fromEnvironment",
  "ty.interpreter": [
    "${workspaceFolder}/.pixi/envs/default/bin/python",
  ],

A Visual Studio Code extension for ty, an extremely fast Python type checker and language server, written in Rust.

The extension ships with ty==0.0.10.

Installation

Install this extension from the Visual Studio Marketplace.

Features

Currently, the extension supports the following features:

• File and workspace level diagnostics
• Hover type information for symbols
• Go to definition
• Go to declaration
• Go to type definition
• Go to symbol
• Open symbol by name
• Find references
• Inlay hints
• Completions
• Signature help
• Highlight references of symbols
• Semantic highlighting
• Symbol renaming

Usage

Once installed in Visual Studio Code, ty will automatically execute when you open or edit a Python or Jupyter Notebook file.

The extension automatically disables the language server from the Python extension to avoid running two Python language servers. This is done by setting python.languageServer to "None" as a default configuration.

If you prefer to use ty only for type checking and want to use another language server for capabilities like hover, auto-completions, etc., you can override this by explicitly setting python.languageServer and ty.disableLanguageServices in your settings.json:

{
  "python.languageServer": "Pylance",
  "ty.disableLanguageServices": true,
}

If you don't want to use ty for a specific workspace, disable this extension in VS code.

Untrusted Workspace

The extension supports untrusted workspace. For untrusted workspaces, the extension always uses the bundled ty executable, ignoring the following settings:

• ty.importStrategy
• ty.interpreter
• ty.path

Settings

See the ty editor settings reference for an enumeration of all supported settings.

Commands

Requirements

This extension requires a version of the VSCode Python extension that supports Python 3.8+. ty itself is compatible with Python 3.8 to 3.14.

Getting help

See the troubleshooting guide to get more information on how to debug issues with the extension or the language server.

Publisher

This extension is published under the astral-sh account, which differs from our Ruff extension that uses the "charliermarsh" publisher. Both extensions are official products from Astral.

License

The ty extension is licensed under the MIT license (LICENSE).