A Language Server for the latest version(s) of Jedi. If using Neovim/Vim, we recommend using with coc-jedi.
Note: this tool is actively used by its primary author. He's happy to review pull requests / respond to issues you may discover.
From your command line (bash / zsh), run:
pip install -U jedi-language-server
-U
ensures that you're pulling the latest version from pypi.
Alternatively, consider using pipx to keep jedi-language-server isolated from your other Python dependencies. Don't worry, jedi is smart enough to figure out which Virtual environment you're currently using!
jedi-language-server aims to support all of Jedi's capabilities and expose them through the Language Server Protocol. It currently supports the following Language Server capabilities:
- completionItem/resolve
- textDocument/codeAction (refactor.inline, refactor.extract)
- textDocument/completion
- textDocument/definition
- textDocument/documentHighlight
- textDocument/documentSymbol
- textDocument/hover
- textDocument/publishDiagnostics
- textDocument/references
- textDocument/rename
- textDocument/signatureHelp
- workspace/symbol
The following instructions show how to use jedi-language-server with your development tooling. The instructions assume you have already installed jedi-language-server.
Users may choose 1 of the following options:
- coc.nvim with coc-jedi.
- ALE.
- Neovim's native LSP client. See here for an example configuration.
- vim-lsp.
Note: this list is non-exhaustive. If you know of a great choice not included in this list, please submit a PR!
Users may choose 1 of the following options:
Note: this list is non-exhaustive. If you know of a great choice not included in this list, please submit a PR!
At your terminal prompt:
jedi-language-server
jedi-language-server currently works only over IO. This may change in the future.
We recommend using coc-jedi and following its configuration instructions.
If you are configuring manually, jedi-language-server supports the following initializationOptions:
...
"initializationOptions": {
"markupKindPreferred": null,
"jediSettings": {
"autoImportModules": []
},
"completion": {
"disableSnippets": false,
"resolveEagerly": false
},
"diagnostics": {
"enable": true,
"didOpen": true,
"didChange": true,
"didSave": true
},
"workspace": {
"extraPaths": []
}
}
...
See coc-jedi's configuration instructions for an explanation of the above configurations.
jedi-langugage-server provides diagnostics about syntax errors, powered by Jedi. If you would like additional diagnostics, we suggest using the powerful diagnostic-language-server.
Again, we recommend that you use diagnostic-language-server. It also supports code formatting.
To build and run this project from source:
Install the following tools manually:
Fork this repository and clone the fork to your development machine:
git clone https://github.com/<YOUR-USERNAME>/jedi-language-server
cd jedi-language-server
make setup
make test
Palantir's python-language-server inspired this project. Unlike python-language-server, jedi-language-server:
- Uses pygls instead of creating its own low-level Language Server Protocol bindings
- Supports one powerful 3rd party library: Jedi. By only supporting Jedi, we can focus on supporting all Jedi features without exposing ourselves to too many broken 3rd party dependencies (I'm looking at you, rope).
- Is supremely simple because of its scope constraints. Leave complexity to the Jedi master. If the force is strong with you, please submit a PR!
Samuel Roeca samuel.roeca@gmail.com