pyright-action

GitHub action for pyright. Featuring:

• PR/commit annotations for errors/warnings.
• Super fast startup, via:
  • Download caching.
  • No dependency on setup-node.

- uses: jakebailey/pyright-action@v2with:
version: 1.1.311 # Optional (change me!)

Options

inputs:
# Options for pyright-actionversion:
description: 'Version of pyright to run, or "PATH" to use pyright from $PATH. If neither version nor pylance-version are specified, the latest version will be used.'required: falsepylance-version:
description: 'Version of pylance whose pyright version should be run. Can be latest-release, latest-prerelease, or a specific pylance version. Ignored if version option is specified.'required: falseworking-directory:
description: 'Directory to run pyright in. If not specified, the repo root will be used.'required: falseannotate:
description: 'A comma separated list of check annotations to emit. May be "none"/"false", "errors", "warnings", or "all"/"true" (shorthand for "errors, warnings").'required: falsedefault: 'all'# Shorthand for pyright flagscreate-stub:
description: 'Create type stub file(s) for import. Note: using this option disables commenting.'required: falsedependencies:
description: 'Emit import dependency information. Note: using this option disables commenting.'required: falseignore-external:
description: 'Ignore external imports for verify-types.'required: falselevel:
description: 'Minimum diagnostic level (error or warning)'required: falseproject:
description: 'Use the configuration file at this location.'required: falsepython-platform:
description: 'Analyze for a specific platform (Darwin, Linux, Windows).'required: falsepython-path:
description: 'Path to the Python interpreter.'required: falsepython-version:
description: 'Analyze for a specific version (3.3, 3.4, etc.).'required: falseskip-unannotated:
description: 'Skip analysis of functions with no type annotations.'required: falsestats:
description: 'Print detailed performance stats. Note: using this option disables commenting.'required: falsetypeshed-path:
description: 'Use typeshed type stubs at this location.'required: falsevenv-path:
description: 'Directory that contains virtual environments.'required: falseverbose:
description: 'Emit verbose diagnostics. Note: using this option disables commenting.'required: falseverify-types:
description: 'Package name to run the type verifier on; must be an *installed* library. Any score under 100% will fail the build. Using this option disables commenting.'required: falsewarnings:
description: 'Use exit code of 1 if warnings are reported.'required: falsedefault: 'false'# Extra arguments (if what you want isn't listed above)extra-args:
description: 'Extra arguments; can be used to specify specific files to check.'required: false# Removed in pyright 1.1.303lib:
description: 'Use library code to infer types when stubs are missing.'required: falsedefault: 'false'# Deprecatedno-comments:
description: 'Disable issue/commit comments.'required: falsedefault: 'false'deprecationMessage: 'Use "annotate" instead.'

Use with a virtualenv

The easiest way to use a virtualenv with this action is to "activate" the environment by adding its bin to $PATH, then allowing pyright to find it there.

- uses: actions/checkout@v3
- uses: actions/setup-python@v4with:
cache: 'pip'
- run: | python -m venv .venv source .venv/bin/activate pip install -r requirements.txt- run: echo "$PWD/.venv/bin" >> $GITHUB_PATH
- uses: jakebailey/pyright-action@v2

Use with poetry

Similarly to a virtualenv, the easiest way to get it working is to ensure that poetry's python binary is on $PATH:

- uses: actions/checkout@v3
- run: pipx install poetry
- uses: actions/setup-python@v4with:
cache: 'poetry'
- run: poetry install
- run: echo "$(poetry env info --path)/bin" >> $GITHUB_PATH
- uses: jakebailey/pyright-action@v2

Providing a pyright version sourced from preexisting dependencies

The version input only accepts "latest" or a specific version number. However, there are many ways to use specify a version of pyright derived from other tools.

Using pyright from $PATH

If you have pyright installed in your environment, e.g. via the pyright PyPI package, specify version: PATH to use the version that's on $PATH.

- run: | python -m venv .venv source .venv/bin/activate pip install -r dev-requirements.txt # includes pyright- run: echo "$PWD/.venv/bin" >> $GITHUB_PATH
- uses: jakebailey/pyright-action@v2with:
version: PATH

Keeping Pyright and Pylance in sync

If you use Pylance as your language server, you'll likely want pyright-action to use the same version of pyright that Pylance does. The pylance-version option makes this easy.

If you allow VS Code to auto-update Pylance, then set pylance-version to latest-release if you use Pylance's Release builds, or latest-prerelease if you use Pylance's Pre-Release builds. Alternatively, you can set it to a particular Pylance version number (ex. 2023.11.11).

Note that the version option takes precedence over pylance-version, so you'll want to set one or the other, not both.

- uses: jakebailey/pyright-action@v2with:
pylance-version: latest-release