coc-pyright

Pyright extension for coc.nvim

Install

:CocInstall coc-pyright

Note: Pyright may not work as expected if can't detect project root correctly, check #521 and Using workspaceFolders in coc.nvim.

Commands

• python.runLinting: Run linting
• python.sortImports: Sort imports by isort
• pyright.version: Show the currently used Pyright version in :messages
• pyright.organizeimports: Organize imports by Pyright
• pyright.restartserver: This command forces the type checker to discard all of its cached type information and restart analysis. It is useful in cases where new type stubs or libraries have been installed.
• pyright.createtypestub: Creates Type Stubs with given module name, for example :CocCommand pyright.createtypestub numpy

Configurations

These configurations are used by coc-pyright, you need to set them in your coc-settings.json.

pyrightconfig.json

Pyright supports pyrightconfig.json that provide granular control over settings.

Python typing and stub files

To provide best experience, Pyright requires packages to be type annotated and/or have stub files. The Python community is currently in a transition phase where package authors are actively looking to provide that. Meanwhile, stub files for well-known packages may also be obtained from 3rd party, for example:

• Awesome Python Typing # stub-packages
• typeshed
• python-type-stubs

Conda setup

1. Create the following file:

#!/bin/bash
python "$@"

2. Make it executable: chmod +x $path
3. Add the following to your coc-settings.json:

"python.pythonPath": "<PUT PATH HERE>"

4. Activate the environment before starting vim

This way python from your currently activated environment will be used

My Workflow with Pyright

1. create venv in project: python3 -m venv .venv
2. source .venv/bin/activate
3. install modules with pip and work with Pyright
4. deactivate

License

MIT

This extension is created by create-coc-extension