jedi-vim - awesome Python autocompletion with VIM
jedi-vim 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 is available in your vim:
:help jedi-vim. You can also look
it up on github.
You can read the Jedi library documentation here.
If you want to report issues, just use the github issue tracker. In case of
questions about the software, please use stackoverflow and tag your question with
We love Pull Requests! Read the instructions in
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
- 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)
<leader>n(shows all the usages of a name)
- Open module, e.g.
:Pyimport os(opens the
You might want to use pathogen or
vundle 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 Python version compiled into VIM must be 2.6 or later
(you can check this from within VIM using
:python import sys; print sys.version )
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.
Example Installation Command using Pathogen:
cd ~/.vim/bundle/ && git clone --recursive https://github.com/davidhalter/jedi-vim.git
Note that the python-mode VIM plugin seems to conflict with jedi-vim, therefore you should disable it before enabling jedi-vim.
To enjoy the full features of jedi-vim, you should have VIM >= 7.3, compiled with
+conceal (which is not the case on some platforms, including OS X). If your VIM
does not meet these requirements, the parameter recommendation list may not appear
when you type an open bracket after a function name. Please read
Jedi is by default automatically initialized. If you don't want that I suggest
you disable the auto-initialization in your
let g:jedi#auto_initialization = 0
There are also some VIM options (like
completeopt and key defaults) which
are automatically initialized, but you can skip this:
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
let g:jedi#use_tabs_not_buffers = 0
If you are a person who likes to use VIM-splits, you might want to put this in your
let g:jedi#use_splits_not_buffers = "left"
This options could be "left", "right", "top", "bottom" or "winwidth". It will decide the direction where the split open.
Jedi automatically starts the completion, if you type a dot, e.g.
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
Jedi displays function call signatures in insert mode in real-time, highlighting the current argument. The call signatures can be displayed as a pop-up in the buffer (set to 1, the default), which has the advantage of being easier to refer to, or in Vim's command line aligned with the function call (set to 2), which can improve the integrity of Vim's undo history.
let g:jedi#show_call_signatures = "1"
Here are a few more defaults for actions, read the docs (
:help jedi-vim) to
get more information. If you set them to
"", they are not assigned.
NOTE: subject to change! let g:jedi#goto_command = "<leader>d" let g:jedi#goto_assignments_command = "<leader>g" let g:jedi#goto_definitions_command = "" 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"
Finally, if you don't want completion, but all the other features, use:
let g:jedi#completions_enabled = 0
I don't want the docstring window to popup during completion
This depends on the
completeopt option. Jedi initializes it in its
ftplugin. Add the following line to your
.vimrc to disable it:
autocmd FileType python setlocal completeopt-=preview
I want <Tab> to do autocompletion
Don't even think about changing the Jedi command to
The completion is waaay too slow!
Completion of complex libraries (like Numpy) should only be slow the first time you complete it. After that, the results should be cached and very fast.
If it's still slow, in case you've installed the python-mode VIM plugin, disable it. It seems to conflict with jedi-vim. See issue #163.
The tests are in the
test subdirectory, you can run them calling:
The tests are automatically run with travis.