METADATA 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  1. Metadata-Version: 2.0
  2. Name: jedi
  3. Version: 0.13.3
  4. Summary: An autocompletion tool for Python that can be used for text editors.
  5. Home-page: https://github.com/davidhalter/jedi
  6. Author: David Halter
  7. Author-email: davidhalter88@gmail.com
  8. Maintainer: David Halter
  9. Maintainer-email: davidhalter88@gmail.com
  10. License: MIT
  11. Keywords: python completion refactoring vim
  12. Platform: any
  13. Classifier: Development Status :: 4 - Beta
  14. Classifier: Environment :: Plugins
  15. Classifier: Intended Audience :: Developers
  16. Classifier: License :: OSI Approved :: MIT License
  17. Classifier: Operating System :: OS Independent
  18. Classifier: Programming Language :: Python :: 2
  19. Classifier: Programming Language :: Python :: 2.7
  20. Classifier: Programming Language :: Python :: 3
  21. Classifier: Programming Language :: Python :: 3.4
  22. Classifier: Programming Language :: Python :: 3.5
  23. Classifier: Programming Language :: Python :: 3.6
  24. Classifier: Programming Language :: Python :: 3.7
  25. Classifier: Topic :: Software Development :: Libraries :: Python Modules
  26. Classifier: Topic :: Text Editors :: Integrated Development Environments (IDE)
  27. Classifier: Topic :: Utilities
  28. Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
  29. Provides-Extra: testing
  30. Requires-Dist: parso (>=0.3.0)
  31. Provides-Extra: testing
  32. Requires-Dist: colorama; extra == 'testing'
  33. Requires-Dist: docopt; extra == 'testing'
  34. Requires-Dist: pytest (>=3.1.0); extra == 'testing'
  35. ###################################################################
  36. Jedi - an awesome autocompletion/static analysis library for Python
  37. ###################################################################
  38. .. image:: https://img.shields.io/pypi/v/jedi.svg?style=flat
  39. :target: https://pypi.python.org/pypi/jedi
  40. :alt: PyPI version
  41. .. image:: https://img.shields.io/pypi/pyversions/jedi.svg
  42. :target: https://pypi.python.org/pypi/jedi
  43. :alt: Supported Python versions
  44. .. image:: https://travis-ci.org/davidhalter/jedi.svg?branch=master
  45. :target: https://travis-ci.org/davidhalter/jedi
  46. :alt: Linux Tests
  47. .. image:: https://ci.appveyor.com/api/projects/status/mgva3bbawyma1new/branch/master?svg=true
  48. :target: https://ci.appveyor.com/project/davidhalter/jedi/branch/master
  49. :alt: Windows Tests
  50. .. image:: https://coveralls.io/repos/davidhalter/jedi/badge.svg?branch=master
  51. :target: https://coveralls.io/r/davidhalter/jedi
  52. :alt: Coverage status
  53. *If you have specific questions, please add an issue or ask on* `Stack Overflow
  54. <https://stackoverflow.com/questions/tagged/python-jedi>`_ *with the label* ``python-jedi``.
  55. Jedi is a static analysis tool for Python that can be used in IDEs/editors. Its
  56. historic focus is autocompletion, but does static analysis for now as well.
  57. Jedi is fast and is very well tested. It understands Python on a deeper level
  58. than all other static analysis frameworks for Python.
  59. Jedi has support for two different goto functions. It's possible to search for
  60. related names and to list all names in a Python file and infer them. Jedi
  61. understands docstrings and you can use Jedi autocompletion in your REPL as
  62. well.
  63. Jedi uses a very simple API to connect with IDEs. There's a reference
  64. implementation as a `VIM-Plugin <https://github.com/davidhalter/jedi-vim>`_,
  65. which uses Jedi's autocompletion. We encourage you to use Jedi in your IDEs.
  66. It's really easy.
  67. Jedi can currently be used with the following editors/projects:
  68. - Vim (jedi-vim_, YouCompleteMe_, deoplete-jedi_, completor.vim_)
  69. - Emacs (Jedi.el_, company-mode_, elpy_, anaconda-mode_, ycmd_)
  70. - Sublime Text (SublimeJEDI_ [ST2 + ST3], anaconda_ [only ST3])
  71. - TextMate_ (Not sure if it's actually working)
  72. - Kate_ version 4.13+ supports it natively, you have to enable it, though. [`proof
  73. <https://projects.kde.org/projects/kde/applications/kate/repository/show?rev=KDE%2F4.13>`_]
  74. - Atom_ (autocomplete-python-jedi_)
  75. - `GNOME Builder`_ (with support for GObject Introspection)
  76. - `Visual Studio Code`_ (via `Python Extension <https://marketplace.visualstudio.com/items?itemName=ms-python.python>`_)
  77. - Gedit (gedi_)
  78. - wdb_ - Web Debugger
  79. - `Eric IDE`_ (Available as a plugin)
  80. - `IPython 6.0.0+ <https://ipython.readthedocs.io/en/stable/whatsnew/version6.html>`_
  81. and many more!
  82. Here are some pictures taken from jedi-vim_:
  83. .. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_complete.png
  84. Completion for almost anything (Ctrl+Space).
  85. .. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_function.png
  86. Display of function/class bodies, docstrings.
  87. .. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_pydoc.png
  88. Pydoc support (Shift+k).
  89. There is also support for goto and renaming.
  90. Get the latest version from `github <https://github.com/davidhalter/jedi>`_
  91. (master branch should always be kind of stable/working).
  92. Docs are available at `https://jedi.readthedocs.org/en/latest/
  93. <https://jedi.readthedocs.org/en/latest/>`_. Pull requests with documentation
  94. enhancements and/or fixes are awesome and most welcome. Jedi uses `semantic
  95. versioning <https://semver.org/>`_.
  96. If you want to stay up-to-date (News / RFCs), please subscribe to this `github
  97. thread <https://github.com/davidhalter/jedi/issues/1063>`_.:
  98. Installation
  99. ============
  100. pip install jedi
  101. Note: This just installs the Jedi library, not the editor plugins. For
  102. information about how to make it work with your editor, refer to the
  103. corresponding documentation.
  104. You don't want to use ``pip``? Please refer to the `manual
  105. <https://jedi.readthedocs.org/en/latest/docs/installation.html>`_.
  106. Feature Support and Caveats
  107. ===========================
  108. Jedi really understands your Python code. For a comprehensive list what Jedi
  109. understands, see: `Features
  110. <https://jedi.readthedocs.org/en/latest/docs/features.html>`_. A list of
  111. caveats can be found on the same page.
  112. You can run Jedi on CPython 2.7 or 3.4+ but it should also
  113. understand/parse code older than those versions. Additionally you should be able
  114. to use `Virtualenvs <https://jedi.readthedocs.org/en/latest/docs/api.html#environments>`_
  115. very well.
  116. Tips on how to use Jedi efficiently can be found `here
  117. <https://jedi.readthedocs.org/en/latest/docs/features.html#recipes>`_.
  118. API
  119. ---
  120. You can find the documentation for the `API here <https://jedi.readthedocs.org/en/latest/docs/api.html>`_.
  121. Autocompletion / Goto / Pydoc
  122. -----------------------------
  123. Please check the API for a good explanation. There are the following commands:
  124. - ``jedi.Script.goto_assignments``
  125. - ``jedi.Script.completions``
  126. - ``jedi.Script.usages``
  127. The returned objects are very powerful and really all you might need.
  128. Autocompletion in your REPL (IPython, etc.)
  129. -------------------------------------------
  130. Starting with IPython `6.0.0` Jedi is a dependency of IPython. Autocompletion
  131. in IPython is therefore possible without additional configuration.
  132. It's possible to have Jedi autocompletion in REPL modes - `example video <https://vimeo.com/122332037>`_.
  133. This means that in Python you can enable tab completion in a `REPL
  134. <https://jedi.readthedocs.org/en/latest/docs/usage.html#tab-completion-in-the-python-shell>`_.
  135. Static Analysis / Linter
  136. ------------------------
  137. To do all forms of static analysis, please try to use ``jedi.names``. It will
  138. return a list of names that you can use to infer types and so on.
  139. Linting is another thing that is going to be part of Jedi. For now you can try
  140. an alpha version ``python -m jedi linter``. The API might change though and
  141. it's still buggy. It's Jedi's goal to be smarter than classic linter and
  142. understand ``AttributeError`` and other code issues.
  143. Refactoring
  144. -----------
  145. Jedi's parser would support refactoring, but there's no API to use it right
  146. now. If you're interested in helping out here, let me know. With the latest
  147. parser changes, it should be very easy to actually make it work.
  148. Development
  149. ===========
  150. There's a pretty good and extensive `development documentation
  151. <https://jedi.readthedocs.org/en/latest/docs/development.html>`_.
  152. Testing
  153. =======
  154. The test suite depends on ``tox`` and ``pytest``::
  155. pip install tox pytest
  156. To run the tests for all supported Python versions::
  157. tox
  158. If you want to test only a specific Python version (e.g. Python 2.7), it's as
  159. easy as ::
  160. tox -e py27
  161. Tests are also run automatically on `Travis CI
  162. <https://travis-ci.org/davidhalter/jedi/>`_.
  163. For more detailed information visit the `testing documentation
  164. <https://jedi.readthedocs.org/en/latest/docs/testing.html>`_.
  165. Acknowledgements
  166. ================
  167. - Takafumi Arakaki (@tkf) for creating a solid test environment and a lot of
  168. other things.
  169. - Danilo Bargen (@dbrgn) for general housekeeping and being a good friend :).
  170. - Guido van Rossum (@gvanrossum) for creating the parser generator pgen2
  171. (originally used in lib2to3).
  172. .. _jedi-vim: https://github.com/davidhalter/jedi-vim
  173. .. _youcompleteme: https://valloric.github.io/YouCompleteMe/
  174. .. _deoplete-jedi: https://github.com/zchee/deoplete-jedi
  175. .. _completor.vim: https://github.com/maralla/completor.vim
  176. .. _Jedi.el: https://github.com/tkf/emacs-jedi
  177. .. _company-mode: https://github.com/syohex/emacs-company-jedi
  178. .. _elpy: https://github.com/jorgenschaefer/elpy
  179. .. _anaconda-mode: https://github.com/proofit404/anaconda-mode
  180. .. _ycmd: https://github.com/abingham/emacs-ycmd
  181. .. _sublimejedi: https://github.com/srusskih/SublimeJEDI
  182. .. _anaconda: https://github.com/DamnWidget/anaconda
  183. .. _wdb: https://github.com/Kozea/wdb
  184. .. _TextMate: https://github.com/lawrenceakka/python-jedi.tmbundle
  185. .. _Kate: https://kate-editor.org
  186. .. _Atom: https://atom.io/
  187. .. _autocomplete-python-jedi: https://atom.io/packages/autocomplete-python-jedi
  188. .. _GNOME Builder: https://wiki.gnome.org/Apps/Builder
  189. .. _Visual Studio Code: https://code.visualstudio.com/
  190. .. _gedi: https://github.com/isamert/gedi
  191. .. _Eric IDE: https://eric-ide.python-projects.org
  192. .. :changelog:
  193. Changelog
  194. ---------
  195. 0.13.3 (2019-02-24)
  196. +++++++++++++++++++
  197. - Fixed an issue with embedded Pytho, see https://github.com/davidhalter/jedi-vim/issues/870
  198. 0.13.2 (2018-12-15)
  199. +++++++++++++++++++
  200. - Fixed a bug that led to Jedi spawning a lot of subprocesses.
  201. 0.13.1 (2018-10-02)
  202. +++++++++++++++++++
  203. - Bugfixes, because tensorflow completions were still slow.
  204. 0.13.0 (2018-10-02)
  205. +++++++++++++++++++
  206. - A small release. Some bug fixes.
  207. - Remove Python 3.3 support. Python 3.3 support has been dropped by the Python
  208. foundation.
  209. - Default environments are now using the same Python version as the Python
  210. process. In 0.12.x, we used to load the latest Python version on the system.
  211. - Added ``include_builtins`` as a parameter to usages.
  212. - ``goto_assignments`` has a new ``follow_builtin_imports`` parameter that
  213. changes the previous behavior slightly.
  214. 0.12.1 (2018-06-30)
  215. +++++++++++++++++++
  216. - This release forces you to upgrade parso. If you don't, nothing will work
  217. anymore. Otherwise changes should be limited to bug fixes. Unfortunately Jedi
  218. still uses a few internals of parso that make it hard to keep compatibility
  219. over multiple releases. Parso >=0.3.0 is going to be needed.
  220. 0.12.0 (2018-04-15)
  221. +++++++++++++++++++
  222. - Virtualenv/Environment support
  223. - F-String Completion/Goto Support
  224. - Cannot crash with segfaults anymore
  225. - Cleaned up import logic
  226. - Understand async/await and autocomplete it (including async generators)
  227. - Better namespace completions
  228. - Passing tests for Windows (including CI for Windows)
  229. - Remove Python 2.6 support
  230. 0.11.1 (2017-12-14)
  231. +++++++++++++++++++
  232. - Parso update - the caching layer was broken
  233. - Better usages - a lot of internal code was ripped out and improved.
  234. 0.11.0 (2017-09-20)
  235. +++++++++++++++++++
  236. - Split Jedi's parser into a separate project called ``parso``.
  237. - Avoiding side effects in REPL completion.
  238. - Numpy docstring support should be much better.
  239. - Moved the `settings.*recursion*` away, they are no longer usable.
  240. 0.10.2 (2017-04-05)
  241. +++++++++++++++++++
  242. - Python Packaging sucks. Some files were not included in 0.10.1.
  243. 0.10.1 (2017-04-05)
  244. +++++++++++++++++++
  245. - Fixed a few very annoying bugs.
  246. - Prepared the parser to be factored out of Jedi.
  247. 0.10.0 (2017-02-03)
  248. +++++++++++++++++++
  249. - Actual semantic completions for the complete Python syntax.
  250. - Basic type inference for ``yield from`` PEP 380.
  251. - PEP 484 support (most of the important features of it). Thanks Claude! (@reinhrst)
  252. - Added ``get_line_code`` to ``Definition`` and ``Completion`` objects.
  253. - Completely rewritten the type inference engine.
  254. - A new and better parser for (fast) parsing diffs of Python code.
  255. 0.9.0 (2015-04-10)
  256. ++++++++++++++++++
  257. - The import logic has been rewritten to look more like Python's. There is now
  258. an ``Evaluator.modules`` import cache, which resembles ``sys.modules``.
  259. - Integrated the parser of 2to3. This will make refactoring possible. It will
  260. also be possible to check for error messages (like compiling an AST would give)
  261. in the future.
  262. - With the new parser, the evaluation also completely changed. It's now simpler
  263. and more readable.
  264. - Completely rewritten REPL completion.
  265. - Added ``jedi.names``, a command to do static analysis. Thanks to that
  266. sourcegraph guys for sponsoring this!
  267. - Alpha version of the linter.
  268. 0.8.1 (2014-07-23)
  269. +++++++++++++++++++
  270. - Bugfix release, the last release forgot to include files that improve
  271. autocompletion for builtin libraries. Fixed.
  272. 0.8.0 (2014-05-05)
  273. +++++++++++++++++++
  274. - Memory Consumption for compiled modules (e.g. builtins, sys) has been reduced
  275. drastically. Loading times are down as well (it takes basically as long as an
  276. import).
  277. - REPL completion is starting to become usable.
  278. - Various small API changes. Generally this release focuses on stability and
  279. refactoring of internal APIs.
  280. - Introducing operator precedence, which makes calculating correct Array
  281. indices and ``__getattr__`` strings possible.
  282. 0.7.0 (2013-08-09)
  283. ++++++++++++++++++
  284. - Switched from LGPL to MIT license.
  285. - Added an Interpreter class to the API to make autocompletion in REPL
  286. possible.
  287. - Added autocompletion support for namespace packages.
  288. - Add sith.py, a new random testing method.
  289. 0.6.0 (2013-05-14)
  290. ++++++++++++++++++
  291. - Much faster parser with builtin part caching.
  292. - A test suite, thanks @tkf.
  293. 0.5 versions (2012)
  294. +++++++++++++++++++
  295. - Initial development.