# Pyright for Python
[](https://pepy.tech/project/pyright)
> This project is not affiliated with Microsoft in any way, shape, or form
Pyright for Python is a Python command-line wrapper over [pyright](https://github.com/microsoft/pyright), a static type checker for Python.
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install pyright.
```bash
pip install pyright
```
> [!TIP]
> It's highly recommended to install `pyright` with the `nodejs` extra which uses [`nodejs-wheel`](https://pypi.org/project/nodejs-wheel-binaries/) to
> download Node.js binaries as it is more reliable than the default [`nodeenv`](https://pypi.org/project/nodeenv/) solution.
>
> ```bash
> pip install pyright[nodejs]
> ```
## Usage
Pyright can be invoked using two different methods
```bash
pyright --help
```
or
```bash
python3 -m pyright --help
```
Pyright for Python should work exactly the same as pyright does, see the [pyright documentation](https://github.com/microsoft/pyright/blob/main/docs/getting-started.md) for details on how to make use of pyright.
### Pre-commit
You can also setup pyright to run automatically before each commit by setting up [pre-commit](https://pre-commit.com) and registering pyright in your `.pre-commit-config.yaml` file
```yaml
repos:
- repo: https://github.com/RobertCraigie/pyright-python
rev: v1.1.389
hooks:
- id: pyright
```
Pre-commit will install pyright-python in its own virtual environment which can cause pyright to not be able to detect your installed dependencies.
To fix this you can either [tell pre-commit](https://pre-commit.com/#config-additional_dependencies) to also install those dependencies or explicitly tell pyright which virtual environment to use by updating your [pyright configuration file](https://github.com/microsoft/pyright/blob/main/docs/configuration.md):
```toml
[tool.pyright]
# ...
venvPath = "."
venv = ".venv"
```
## Motivation
[Pyright](https://github.com/microsoft/pyright) is written in TypeScript, requiring node to be installed, and is normally installed with npm. This could be an entry barrier 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.
## How Pyright for Python Works
This project works by first checking if node is in the `PATH`. If it is not, then we download node at runtime using [nodeenv](https://github.com/ekalinin/nodeenv), then install the pyright npm package using `npm` and finally, run the downloaded JS with `node`.
## Automatically keeping pyright up to date
By default Pyright for Python is set to target a specific pyright version and new releases will be automatically created whenever a new pyright version is released. It is highly recommended to use an automatic dependency update tool such as [dependabot](https://docs.github.com/en/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates).
If you would rather not have to update your installation every time a new pyright release is created then you can automatically use the latest available pyright version by setting the environment variable `PYRIGHT_PYTHON_FORCE_VERSION` to `latest`.
## Configuration
You can configure Pyright for Python using environment variables.
### Debugging
Set `PYRIGHT_PYTHON_DEBUG` to any value.
### Modify Pyright Version
Set `PYRIGHT_PYTHON_FORCE_VERSION` to the desired version, e.g. `1.1.156`, `latest`
### Keeping Pyright and Pylance in sync
Set `PYRIGHT_PYTHON_PYLANCE_VERSION` to your Pylance version, e.g. `2023.11.11`, `latest-release`, `latest-prerelease`. The corresponding Pyright version will be used. See [Pylance's changelog](https://github.com/microsoft/pylance-release/blob/main/CHANGELOG.md) for details on recent releases. Note that `PYRIGHT_PYTHON_FORCE_VERSION` takes precedence over `PYRIGHT_PYTHON_PYLANCE_VERSION`, so you'll want to set one or the other, not both.
### Show NPM logs
By default, Pyright for Python disables npm error messages, if you want to display the npm error messages then set `PYRIGHT_PYTHON_VERBOSE` to any truthy value.
### Modify NPM Package Location
Pyright for Python will resolve the root cache directory by checking the following environment variables, in order:
- `PYRIGHT_PYTHON_CACHE_DIR`
- `XDG_CACHE_HOME`
If neither of them are set it defaults to `~/.cache`
### Force Node Env
Set `PYRIGHT_PYTHON_GLOBAL_NODE` to any non-truthy value, i.e. anything apart from 1, t, on, or true.
e.g. `off`
You can optionally choose the version of node used by setting `PYRIGHT_PYTHON_NODE_VERSION` to the desired version
### Modify Node Env Location
Set `PYRIGHT_PYTHON_ENV_DIR` to a valid [nodeenv](https://github.com/ekalinin/nodeenv) directory. e.g. `~/.cache/nodeenv`
### Ignore Warnings
Set `PYRIGHT_PYTHON_IGNORE_WARNINGS` to a truthy value, e.g. 1, t, on, or true.
Pyright for Python will print warnings for the following case(s)
- There is a new Pyright version available.
## Contributing
All pull requests are welcome.
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/RobertCraigie/pyright-python",
"name": "pyright",
"maintainer": "Robert Craigie",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Robert Craigie",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/72/4e/9a5ab8745e7606b88c2c7ca223449ac9d82a71fd5e31df47b453f2cb39a1/pyright-1.1.389.tar.gz",
"platform": null,
"description": "# Pyright for Python\n\n[](https://pepy.tech/project/pyright)\n\n\n\n> This project is not affiliated with Microsoft in any way, shape, or form\n\nPyright for Python is a Python command-line wrapper over [pyright](https://github.com/microsoft/pyright), a static type checker for Python.\n\n## Installation\n\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install pyright.\n\n```bash\npip install pyright\n```\n\n> [!TIP]\n> It's highly recommended to install `pyright` with the `nodejs` extra which uses [`nodejs-wheel`](https://pypi.org/project/nodejs-wheel-binaries/) to\n> download Node.js binaries as it is more reliable than the default [`nodeenv`](https://pypi.org/project/nodeenv/) solution.\n>\n> ```bash\n> pip install pyright[nodejs]\n> ```\n\n\n## Usage\n\nPyright can be invoked using two different methods\n\n```bash\npyright --help\n```\n\nor\n\n```bash\npython3 -m pyright --help\n```\n\nPyright for Python should work exactly the same as pyright does, see the [pyright documentation](https://github.com/microsoft/pyright/blob/main/docs/getting-started.md) for details on how to make use of pyright.\n\n### Pre-commit\n\nYou can also setup pyright to run automatically before each commit by setting up [pre-commit](https://pre-commit.com) and registering pyright in your `.pre-commit-config.yaml` file\n\n```yaml\nrepos:\n - repo: https://github.com/RobertCraigie/pyright-python\n rev: v1.1.389\n hooks:\n - id: pyright\n```\n\nPre-commit will install pyright-python in its own virtual environment which can cause pyright to not be able to detect your installed dependencies.\n\nTo fix this you can either [tell pre-commit](https://pre-commit.com/#config-additional_dependencies) to also install those dependencies or explicitly tell pyright which virtual environment to use by updating your [pyright configuration file](https://github.com/microsoft/pyright/blob/main/docs/configuration.md):\n\n```toml\n[tool.pyright]\n# ...\nvenvPath = \".\"\nvenv = \".venv\"\n```\n\n## Motivation\n\n[Pyright](https://github.com/microsoft/pyright) is written in TypeScript, requiring node to be installed, and is normally installed with npm. This could be an entry barrier 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.\n\n## How Pyright for Python Works\n\nThis project works by first checking if node is in the `PATH`. If it is not, then we download node at runtime using [nodeenv](https://github.com/ekalinin/nodeenv), then install the pyright npm package using `npm` and finally, run the downloaded JS with `node`.\n\n## Automatically keeping pyright up to date\n\nBy default Pyright for Python is set to target a specific pyright version and new releases will be automatically created whenever a new pyright version is released. It is highly recommended to use an automatic dependency update tool such as [dependabot](https://docs.github.com/en/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates).\n\nIf you would rather not have to update your installation every time a new pyright release is created then you can automatically use the latest available pyright version by setting the environment variable `PYRIGHT_PYTHON_FORCE_VERSION` to `latest`.\n\n## Configuration\n\nYou can configure Pyright for Python using environment variables.\n\n### Debugging\n\nSet `PYRIGHT_PYTHON_DEBUG` to any value.\n\n### Modify Pyright Version\n\nSet `PYRIGHT_PYTHON_FORCE_VERSION` to the desired version, e.g. `1.1.156`, `latest`\n\n### Keeping Pyright and Pylance in sync\n\nSet `PYRIGHT_PYTHON_PYLANCE_VERSION` to your Pylance version, e.g. `2023.11.11`, `latest-release`, `latest-prerelease`. The corresponding Pyright version will be used. See [Pylance's changelog](https://github.com/microsoft/pylance-release/blob/main/CHANGELOG.md) for details on recent releases. Note that `PYRIGHT_PYTHON_FORCE_VERSION` takes precedence over `PYRIGHT_PYTHON_PYLANCE_VERSION`, so you'll want to set one or the other, not both.\n\n### Show NPM logs\n\nBy default, Pyright for Python disables npm error messages, if you want to display the npm error messages then set `PYRIGHT_PYTHON_VERBOSE` to any truthy value.\n\n### Modify NPM Package Location\n\nPyright for Python will resolve the root cache directory by checking the following environment variables, in order:\n\n- `PYRIGHT_PYTHON_CACHE_DIR`\n- `XDG_CACHE_HOME`\n\nIf neither of them are set it defaults to `~/.cache`\n\n### Force Node Env\n\nSet `PYRIGHT_PYTHON_GLOBAL_NODE` to any non-truthy value, i.e. anything apart from 1, t, on, or true.\ne.g. `off`\nYou can optionally choose the version of node used by setting `PYRIGHT_PYTHON_NODE_VERSION` to the desired version\n\n### Modify Node Env Location\n\nSet `PYRIGHT_PYTHON_ENV_DIR` to a valid [nodeenv](https://github.com/ekalinin/nodeenv) directory. e.g. `~/.cache/nodeenv`\n\n### Ignore Warnings\n\nSet `PYRIGHT_PYTHON_IGNORE_WARNINGS` to a truthy value, e.g. 1, t, on, or true.\n\nPyright for Python will print warnings for the following case(s)\n\n- There is a new Pyright version available.\n\n## Contributing\n\nAll pull requests are welcome.\n\n## License\n[MIT](https://choosealicense.com/licenses/mit/)\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Command line wrapper for pyright",
"version": "1.1.389",
"project_urls": {
"Homepage": "https://github.com/RobertCraigie/pyright-python",
"Source": "https://github.com/RobertCraigie/pyright-python",
"Tracker": "https://github.com/RobertCraigie/pyright-python/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1b26c288cabf8cfc5a27e1aa9e5029b7682c0f920b8074f45d22bf844314d66a",
"md5": "9c2adf0616198808f27d770b6335f471",
"sha256": "41e9620bba9254406dc1f621a88ceab5a88af4c826feb4f614d95691ed243a60"
},
"downloads": -1,
"filename": "pyright-1.1.389-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9c2adf0616198808f27d770b6335f471",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 18581,
"upload_time": "2024-11-13T16:35:40",
"upload_time_iso_8601": "2024-11-13T16:35:40.689940Z",
"url": "https://files.pythonhosted.org/packages/1b/26/c288cabf8cfc5a27e1aa9e5029b7682c0f920b8074f45d22bf844314d66a/pyright-1.1.389-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "724e9a5ab8745e7606b88c2c7ca223449ac9d82a71fd5e31df47b453f2cb39a1",
"md5": "0f0fec7873f77d5a1e176e68bd05f0e0",
"sha256": "716bf8cc174ab8b4dcf6828c3298cac05c5ed775dda9910106a5dcfe4c7fe220"
},
"downloads": -1,
"filename": "pyright-1.1.389.tar.gz",
"has_sig": false,
"md5_digest": "0f0fec7873f77d5a1e176e68bd05f0e0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 21940,
"upload_time": "2024-11-13T16:35:41",
"upload_time_iso_8601": "2024-11-13T16:35:41.840517Z",
"url": "https://files.pythonhosted.org/packages/72/4e/9a5ab8745e7606b88c2c7ca223449ac9d82a71fd5e31df47b453f2cb39a1/pyright-1.1.389.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 16:35:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RobertCraigie",
"github_project": "pyright-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "nodeenv",
"specs": [
[
">=",
"1.6.0"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
">=",
"4.1"
]
]
}
],
"tox": true,
"lcname": "pyright"
}
JSON
