README.rst

jedi-vim - awesome Python autocompletion with VIM

jedi-vim is a is a VIM binding to the autocompletion library Jedi.

Here are some pictures:

Completion for almost anything (Ctrl+Space).

Display of function/class bodies, docstrings.

Documentation (Pydoc) support (with highlighting, Shift+k).

There is also support for goto and renaming.

Get the latest from github.

Documentation

Documentation is available in your vim: :help jedi-vim. You can also look it up on github.

You can read the Jedi library documentation here.

Contributing

We love Pull Requests! Read the instructions in CONTRIBUTING.md.

Features

The Jedi library understands most of Python's core features. From decorators to generators, there is broad support.

Apart from that, jedi-vim supports the following commands

• Completion <C-Space>
• Goto assignments <leader>g (typical goto function)

• Goto definitions <leader>d (follow identifier as far as possible, includes

  imports and statements)

• Show Documentation/Pydoc K (shows a popup with assignments)
• Renaming <leader>r
• Usages <leader>n (shows all the usages of a name)
• Open module, e.g. :Pyimport os (opens the os module)

Installation

You might want to use pathogen to install jedi in VIM. Also you need a VIM version that was compiled with +python, which is typical for most distributions on Linux.

The first thing you need after that is an up-to-date version of Jedi. You can either get it via pip install jedi or with git submodule update --init in your jedi-vim repository.

The autocompletion can be used with <ctrl+space>, if you want it to work with <tab> you can use supertab.

On Arch Linux, you can also install jedi-vim from AUR: vim-jedi.

Settings

Jedi is by default automatically initialized. If you don't want that I suggest you disable the auto-initialization in your .vimrc:

let g:jedi#auto_initialization = 0

There are also some VIM options (like completeopt and key defaults) which are automatically initialized, but you can change all of them:

let g:jedi#auto_vim_configuration = 0

If you are a person who likes to use VIM-buffers not tabs, you might want to put that in your .vimrc: .. code-block:: vim

let g:jedi#use_tabs_not_buffers = 0

Jedi automatically starts the completion, if you type a dot, e.g. str., if you don't want this:

let g:jedi#popup_on_dot = 0

Jedi selects the first line of the completion menu: for a better typing-flow and usually saves one keypress.

let g:jedi#popup_select_first = 0

Here are a few more defaults for actions, read the docs (:help jedi-vim) to get more information. You can change them

let g:jedi#goto_assignments_command = "<leader>g"
let g:jedi#goto_definitions_command = "<leader>d"
let g:jedi#documentation_command = "K"
let g:jedi#usages_command = "<leader>n"
let g:jedi#completions_command = "<C-Space>"
let g:jedi#rename_command = "<leader>r"
let g:jedi#show_call_signatures = "1"

Testing

jedi-vim is being tested with a combination of vspec and py.test.

The tests are in the test subdirectory, you can run them calling:

py.test

The tests are automatically run with travis.