What is this?
Pyright is a full-featured, standards-based static type checker for Python, built by Microsoft for speed on large codebases.
Pyright is a full-featured, standards-based static type checker for Python, built by Microsoft for speed on large codebases.Is it a command-line tool, an editor plugin, or both?Both: it ships as a command-line tool and as an extension for Visual Studio Code, and there is also a browser Playground for quick trials.
Both: it ships as a command-line tool and as an extension for Visual Studio Code, and there is also a browser Playground for quick trials.How do I get it running?The README refers you to the project documentation for installation, configuration and usage; for a zero-install taste there is the Pyright Playground that runs in your browser.
The README refers you to the project documentation for installation, configuration and usage; for a zero-install taste there is the Pyright Playground that runs in your browser.Is it written in Python like the code it checks?No — despite checking Python code, Pyright itself is a TypeScript project: this repo builds with pnpm, lerna and webpack on Node.js tooling.
No — despite checking Python code, Pyright itself is a TypeScript project: this repo builds with pnpm, lerna and webpack on Node.js tooling.Any environment quirks I should know about, say on servers or in containers?In remote/server environments where the OS temp directory doesn't exist or isn't writable, set the PYRIGHTTMPDIR environment variable to an absolute path — Pyright will create it and use it for temporary files.
In remote/server environments where the OS temp directory doesn't exist or isn't writable, set the PYRIGHTTMPDIR environment variable to an absolute path — Pyright will create it and use it for temporary files.Will it cope with a large codebase?Yes — performance was a design goal, and Pyright is explicitly built to be used with large Python source bases.
Yes — performance was a design goal, and Pyright is explicitly built to be used with large Python source bases.Which platforms does it work on?The CLI and the VS Code extension run on Windows, macOS and Linux, so it covers the usual developer setups regardless of OS.
The CLI and the VS Code extension run on Windows, macOS and Linux, so it covers the usual developer setups regardless of OS.What is the difference between Pyright and Pylance?Core type checking functionality is associated with Pyright, while language service functionality is associated with Pylance; the same contributors monitor both repos, so issues can be filed in either tracker.
Core type checking functionality is associated with Pyright, while language service functionality is associated with Pylance; the same contributors monitor both repos, so issues can be filed in either tracker.Can I try it without installing anything?Yes — the Pyright Playground runs in your browser, so you can experiment with its type checking before installing the CLI or the VS Code extension.
Yes — the Pyright Playground runs in your browser, so you can experiment with its type checking before installing the CLI or the VS Code extension.Do I have to use VS Code to get value from it?No — the command-line tool works standalone in any terminal, locally or in CI; the VS Code extension just adds the in-editor experience.
No — the command-line tool works standalone in any terminal, locally or in CI; the VS Code extension just adds the in-editor experience.Which topics is it in?typechecker, static-code-analysis, vscode-extension, microsoft, vscode, code-quality, static-analysis, cli-tool, developers, tool, nodejs, typescript
typechecker, static-code-analysis, vscode-extension, microsoft, vscode, code-quality, static-analysis, cli-tool, developers, tool, nodejs, typescript