jedi-language-server 0.4.1

A language server for Jedi!

jedi-language-server

A Language Server for the latest version(s) Jedi.

Note: this tool is actively used by its primary author. He's happy to review pull requests / respond to issues you may discover.

Installation

From your command line (bash / zsh), run:

pip install -U jedi jedi-language-server

-U ensures that you're pulling the latest version from pypi.

Overview

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 requests:

• textDocument/completion
• textDocument/definition
• textDocument/documentSymbol
• textDocument/hover
• textDocument/references
• textDocument/rename
• workspace/symbol

These language server requests are not currently configurable by the user, but we expect to relax this constraint in a future release.

Usage

The following instructions show how to use jedi-language-server with your development tooling. The instructions assume you have already installed jedi-language-server.

Command line (bash / zsh)

At your terminal prompt:

jedi-language-server

jedi-language-server currently works only over IO. This may change in the future.

Neovim

Configure jedi-language-server with coc.nvim. For diagnostics, we recommend installing and using the latest version of efm-langserver + pylint.

~/.config/nvim/coc-settings.json:

"languageserver": {
  "efm": {
    "command": "efm-langserver",
    "args": [],
    "filetypes": ["python"]
  },
  "jls": {
    "command": "jedi-language-server",
    "args": [],
    "filetypes": ["python"]
  }
}

~/.config/efm-langserver/config.yaml:

version: 2
tools:
  python-pylint: &python-pylint
    lint-command: 'pylint'
    lint-formats:
      - '%f:%l:%c: %t%m'
languages:
  python:
    - <<: *python-pylint

Local Development

Like everything else in this project, local development is quite simple.

Dependencies

Install the following tools manually.

• Poetry
• GNU Make

Recommended

• asdf

Set up development environment

make setup

Run tests

make test

Inspiration

Palantir's python-language-server inspired this project. jedi-language-server differs from 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. Given its scope constraints, it will continue to be super simple and leave complexity to the Jedi master. Feel free to submit a PR!

Written by

Samuel Roeca [e-mail]