ty extension for Visual Studio Code

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.1a27.

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

And, the following experimental features:

• Symbol renaming (ty.experimental.rename)
• Auto import completions (ty.experimental.autoImport)

Usage

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

It's recommended to disable the language server from the Python extension to avoid running two Python language servers by adding the following setting to your settings.json:

{
  "python.languageServer": "None"
}

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 settings for an enumeration of all supported settings.

Commands

Command	Description
ty: Restart server	Restart the ty language server
ty: Show client logs	Open the "ty" output channel
ty: Show server logs	Open the "ty Language Server" output channel
ty: Open debug information	Opens a window with debug information

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.13.

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 verified "charliermarsh" publisher. Both extensions are official products from Astral. We are currently working with the VS Code Marketplace team to complete the verification process for this extension. For more information, see issue #14.

License

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