Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Awesome autocompletion and static analysis library for python.
Python
branch: master

Merge pull request #586 from squidarth/580_semantic_keyword_completion

Added support for correct continue & break autocompletion.
latest commit 7651157487
@davidhalter authored

README.rst

Jedi - an awesome autocompletion/static analysis library for Python

Travis-CI build status Coverage Status

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

Jedi is a static analysis tool for Python that can be used in IDEs/editors. Its historic focus is autocompletion, but does static analysis for now as well. Jedi is fast and is very well tested. It understands Python on a deeper level than all other static analysis frameworks for Python.

Jedi has support for two different goto functions. It's possible to search for related names and to list all names in a Python file and infer them. Jedi understands docstrings and you can use Jedi autocompletion in your REPL as well.

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. It's really easy.

Jedi can currently be used with the following editors:

And it powers the following projects:

  • wdb - Web Debugger

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.

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.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

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.)

It's possible to have Jedi autocompletion in REPL modes - example video. This means that IPython and others are supported.

Static Analysis / Linter

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.

Linting is another thing that is going to be part of Jedi. For now you can try an alpha version python -m jedi linter. The API might change though and it's still buggy. It's Jedi's goal to be smarter than classic linter and understand AttributeError and other code issues.

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

Something went wrong with that request. Please try again.