Jedi - an awesome autocompletion/static analysis library for Python

If you have specific questions, please add an issue or ask on Stack Overflow with the label python-jedi.

Jedi is a static analysis tool for Python that can be used in IDEs/editors. Jedi has a focus on autocompletion and goto functionality. Jedi is fast and is very well tested. It understands Python and stubs on a deep level.

Jedi has support for different goto functions. It's possible to search for usages and list names in a Python file to get information about them.

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. We encourage you to use Jedi in your IDEs. Autocompletion in your REPL is also possible, IPython uses it natively and for the CPython REPL you have to install it.

Jedi can currently be used with the following editors/projects:

Vim (jedi-vim, YouCompleteMe, deoplete-jedi, completor.vim)
Emacs (Jedi.el, company-mode, 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]
Atom (autocomplete-python-jedi)
GNOME Builder (with support for GObject Introspection)
Visual Studio Code (via Python Extension)
Gedit (gedi)
wdb - Web Debugger
Eric IDE (Available as a plugin)
IPython 6.0.0+

and many more!

Here are some pictures taken from jedi-vim:

https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_complete.png

Completion for almost anything (Ctrl+Space).

https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_function.png

Display of function/class bodies, docstrings.

https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_pydoc.png

Pydoc support (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).

Docs are available at https://jedi.readthedocs.org/en/latest/. Pull requests with documentation enhancements and/or fixes are awesome and most welcome. Jedi uses semantic versioning.

If you want to stay up-to-date (News / RFCs), please subscribe to this github thread.:

Installation

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 understands, see: Features. A list of caveats can be found on the same page.

You can run Jedi on CPython 2.7 or 3.4+ but it should also understand/parse code older than those versions. Additionally you should be able to use Virtualenvs very well.

Tips on how to use Jedi efficiently can be found here.

API

You can find the documentation for the API here.

Autocompletion / Goto / Pydoc

Please check the API for a good explanation. There are the following commands:

jedi.Script.goto_assignments
jedi.Script.completions
jedi.Script.usages

The returned objects are very powerful and really all you might need.

Autocompletion in your REPL (IPython, etc.)

Starting with IPython 6.0.0 Jedi is a dependency of IPython. Autocompletion in IPython is therefore possible without additional configuration.

It's possible to have Jedi autocompletion in REPL modes - example video. This means that in Python you can enable tab completion in a REPL.

Static Analysis

To do all forms of static analysis, please try to use jedi.names. It will return a list of names that you can use to infer types and so on.

Refactoring

Jedi's parser would support refactoring, but there's no API to use it right now. If you're interested in helping out here, let me know. With the latest parser changes, it should be very easy to actually make it work.

Development

There's a pretty good and extensive development documentation.

Testing

The test suite depends on tox and pytest:

pip install tox pytest

To run the tests for all supported Python versions:

tox

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.

Acknowledgements

Takafumi Arakaki (@tkf) for creating a solid test environment and a lot of other things.
Danilo Bargen (@dbrgn) for general housekeeping and being a good friend :).
Guido van Rossum (@gvanrossum) for creating the parser generator pgen2 (originally used in lib2to3).

StillTipsy/jedi