pyright


Namepyright JSON
Version 1.1.256 PyPI version JSON
download
home_pagehttps://github.com/RobertCraigie/pyright-python
SummaryCommand line wrapper for pyright
upload_time2022-06-28 08:22:46
maintainerRobert Craigie
docs_urlNone
authorRobert Craigie
requires_python>=3.7
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Pyright for Python

[![Downloads](https://pepy.tech/badge/pyright)](https://pepy.tech/project/pyright)
![PyPI](https://img.shields.io/pypi/v/pyright)
![Supported python versions](https://img.shields.io/pypi/pyversions/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
```

## 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.237
    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) and then install the pyright npm package using `npx`.

We also automatically upgrade the pyright npm package to its latest version on every run, see below for how to change this behaviour.

## 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`

### 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.

### 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`

### 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)

- Using [nodeenv](https://github.com/ekalinin/nodeenv) without bash available

### Disable NPX Version Check

By default, Pyright for Python checks the version of the resolved `npx` binary, in some cases this [can cause an error](https://github.com/RobertCraigie/pyright-python/issues/56).

If this is the case for you, then you can disable the version check by setting the environment variable `PYRIGHT_PYTHON_IGNORE_NPX_CHECK` to any truthy value, e.g. 1, t, on or true.

## 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": "",
    "keywords": "",
    "author": "Robert Craigie",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/c0/b3/c61554be270553570669eb3156fe35edcb6aa6c70da93df63fafe4e1858e/pyright-1.1.256.tar.gz",
    "platform": null,
    "description": "# Pyright for Python\n\n[![Downloads](https://pepy.tech/badge/pyright)](https://pepy.tech/project/pyright)\n![PyPI](https://img.shields.io/pypi/v/pyright)\n![Supported python versions](https://img.shields.io/pypi/pyversions/pyright)\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## 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.237\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\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) and then install the pyright npm package using `npx`.\n\nWe also automatically upgrade the pyright npm package to its latest version on every run, see below for how to change this behaviour.\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### 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### 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`\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- Using [nodeenv](https://github.com/ekalinin/nodeenv) without bash available\n\n### Disable NPX Version Check\n\nBy default, Pyright for Python checks the version of the resolved `npx` binary, in some cases this [can cause an error](https://github.com/RobertCraigie/pyright-python/issues/56).\n\nIf this is the case for you, then you can disable the version check by setting the environment variable `PYRIGHT_PYTHON_IGNORE_NPX_CHECK` to any truthy value, e.g. 1, t, on or true.\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.256",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "739e38862b8e50f30aed478371d033ad",
                "sha256": "30beb7cecbe254aab5b049844c5399d11cd028ea3fba8eb56d50b7c1e0a8e175"
            },
            "downloads": -1,
            "filename": "pyright-1.1.256-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "739e38862b8e50f30aed478371d033ad",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 16107,
            "upload_time": "2022-06-28T08:22:45",
            "upload_time_iso_8601": "2022-06-28T08:22:45.501500Z",
            "url": "https://files.pythonhosted.org/packages/83/ca/439a09f43e442da47ce03e768673ddaaa89b5da53c480d6378c8eda2f92c/pyright-1.1.256-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "0af000d8ab56b1b057165ce1ad9d9c60",
                "sha256": "cc0358cfb500770d2bbe4dfdb9257c45c7490a87eef0ffb8f314e84f92af28e6"
            },
            "downloads": -1,
            "filename": "pyright-1.1.256.tar.gz",
            "has_sig": false,
            "md5_digest": "0af000d8ab56b1b057165ce1ad9d9c60",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 15672,
            "upload_time": "2022-06-28T08:22:46",
            "upload_time_iso_8601": "2022-06-28T08:22:46.971159Z",
            "url": "https://files.pythonhosted.org/packages/c0/b3/c61554be270553570669eb3156fe35edcb6aa6c70da93df63fafe4e1858e/pyright-1.1.256.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-06-28 08:22:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "RobertCraigie",
    "github_project": "pyright-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "pyright"
}
        
Elapsed time: 0.43098s