Jedi - an awesome autocompletion library for Python
Jedi is an autocompletion tool for Python that can be used in IDEs/editors. Jedi works. Jedi is fast. It understands all of the basic Python syntax elements including many builtin functions.
Additionaly, Jedi suports two different goto functions and has support for renaming as well as Pydoc support and some other IDE features.
Jedi uses a very simple API to connect with IDE's. There's a reference implementation as a VIM-Plugin, which uses Jedi's autocompletion. I encourage you to use Jedi in your IDEs. It's really easy. If there are any problems (also with licensing), just contact me.
Jedi can be used with the following editors:
- Vim (jedi-vim, YouCompleteMe)
- Emacs (Jedi.el, elpy, anaconda-mode, ycmd)
- Sublime Text (SublimeJEDI [ST2 + ST3], anaconda [only ST3])
- TextMate (Not sure if it's actually working)
- Kate version 4.13+ supports it natively, you have to enable it, though. [proof]
And it powers the following projects:
- wdb - Web Debugger
Here are some pictures:
Completion for almost anything (Ctrl+Space).
Display of function/class bodies, docstrings.
Pydoc support (with highlighting, Shift+k).
There is also support for goto and renaming.
Get the latest version from github (master branch should always be kind of stable/working).
pip install jedi
Note: This just installs the Jedi library, not the editor plugins. For information about how to make it work with your editor, refer to the corresponding documentation.
You don't want to use pip? Please refer to the manual.
Feature Support and Caveats
Jedi really understands your Python code. For a comprehensive list what Jedi can do, see: Features. A list of caveats can be found on the same page.
You can run Jedi on cPython 2.6, 2.7, 3.2, 3.3 or 3.4, but it should also understand/parse code older than those versions.
Tips on how to use Jedi efficiently can be found here.
API for IDEs
It's very easy to create an editor plugin that uses Jedi. See Plugin API for more information.
If you have specific questions, please add an issue or ask on stackoverflow with the label python-jedi.
There's a pretty good and extensive development documentation.
The test suite depends on tox and pytest:
pip install tox pytest
To run the tests for all supported Python versions:
If you want to test only a specific Python version (e.g. Python 2.7), it's as easy as
tox -e py27
Tests are also run automatically on Travis CI.
For more detailed information visit the testing documentation