Pyright is a fast type checker meant for large Python source bases. It can run in a “watch” mode and performs fast incremental updates when files are modified.
Pyright supports [configuration files](/docs/configuration.md) that provide granular control over settings. Different “execution environments” can be associated subdirectories within a source base. Each environment can specify different module search paths, python language versions, and platform targets.
Pyright includes a recent copy of the stdlib type stubs from [Typeshed](https://github.com/python/typeshed). It can be configured to use another (perhaps more recent or modified) copy of the Typeshed type stubs. Of course, it also works with custom type stub files that are part of your project.
Pyright includes both a [command-line tool](/docs/command-line.md) and an [extension for Visual Studio Code](https://github.com/Microsoft/pyright) that implements the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/).
For rich Python editing and debugging cabailities with Visual Studio Code, be sure to also install the official [Microsoft Python extension for Visual Studio Code](https://marketplace.visualstudio.com/itemdetails?itemName=ms-python.python) as Pyright only provides syntax and type checking.
Pyright is a work in progress. Type-checking capabilities are not fully implemented. For a list of incomplete functionality, refer to the TODO list below.
**A:** Pyright is focused entirely on type checking, and is a side project with no dedicated team. The Python VS Code plugin is Microsoft's officially supported extension for Visual Studio Code, and provides diverse array of features including auto-complete, debugging, linter plugins, type checking plugins, and much more. Pyright can be used in alongide the Microsoft Python extension to combine the rich capabilities the Python extension provides with the type checking capabilities of pyright.
**A:** The Microsoft Python Language Server is a [language server protocol (LSP)](https://microsoft.github.io/language-server-protocol/) implementation that works with the Microsoft Python Visual Studio Code plugin, and it is officially supported by a team of Microsoft engineers. It focuses on providing core editing capabilities such as auto-completion (including 3rd party libraries), code navigation, documentation, with syntax checking and some type checking capabilities. Pyright is focused entirely on providing fast syntax and comprehensive type checking for your own code base with some unique features such as more configurabilty, command-line execution.
**A:** Pyright is a side project with no dedicated team, there is no guarantee of continued development on the project. If you find it useful feel free to use it and contribute to the code base.
You can install the latest-published version of the Pyright VS Code extension directly from VS Code. Simply open the extensions panel and search for `pyright`.
Pyright is a work in progress. The following functionality is not yet finished. If you would like to contribute to any of these areas, contact the maintainers of the repo.
