Awesome autocompletion and static analysis library for python.
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Drop support for EOL Python 3.3 (#1019) Aug 3, 2018
jedi Improve docstring formatting Nov 25, 2018
scripts Upgrade the wx widgets paths Mar 18, 2018
test Improve docstring formatting Nov 25, 2018
.coveragerc A path to ignore in coveragerc was wrong Jan 6, 2018
.gitignore Add pytest cache to gitignore Mar 4, 2018
.travis.yml Drop support for EOL Python 3.3 (#1019) Aug 3, 2018
AUTHORS.txt Include function return type annotation in docstring if it is present Apr 23, 2018
CHANGELOG.rst Create a new 0.13.1 release Oct 2, 2018
CONTRIBUTING.md Mention that it's ok to have a line length of 100 characters in our f… Jul 12, 2018
LICENSE.txt Remove the license parts that are not needed anymore, because they ar… Jun 1, 2017
MANIFEST.in Add a requirements.txt. May 20, 2017
README.rst Drop support for EOL Python 3.3 (#1019) Aug 3, 2018
appveyor.yml Drop support for EOL Python 3.3 (#1019) Aug 3, 2018
conftest.py Now it's actually possible to specify a pytest environment for the sa… Aug 4, 2018
deploy-master.sh The tags should be annotated if possible Dec 30, 2017
pytest.ini Move the buildout_project stuff to a separate examples folder Feb 16, 2018
requirements.txt Prepare release of 0.12.1 Jun 29, 2018
setup.cfg Some minor flake8 fixes Jul 16, 2018
setup.py Add extras_require=testing Sep 22, 2018
sith.py Sith still used NotFoundError which doesn't exist anymore in jedi Jan 6, 2018
tox.ini Add extras_require=testing Sep 22, 2018
travis_install.sh Drop support for EOL Python 3.3 (#1019) Aug 3, 2018

README.rst

Jedi - an awesome autocompletion/static analysis library for Python

PyPI version Supported Python versions Linux Tests Windows Tests Coverage status

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. 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 IDEs. 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/projects:

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

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