Skip to main content

An autocompletion tool for Python that can be used for text editors.

Project description

Travis-CI build status Coverage Status Number of PyPI downloads Latest PyPI version

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:

And it powers the following projects:

  • wdb - Web Debugger

Here are some pictures:

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

Docs are available at https://jedi.jedidjah.ch/. 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 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 or 3.3, 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.

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

Changelog

0.8.1 (2014-07-15)

  • Bugfix release, the last release forgot to include files that improve
    autocompletion for builtin libraries. Fixed.

0.8.0 (2014-05-05)

  • Memory Consumption for compiled modules (e.g. builtins, sys) has been reduced drastically. Loading times are down as well (it takes basically as long as an import).
  • REPL completion is starting to become usable.
  • Various small API changes. Generally this released focuses on stability and refactoring of internal APIs.
  • Introducing operator precedence, which makes calculating correct Array indices and __getattr__ strings possible.

0.7.0 (2013-08-09)

  • Switched from LGPL to MIT license
  • Added an Interpreter class to the API to make autocompletion in REPL possible.
  • Added autocompletion support for namespace packages
  • Add sith.py, a new random testing method

0.6.0 (2013-05-14)

  • Much faster parser with builtin part caching
  • A test suite, thanks @tkf

0.5 versions (2012)

  • Initial development

Project details


Release history Release notifications

History Node

0.12.0

History Node

0.11.1

History Node

0.11.0

History Node

0.10.2

History Node

0.10.1

History Node

0.10.0

History Node

0.9.0

History Node

0.8.1

History Node

0.7.0

History Node

0.6.0

History Node

0.5b5

History Node

0.5b4

History Node

0.5b3

This version
History Node

0.8.1-final0

History Node

0.8.0-final0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
jedi-0.8.1-final0.tar.gz (298.1 kB) Copy SHA256 hash SHA256 Source None Jul 22, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page