Command line wrapper for pyright
Project description
Pyright for Python
This project is not affiliated with Microsoft in any way, shape or form
Pyright for Python is a Python command line wrapper over pyright, a static type checker for Python.
This project is not suitable for production usage.
Installation
Use the package manager pip to install pyright.
pip install pyright
Usage
Pyright can be invoked using two different methods
pyright --help
or
python3 -m pyright --help
Pyright for Python should work exactly the same as pyright does, see the pyright documentation for details on how to make use of pyright.
Motivation
Pyright is written in TypeScript and requires node to be installed and is normally installed with npm, this could be a barrier for entry for some python developers as they may not have node or npm, installed on their machine, I wanted to make pyright as easy to install as any normal python package.
Implementation Notes
This project works by downloading node at runtime using nodeenv and then installing pyright, while this works, it is far from ideal.
There are at least two options for fixing this problem, the first is to package a wheel for each platform containing a node binary, I do not know if we can get around installing pyright at runtime as npm install
could have platform specific dependencies.
The second option is to use pkg to create a pyright binary and package that in wheels.
Configuration
You can configure Pyright for Python using environment variables.
Debugging
Set PYRIGHT_PYTHON_DEBUG
to any value.
Modify Pyright Version
Set PYRIGHT_PYTHON_VERSION
to the desired version, e.g. 1.1.150
Modify Node Env Location
Set PYRIGHT_PYTHON_ENV_DIR
to a valid nodeenv directory. e.g. ~/.cache/nodeenv
Contributing
All pull requests are welcome.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.