Skip to main content

Yet another Jedi Python language server

Project description

anakin-language-server

Yet another Jedi Python language server

Requirements

  • Python >= 3.6
  • pygls ~= 0.9
  • Jedi >= 0.17.1
  • pyflakes ~= 2.2
  • pycodestyle ~= 2.5
  • yapf ~=0.30

Optional requirements

  • mypy

Implemented features

  • textDocument/completion
  • textDocument/hover
  • textDocument/signatureHelp
  • textDocument/definition
  • textDocument/references
  • textDocument/publishDiagnostics
  • textDocument/documentSymbol
  • textDocument/codeAction (Inline variable)
  • textDocument/formatting
  • textDocument/rangeFormatting
  • textDocument/rename
  • textDocument/documentHighlight

Initialization option

Also one can set VIRTUAL_ENV or CONDA_PREFIX before running anakinls so Jedi will find proper environment. See get_default_environment.

Diagnostics

Diagnostics are published on document open and save.

Diagnostics providers:

  • Jedi

    See get_syntax_errors.

  • pyflakes

  • pycodestyle

    Server restart is needed after changing one of the configuration files.

  • mypy

    Install mypy in the same environment as anakinls and set mypy_enabled configuration option.

Configuration options

Configuration options must be passed under anakinls key in workspace/didChangeConfiguration notification.

Available options:

  • pyflakes_errors - Diagnostic severity will be set to Error if Pyflakes message class name is in this list. See Pyflakes messages.

    Default: ['UndefinedName'].

  • help_on_hover - Use help instead of infer for textDocument/hover.

    Default: True.

  • mypy_enabled - Use mypy to provide diagnostics.

    Default: False.

  • pycodestyle_config - In addition to project and user level config, specify pycodestyle config file. Same as --config option for pycodestyle.

    Default: None.

  • completion_snippet_first - Tweak sortText property so snippet completion appear before plain completion.

    Default: False.

  • yapf_style_config - Either a style name or a path to a file that contains formatting style settings.

    Default: 'pep8'

Configuration example

Here is eglot configuration:

(defvar my/lsp-venv nil
  "Name of virtualenv.
Set it in project's dir-locals file.")

(defclass my/eglot-anakinls (eglot-lsp-server) ()
  :documentation
  "Own eglot server class.")

(cl-defmethod eglot-initialization-options ((_server my/eglot-anakinls))
  "Pass initialization param to anakinls."
  `(:venv ,(when my/lsp-venv
             (expand-file-name
              (concat "~/.virtualenvs/" my/lsp-venv)))))

;; Add this server to eglot programs to handle python-mode and run `anakinls'
(add-to-list 'eglot-server-programs
             '(python-mode my/eglot-anakinls "anakinls"))

;; Also treat UnusedVariable as error
(setq-default eglot-workspace-configuration
              '((:anakinls :pyflakes_errors ["UndefinedName" "UnusedVariable"])))

Installation

pip install anakin-language-server

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for anakin-language-server, version 1.8.1
Filename, size File type Python version Upload date Hashes
Filename, size anakin_language_server-1.8.1-py3-none-any.whl (24.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size anakin-language-server-1.8.1.tar.gz (10.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page