VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2025-12-09 07:14:48 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Features

Browse Source
This commit is contained in:
Dave Halter
2020-03-16 00:00:43 +01:00
parent 43363936cd
commit 0f11f65682
2 changed files with 14 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.rst
View File

@@ -160,7 +160,7 @@ Refactoring
Jedi supports the following refactorings: Jedi supports the following refactorings:
- ``jedi.Script.inline_variable`` - ``jedi.Script.inline``
- ``jedi.Script.rename`` - ``jedi.Script.rename``
- ``jedi.Script.extract_function`` - ``jedi.Script.extract_function``
- ``jedi.Script.extract_variable`` - ``jedi.Script.extract_variable``

27
docs/docs/features.rst
View File

@@ -9,7 +9,7 @@ Jedi's main API calls are:
working in (:ref:`your REPL (IPython, etc.) <repl-completion>`) working in (:ref:`your REPL (IPython, etc.) <repl-completion>`)
- Goto/Type Inference: :meth:`.Script.goto` and :meth:`.Script.infer` - Goto/Type Inference: :meth:`.Script.goto` and :meth:`.Script.infer`
- Static Analysis: :meth:`.Script.get_names` and :meth:`.Script.get_syntax_errors` - Static Analysis: :meth:`.Script.get_names` and :meth:`.Script.get_syntax_errors`
- Refactorings: :meth:`.Script.rename`, :meth:`.Script.inline_variable`, - Refactorings: :meth:`.Script.rename`, :meth:`.Script.inline`,
:meth:`.Script.extract_variable` and :meth:`.Script.extract_function` :meth:`.Script.extract_variable` and :meth:`.Script.extract_function`
- Code Search: :meth:`.Script.search` and :meth:`.Project.search` - Code Search: :meth:`.Script.search` and :meth:`.Project.search`
@@ -57,17 +57,16 @@ Supported Python Features
Not Supported Not Supported
------------- -------------
Not yet implemented: Things that will probably never be implemented:
- manipulations of instances outside the instance variables without using - Arbitrary metaclasses (how could an auto-completion ever support this), some
methods of them like enums and dataclasses are reimplemented in Jedi to make them
work. Most of the time stubs are good enough to get type inference working,
Will probably never be implemented: even when metaclasses are involved.
- metaclasses (how could an auto-completion ever support this)
- ``setattr()``, ``__import__()`` - ``setattr()``, ``__import__()``
- writing to some dicts: ``globals()``, ``locals()``, ``object.__dict__`` - Writing to some dicts: ``globals()``, ``locals()``, ``object.__dict__``
- Manipulations of instances outside the instance variables without using
methods
Caveats Caveats
------- -------
@@ -75,10 +74,10 @@ Caveats
**Slow Performance** **Slow Performance**
Importing ``numpy`` can be quite slow sometimes, as well as loading the Importing ``numpy`` can be quite slow sometimes, as well as loading the
builtins the first time. If you want to speed things up, you could write import builtins the first time. If you want to speed things up, you could preload
hooks in |jedi|, which preload stuff. However, once loaded, this is not a libriaries in |jedi|, with :func:`preload_module`. However, once loaded, this
problem anymore. The same is true for huge modules like ``PySide``, ``wx``, should not be a problem anymore. The same is true for huge modules like
etc. ``PySide``, ``wx``, ``tensorflow``, ``pandas``, etc.
**Security** **Security**