Type checkers
What is Pyright? An introduction to Microsoft's static type checker for Python
Pyright is a full-featured, standards-based static type checker for Python from Microsoft. It is designed for high performance and large codebases, and it includes a command-line tool and a Visual Studio Code extension.
- Tool
- Pyright
- Made by
- Microsoft
- Official site
- github.com/microsoft/pyright
- Category
- Type checkers
Who makes Pyright
Pyright is made by Microsoft. The project has adopted the Microsoft Open Source Code of Conduct, and contributions generally require agreeing to a Contributor License Agreement.
The official website, the project's GitHub repository at github.com/microsoft/pyright, is linked below.
Official website: github.com/microsoft/pyright
What Pyright is for
Pyright is for checking Python code for type errors without running it. It follows published standards rather than a private type system, which is what the vendor means by calling it standards-based.
It is built with scale in mind. Its design targets high performance and large codebases, where the time a type checker takes becomes part of the daily development loop.
Pyright can be used from a terminal through its command-line tool or inside the editor through its Visual Studio Code extension. A browser-based Pyright Playground is also available for trying it without installing anything.
Who Pyright is for
The vendor names Python developers and contributors to large Python codebases as the audience. Anyone writing typed Python can use it, and the emphasis on performance speaks to people working in big projects.
It also suits people who want to follow how the checker performs. A weekly benchmark compares Pyright with other Python type checkers, and release history tracks execution time and peak memory per package.
Notable capabilities
Pyright's feature set centers on standards-based checking, speed and flexible ways to run it. These are the capabilities listed in its facts.
- Full-featured type checking: it is a full-featured, standards-based static type checker for Python.
- Built for scale: it is designed for high performance and large codebases.
- Command-line tool: it includes a command-line tool for running checks outside an editor.
- Editor integration: it includes a Visual Studio Code extension.
- Browser playground: a browser-based Pyright Playground is available.
- Published benchmarks: a weekly benchmark compares Pyright with other Python type checkers.
- Resource tracking: release history tracks execution time and peak memory per package.
- Configurable temp directory: the temp directory can be overridden via PYRIGHT_TMPDIR.
How Pyright fits type checkers
Type checkers verify that code uses values consistently with their declared types. Pyright covers this for Python and puts weight on performance, which matters most when a codebase is large.
In Linthelm's wider niche of linters, static analysis and code quality, Pyright is a static analysis tool that works on source code alone. It complements style-focused linters by checking correctness of types rather than formatting or convention.
The project also separates responsibilities clearly: core type checking issues belong to Pyright, while language service issues belong to Pylance. Knowing that boundary helps when deciding where to report a problem seen in an editor.
Frequently asked questions
What is Pyright used for?
Pyright is used to statically type check Python code. It is a full-featured, standards-based type checker designed for high performance and large codebases.
Who develops Pyright?
Pyright is from Microsoft. The project has adopted the Microsoft Open Source Code of Conduct, and contributions generally require agreeing to a Contributor License Agreement.
Does Pyright work in Visual Studio Code?
Yes. Pyright includes a Visual Studio Code extension as well as a command-line tool.
Can I try Pyright without installing it?
Yes. A browser-based Pyright Playground is available.
Where should I report a Pyright or Pylance issue?
Core type checking issues belong to Pyright, while language service issues belong to Pylance.
Linthelm is independent and is not affiliated with Microsoft. Product names belong to their owners. Features change; confirm details on the official website.