VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2026-01-31 04:25:23 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Create a 'jedi.names' function with the proper docstring.

Browse Source 
Modelled according the discussion in #477.
This commit is contained in:
Dave Halter
2014-09-08 21:43:16 +02:00
parent ca536baf9b
commit be85391321
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
jedi/api/__init__.py
View File

@@ -679,11 +679,21 @@ def defined_names(source, path=None, encoding='utf-8'):
return classes.defined_names(Evaluator(), parser.module)
def _names(source=None, path=None, encoding='utf-8'):
def names(source=None, path=None, encoding='utf-8', all_scopes=False,
definitions=True, references=False):
"""
Returns a list of `Definition` objects, containing name parts.
This means you can call ``Definition.goto_assignments()`` and get the
reference of a name.
The parameters are the same as in :py:class:`Script`, except or the
following ones:
:param all_scopes: If True lists the names of all scopes instead of only
the module namespace.
:param definitions: If True lists the names that have been defined by a
class, function or a statement (``a = b`` returns ``a``).
:param references: If True lists all the names that are not listed by
``definitions=True``. E.g. ``a = b`` returns ``b``.
"""
# Set line/column to a random position, because they don't matter.
script = Script(source, line=1, column=0, path=path, encoding=encoding)