Awesome autocompletion, static analysis and refactoring library for python
Jedi - an awesome autocompletion, static analysis and refactoring library for Python
.. image:: http://isitmaintained.com/badge/open/davidhalter/jedi.svg :target: https://github.com/davidhalter/jedi/issues :alt: The percentage of open issues and pull requests
.. image:: http://isitmaintained.com/badge/resolution/davidhalter/jedi.svg :target: https://github.com/davidhalter/jedi/issues :alt: The resolution time is the median time an issue or pull request stays open.
.. image:: https://github.com/davidhalter/jedi/workflows/ci/badge.svg?branch=master :target: https://github.com/davidhalter/jedi/actions :alt: Tests
.. image:: https://pepy.tech/badge/jedi :target: https://pepy.tech/project/jedi :alt: PyPI Downloads
Jedi is a static analysis tool for Python that is typically used in IDEs/editors plugins. Jedi has a focus on autocompletion and goto functionality. Other features include refactoring, code search and finding references.
Jedi has a simple API to work with. There is a reference implementation as a
VIM-Plugin_. Autocompletion in your REPL is also possible, IPython uses it natively and for the CPython REPL you can install it. Jedi is well tested and bugs should be rare.
Jedi can currently be used with the following editors/projects:
Visual Studio Code_ (via
GNOME Builder_ (with support for GObject Introspection)
Eric IDE_ (Available as a plugin)
xonsh shell_ has
and many more!
There are a few language servers that use Jedi:
Here are some pictures taken from jedi-vim_:
.. image:: https://github.com/davidhalter/jedi/raw/master/docs/screenshots/screenshotcomplete.png
Completion for almost anything:
.. image:: https://github.com/davidhalter/jedi/raw/master/docs/screenshots/screenshotfunction.png
.. image:: https://github.com/davidhalter/jedi/raw/master/docs/screenshots/screenshotpydoc.png
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 enhancements and/or fixes are awesome and most welcome. Jedi uses
If you want to stay up-to-date with releases, please subscribe to this mailing list: https://groups.google.com/g/jedi-announce. To subscribe you can simply send an empty email to
You can file issues and questions in the
issue tracker. Alternatively you can also ask on
Stack Overflow_ with the label
Check out the docs_.
Jedi's features are listed here:
You can run Jedi on Python 3.6+ but it should also understand code that is older than those versions. Additionally you should be able to use
Virtualenvs_ very well.
Tips on how to use Jedi efficiently can be found
You can find a comprehensive documentation for the
There are the following commands:
The returned objects are very powerful and are really all you might need.
Jedi is a dependency of IPython. Autocompletion in IPython with Jedi is therefore possible without additional configuration.
Here is an
example video_ how REPL completion can look like. For the
pythonshell you can enable tab completion in a
For a lot of forms of static analysis, you can try to use
jedi.Script(...).get_names. It will return a list of names that you can then filter and work with. There is also a way to list the syntax errors in a file:
Jedi supports the following refactorings:
There is support for module search with
jedi.Script.search, and project search for
jedi.Project.search. The way to search is either by providing a name like
fooor by using dotted syntax like
foo.bar. Additionally you can provide the API type like
class foo.bar.Bar. There are also the functions
There's a pretty good and extensive
The test suite uses
pip install pytest
If you want to test only a specific Python version (e.g. Python 3.8), it is as easy as::
python3.8 -m pytest
For more detailed information visit the
Thanks a lot to all the
.. _jedi-vim: https://github.com/davidhalter/jedi-vim .. _youcompleteme: https://github.com/ycm-core/YouCompleteMe .. _deoplete-jedi: https://github.com/zchee/deoplete-jedi .. _completor.vim: https://github.com/maralla/completor.vim .. _Jedi.el: https://github.com/tkf/emacs-jedi .. _company-mode: https://github.com/syohex/emacs-company-jedi .. _elpy: https://github.com/jorgenschaefer/elpy .. _anaconda-mode: https://github.com/proofit404/anaconda-mode .. _ycmd: https://github.com/abingham/emacs-ycmd .. _sublimejedi: https://github.com/srusskih/SublimeJEDI .. _anaconda: https://github.com/DamnWidget/anaconda .. _wdb: https://github.com/Kozea/wdb .. _TextMate: https://github.com/lawrenceakka/python-jedi.tmbundle .. _Kate: https://kate-editor.org .. _Atom: https://atom.io/ .. _autocomplete-python-jedi: https://atom.io/packages/autocomplete-python-jedi .. _GNOME Builder: https://wiki.gnome.org/Apps/Builder .. _Visual Studio Code: https://code.visualstudio.com/ .. _gedi: https://github.com/isamert/gedi .. _Eric IDE: https://eric-ide.python-projects.org