forked from VimPlug/jedi
1121 lines
42 KiB
Python
1121 lines
42 KiB
Python
"""
|
|
Like described in the :mod:`jedi.parser.tree` module,
|
|
there's a need for an ast like module to represent the states of parsed
|
|
modules.
|
|
|
|
But now there are also structures in Python that need a little bit more than
|
|
that. An ``Instance`` for example is only a ``Class`` before it is
|
|
instantiated. This class represents these cases.
|
|
|
|
So, why is there also a ``Class`` class here? Well, there are decorators and
|
|
they change classes in Python 3.
|
|
|
|
Representation modules also define "magic methods". Those methods look like
|
|
``py__foo__`` and are typically mappable to the Python equivalents ``__call__``
|
|
and others. Here's a list:
|
|
|
|
====================================== ========================================
|
|
**Method** **Description**
|
|
-------------------------------------- ----------------------------------------
|
|
py__call__(params: Array) On callable objects, returns types.
|
|
py__bool__() Returns True/False/None; None means that
|
|
there's no certainty.
|
|
py__bases__() Returns a list of base classes.
|
|
py__mro__() Returns a list of classes (the mro).
|
|
py__iter__() Returns a generator of a set of types.
|
|
py__class__() Returns the class of an instance.
|
|
py__getitem__(index: int/str) Returns a a set of types of the index.
|
|
Can raise an IndexError/KeyError.
|
|
py__file__() Only on modules.
|
|
py__package__() Only on modules. For the import system.
|
|
py__path__() Only on modules. For the import system.
|
|
====================================== ========================================
|
|
|
|
__
|
|
"""
|
|
import os
|
|
import pkgutil
|
|
import imp
|
|
import re
|
|
from itertools import chain
|
|
|
|
from jedi._compatibility import use_metaclass, unicode, Python3Method, is_py3
|
|
from jedi.parser import tree
|
|
from jedi import debug
|
|
from jedi import common
|
|
from jedi.cache import underscore_memoization, cache_star_import
|
|
from jedi.evaluate.cache import memoize_default, CachedMetaClass, NO_DEFAULT
|
|
from jedi.evaluate import compiled
|
|
from jedi.evaluate.compiled import mixed
|
|
from jedi.evaluate import recursion
|
|
from jedi.evaluate import iterable
|
|
from jedi.evaluate import docstrings
|
|
from jedi.evaluate import pep0484
|
|
from jedi.evaluate import helpers
|
|
from jedi.evaluate import param
|
|
from jedi.evaluate import flow_analysis
|
|
from jedi.evaluate import imports
|
|
from jedi.evaluate.filters import ParserTreeFilter, FunctionExecutionFilter, \
|
|
GlobalNameFilter, DictFilter
|
|
|
|
|
|
class Context(object):
|
|
def __init__(self, evaluator, parent_context=None):
|
|
self._evaluator = evaluator
|
|
self.parent_context = parent_context
|
|
|
|
def get_parent_flow_context(self):
|
|
return self.parent_context
|
|
|
|
|
|
class FlowContext(Context):
|
|
def get_parent_flow_context(self):
|
|
if 1:
|
|
return self.parent_context
|
|
|
|
|
|
class Executed(tree.Base):
|
|
"""
|
|
An instance is also an executable - because __init__ is called
|
|
:param var_args: The param input array, consist of a parser node or a list.
|
|
"""
|
|
def __init__(self, evaluator, base, var_args=()):
|
|
self._evaluator = evaluator
|
|
self.base = base
|
|
self.var_args = var_args
|
|
|
|
def is_scope(self):
|
|
return True
|
|
|
|
def get_parent_until(self, *args, **kwargs):
|
|
return tree.Base.get_parent_until(self, *args, **kwargs)
|
|
|
|
@common.safe_property
|
|
def parent(self):
|
|
return self.base.parent
|
|
|
|
|
|
class Instance(use_metaclass(CachedMetaClass, Executed)):
|
|
"""
|
|
This class is used to evaluate instances.
|
|
"""
|
|
def __init__(self, evaluator, base, var_args, is_generated=False):
|
|
super(Instance, self).__init__(evaluator, base, var_args)
|
|
self.decorates = None
|
|
# Generated instances are classes that are just generated by self
|
|
# (No var_args) used.
|
|
self.is_generated = is_generated
|
|
|
|
self._init_execution = None
|
|
if base.name.get_code() in ['list', 'set'] \
|
|
and evaluator.BUILTINS == base.get_parent_until():
|
|
# compare the module path with the builtin name.
|
|
self.var_args = iterable.check_array_instances(evaluator, self)
|
|
elif not is_generated:
|
|
# Need to execute the __init__ function, because the dynamic param
|
|
# searching needs it.
|
|
try:
|
|
method = self.get_subscope_by_name('__init__')
|
|
except KeyError:
|
|
pass
|
|
else:
|
|
self._init_execution = evaluator.execute(method, self.var_args)
|
|
|
|
def is_class(self):
|
|
return False
|
|
|
|
@property
|
|
def py__call__(self):
|
|
def actual(params):
|
|
return self._evaluator.execute(method, params)
|
|
|
|
try:
|
|
method = self.get_subscope_by_name('__call__')
|
|
except KeyError:
|
|
# Means the Instance is not callable.
|
|
raise AttributeError
|
|
|
|
return actual
|
|
|
|
def py__class__(self):
|
|
return self.base
|
|
|
|
def py__bool__(self):
|
|
# Signalize that we don't know about the bool type.
|
|
return None
|
|
|
|
@memoize_default()
|
|
def _get_init_execution(self):
|
|
try:
|
|
func = self.get_subscope_by_name('__init__')
|
|
except KeyError:
|
|
return None
|
|
return FunctionExecution(self._evaluator, func, self.var_args)
|
|
|
|
def _get_func_self_name(self, func):
|
|
"""
|
|
Returns the name of the first param in a class method (which is
|
|
normally self.
|
|
"""
|
|
try:
|
|
return str(func.params[0].name)
|
|
except IndexError:
|
|
return None
|
|
|
|
def _self_names_dict(self, add_mro=True):
|
|
names = {}
|
|
# This loop adds the names of the self object, copies them and removes
|
|
# the self.
|
|
for sub in self.base.subscopes:
|
|
if isinstance(sub, tree.ClassContext):
|
|
continue
|
|
# Get the self name, if there's one.
|
|
self_name = self._get_func_self_name(sub)
|
|
if self_name is None:
|
|
continue
|
|
|
|
if sub.name.value == '__init__' and not self.is_generated:
|
|
# ``__init__`` is special because the params need are injected
|
|
# this way. Therefore an execution is necessary.
|
|
if not sub.get_decorators():
|
|
# __init__ decorators should generally just be ignored,
|
|
# because to follow them and their self variables is too
|
|
# complicated.
|
|
sub = self._get_init_execution()
|
|
for name_list in sub.names_dict.values():
|
|
for name in name_list:
|
|
if name.value == self_name and name.get_previous_sibling() is None:
|
|
trailer = name.get_next_sibling()
|
|
if tree.is_node(trailer, 'trailer') \
|
|
and len(trailer.children) == 2 \
|
|
and trailer.children[0] == '.':
|
|
name = trailer.children[1] # After dot.
|
|
if name.is_definition():
|
|
arr = names.setdefault(name.value, [])
|
|
arr.append(get_instance_el(self._evaluator, self, name))
|
|
return names
|
|
|
|
def get_subscope_by_name(self, name):
|
|
sub = self.base.get_subscope_by_name(name)
|
|
return get_instance_el(self._evaluator, self, sub, True)
|
|
|
|
def execute_subscope_by_name(self, name, *args):
|
|
method = self.get_subscope_by_name(name)
|
|
return self._evaluator.execute_evaluated(method, *args)
|
|
|
|
def get_descriptor_returns(self, obj):
|
|
""" Throws a KeyError if there's no method. """
|
|
# Arguments in __get__ descriptors are obj, class.
|
|
# `method` is the new parent of the array, don't know if that's good.
|
|
none_obj = compiled.create(self._evaluator, None)
|
|
args = [obj, obj.base] if isinstance(obj, Instance) else [none_obj, obj]
|
|
try:
|
|
return self.execute_subscope_by_name('__get__', *args)
|
|
except KeyError:
|
|
return set([self])
|
|
|
|
@memoize_default()
|
|
def names_dicts(self, search_global):
|
|
yield self._self_names_dict()
|
|
|
|
for s in self.base.py__mro__()[1:]:
|
|
if not isinstance(s, compiled.CompiledObject):
|
|
# Compiled objects don't have `self.` names.
|
|
for inst in self._evaluator.execute(s):
|
|
yield inst._self_names_dict(add_mro=False)
|
|
|
|
for names_dict in self.base.names_dicts(search_global=False, is_instance=True):
|
|
yield LazyInstanceDict(self._evaluator, self, names_dict)
|
|
|
|
def get_filters(self, search_global, until_position=None, origin_scope=None):
|
|
for cls in self.base.py__mro__():
|
|
if isinstance(cls, compiled.CompiledObject):
|
|
yield SelfNameFilter(self._evaluator, self, cls, origin_scope)
|
|
else:
|
|
yield SelfNameFilter(self._evaluator, self, cls.base, origin_scope)
|
|
|
|
for cls in self.base.py__mro__():
|
|
if isinstance(cls, compiled.CompiledObject):
|
|
yield CompiledInstanceClassFilter(self._evaluator, self, cls)
|
|
else:
|
|
yield InstanceClassFilter(self._evaluator, self, cls.base, origin_scope)
|
|
|
|
def py__getitem__(self, index):
|
|
try:
|
|
method = self.get_subscope_by_name('__getitem__')
|
|
except KeyError:
|
|
debug.warning('No __getitem__, cannot access the array.')
|
|
return set()
|
|
else:
|
|
index_obj = compiled.create(self._evaluator, index)
|
|
return self._evaluator.execute_evaluated(method, index_obj)
|
|
|
|
def py__iter__(self):
|
|
try:
|
|
method = self.get_subscope_by_name('__iter__')
|
|
except KeyError:
|
|
debug.warning('No __iter__ on %s.' % self)
|
|
return
|
|
else:
|
|
iters = self._evaluator.execute(method)
|
|
for generator in iters:
|
|
if isinstance(generator, Instance):
|
|
# `__next__` logic.
|
|
name = '__next__' if is_py3 else 'next'
|
|
try:
|
|
yield generator.execute_subscope_by_name(name)
|
|
except KeyError:
|
|
debug.warning('Instance has no __next__ function in %s.', generator)
|
|
else:
|
|
for typ in generator.py__iter__():
|
|
yield typ
|
|
|
|
@property
|
|
@underscore_memoization
|
|
def name(self):
|
|
name = self.base.name
|
|
return helpers.FakeName(unicode(name), self, name.start_pos)
|
|
|
|
def __getattr__(self, name):
|
|
if name not in ['start_pos', 'end_pos', 'get_imports', 'type',
|
|
'doc', 'raw_doc']:
|
|
raise AttributeError("Instance %s: Don't touch this (%s)!"
|
|
% (self, name))
|
|
return getattr(self.base, name)
|
|
|
|
def __repr__(self):
|
|
dec = ''
|
|
if self.decorates is not None:
|
|
dec = " decorates " + repr(self.decorates)
|
|
return "<%s of %s(%s)%s>" % (type(self).__name__, self.base,
|
|
self.var_args, dec)
|
|
|
|
|
|
class CompiledInstanceClassFilter(compiled.CompiledObjectFilter):
|
|
def __init__(self, evaluator, instance, compiled_object):
|
|
super(CompiledInstanceClassFilter, self).__init__(
|
|
evaluator,
|
|
compiled_object,
|
|
is_instance=True,
|
|
)
|
|
self._instance = instance
|
|
|
|
def _filter(self, names):
|
|
names = super(CompiledInstanceClassFilter, self)._filter(names)
|
|
return [get_instance_el(self._evaluator, self._instance, name, True)
|
|
for name in names]
|
|
|
|
|
|
class InstanceClassFilter(ParserTreeFilter):
|
|
def __init__(self, evaluator, context, parser_scope, origin_scope):
|
|
super(InstanceClassFilter, self).__init__(
|
|
evaluator=evaluator,
|
|
context=context,
|
|
parser_scope=parser_scope,
|
|
origin_scope=origin_scope
|
|
)
|
|
|
|
def _equals_origin_scope(self):
|
|
node = self._origin_scope
|
|
while node is not None:
|
|
if node == self._parser_scope or node == self._context:
|
|
return True
|
|
node = node.get_parent_scope()
|
|
return False
|
|
|
|
def _access_possible(self, name):
|
|
return not name.value.startswith('__') or name.value.endswith('__') \
|
|
or self._equals_origin_scope()
|
|
|
|
def _filter(self, names):
|
|
names = super(InstanceClassFilter, self)._filter(names)
|
|
return [get_instance_el(self._evaluator, self._context, name, True)
|
|
for name in names if self._access_possible(name)]
|
|
|
|
def _check_flows(self, names):
|
|
return names
|
|
|
|
|
|
class SelfNameFilter(InstanceClassFilter):
|
|
def _filter(self, names):
|
|
names = self._filter_self_names(names)
|
|
if isinstance(self._parser_scope, compiled.CompiledObject):
|
|
# This would be for builtin skeletons, which are not yet supported.
|
|
return []
|
|
start, end = self._parser_scope.start_pos, self._parser_scope.end_pos
|
|
return [n for n in names if start < n.start_pos < end]
|
|
|
|
def _filter_self_names(self, names):
|
|
for name in names:
|
|
trailer = name.parent
|
|
if tree.is_node(trailer, 'trailer') \
|
|
and len(trailer.children) == 2 \
|
|
and trailer.children[0] == '.':
|
|
if name.is_definition() and self._access_possible(name):
|
|
init_execution = self._context._get_init_execution()
|
|
# Hopefully we can somehow change this.
|
|
if init_execution is not None and \
|
|
init_execution.start_pos < name.start_pos < init_execution.end_pos:
|
|
name = init_execution.name_for_position(name.start_pos)
|
|
yield get_instance_el(self._evaluator, self._context, name)
|
|
|
|
|
|
class LazyInstanceDict(object):
|
|
def __init__(self, evaluator, instance, dct):
|
|
self._evaluator = evaluator
|
|
self._instance = instance
|
|
self._dct = dct
|
|
|
|
def __getitem__(self, name):
|
|
return [get_instance_el(self._evaluator, self._instance, var, True)
|
|
for var in self._dct[name]]
|
|
|
|
def values(self):
|
|
return [self[key] for key in self._dct]
|
|
|
|
|
|
class InstanceName(tree.Name):
|
|
def __init__(self, origin_name, parent):
|
|
super(InstanceName, self).__init__(origin_name.value,
|
|
origin_name.start_pos)
|
|
self._origin_name = origin_name
|
|
self.parent = parent
|
|
|
|
def is_definition(self):
|
|
return self._origin_name.is_definition()
|
|
|
|
|
|
def get_instance_el(evaluator, instance, var, is_class_var=False):
|
|
"""
|
|
Returns an InstanceElement if it makes sense, otherwise leaves the object
|
|
untouched.
|
|
|
|
Basically having an InstanceElement is context information. That is needed
|
|
in quite a lot of cases, which includes Nodes like ``power``, that need to
|
|
know where a self name comes from for example.
|
|
"""
|
|
if isinstance(var, tree.Name):
|
|
parent = get_instance_el(evaluator, instance, var.parent, is_class_var)
|
|
return InstanceName(var, parent)
|
|
elif var.type != 'funcdef' \
|
|
and isinstance(var, (Instance, compiled.CompiledObject, tree.Leaf,
|
|
tree.Module, FunctionExecution)):
|
|
return var
|
|
|
|
var = evaluator.wrap(var)
|
|
return InstanceElement(evaluator, instance, var, is_class_var)
|
|
|
|
|
|
class InstanceElement(use_metaclass(CachedMetaClass, tree.Base)):
|
|
"""
|
|
InstanceElement is a wrapper for any object, that is used as an instance
|
|
variable (e.g. self.variable or class methods).
|
|
"""
|
|
def __init__(self, evaluator, instance, var, is_class_var):
|
|
self._evaluator = evaluator
|
|
self.instance = instance
|
|
self.var = var
|
|
self.is_class_var = is_class_var
|
|
|
|
@common.safe_property
|
|
@memoize_default()
|
|
def parent(self):
|
|
par = self.var.parent
|
|
if isinstance(par, ClassContext) and par == self.instance.base \
|
|
or not isinstance(self.instance.base, (tree.Class, ClassContext)) \
|
|
or isinstance(par, tree.Class) \
|
|
and par == self.instance.base.base:
|
|
par = self.instance
|
|
else:
|
|
par = get_instance_el(self._evaluator, self.instance, par,
|
|
self.is_class_var)
|
|
return par
|
|
|
|
def get_parent_until(self, *args, **kwargs):
|
|
return tree.BaseNode.get_parent_until(self, *args, **kwargs)
|
|
|
|
def get_definition(self):
|
|
return self.get_parent_until((tree.ExprStmt, tree.IsScope, tree.Import))
|
|
|
|
def get_decorated_func(self):
|
|
""" Needed because the InstanceElement should not be stripped """
|
|
func = self.var.get_decorated_func()
|
|
func = get_instance_el(self._evaluator, self.instance, func)
|
|
return func
|
|
|
|
def get_rhs(self):
|
|
return get_instance_el(self._evaluator, self.instance,
|
|
self.var.get_rhs(), self.is_class_var)
|
|
|
|
def is_definition(self):
|
|
return self.var.is_definition()
|
|
|
|
@property
|
|
def children(self):
|
|
# Copy and modify the array.
|
|
return [get_instance_el(self._evaluator, self.instance, command, self.is_class_var)
|
|
for command in self.var.children]
|
|
|
|
@property
|
|
@memoize_default()
|
|
def name(self):
|
|
name = self.var.name
|
|
return helpers.FakeName(unicode(name), self, name.start_pos)
|
|
|
|
def __iter__(self):
|
|
for el in self.var.__iter__():
|
|
yield get_instance_el(self._evaluator, self.instance, el,
|
|
self.is_class_var)
|
|
|
|
def __getitem__(self, index):
|
|
return get_instance_el(self._evaluator, self.instance, self.var[index],
|
|
self.is_class_var)
|
|
|
|
def __getattr__(self, name):
|
|
return getattr(self.var, name)
|
|
|
|
def isinstance(self, *cls):
|
|
return isinstance(self.var, cls)
|
|
|
|
def is_scope(self):
|
|
"""
|
|
Since we inherit from Base, it would overwrite the action we want here.
|
|
"""
|
|
return self.var.is_scope()
|
|
|
|
def py__call__(self, params):
|
|
if isinstance(self.var, compiled.CompiledObject):
|
|
# This check is a bit strange, but CompiledObject itself is a bit
|
|
# more complicated than we would it actually like to be.
|
|
return self.var.py__call__(params)
|
|
else:
|
|
return Function.py__call__(self, params)
|
|
|
|
def __repr__(self):
|
|
return "<%s of %s>" % (type(self).__name__, self.var)
|
|
|
|
|
|
class Wrapper(tree.Base):
|
|
def is_scope(self):
|
|
return True
|
|
|
|
def is_class(self):
|
|
return False
|
|
|
|
def py__bool__(self):
|
|
"""
|
|
Since Wrapper is a super class for classes, functions and modules,
|
|
the return value will always be true.
|
|
"""
|
|
return True
|
|
|
|
@property
|
|
@underscore_memoization
|
|
def name(self):
|
|
name = self.base.name
|
|
return helpers.FakeName(unicode(name), self, name.start_pos)
|
|
|
|
|
|
class ClassContext(use_metaclass(CachedMetaClass, Context, Wrapper)):
|
|
"""
|
|
This class is not only important to extend `tree.Class`, it is also a
|
|
important for descriptors (if the descriptor methods are evaluated or not).
|
|
"""
|
|
def __init__(self, evaluator, base, parent_context):
|
|
super(ClassContext, self).__init__(evaluator, parent_context=parent_context)
|
|
self.base = base
|
|
|
|
@memoize_default(default=())
|
|
def py__mro__(self):
|
|
def add(cls):
|
|
if cls not in mro:
|
|
mro.append(cls)
|
|
|
|
mro = [self]
|
|
# TODO Do a proper mro resolution. Currently we are just listing
|
|
# classes. However, it's a complicated algorithm.
|
|
for cls in self.py__bases__():
|
|
# TODO detect for TypeError: duplicate base class str,
|
|
# e.g. `class X(str, str): pass`
|
|
try:
|
|
mro_method = cls.py__mro__
|
|
except AttributeError:
|
|
# TODO add a TypeError like:
|
|
"""
|
|
>>> class Y(lambda: test): pass
|
|
Traceback (most recent call last):
|
|
File "<stdin>", line 1, in <module>
|
|
TypeError: function() argument 1 must be code, not str
|
|
>>> class Y(1): pass
|
|
Traceback (most recent call last):
|
|
File "<stdin>", line 1, in <module>
|
|
TypeError: int() takes at most 2 arguments (3 given)
|
|
"""
|
|
pass
|
|
else:
|
|
add(cls)
|
|
for cls_new in mro_method():
|
|
add(cls_new)
|
|
return tuple(mro)
|
|
|
|
@memoize_default(default=())
|
|
def py__bases__(self):
|
|
arglist = self.base.get_super_arglist()
|
|
if arglist:
|
|
args = param.Arguments(self._evaluator, self, arglist)
|
|
return list(chain.from_iterable(args.eval_args()))
|
|
else:
|
|
return [compiled.create(self._evaluator, object)]
|
|
|
|
def py__call__(self, params):
|
|
return set([Instance(self._evaluator, self, params)])
|
|
|
|
def py__class__(self):
|
|
return compiled.create(self._evaluator, type)
|
|
|
|
@property
|
|
def params(self):
|
|
try:
|
|
return self.get_subscope_by_name('__init__').params
|
|
except KeyError:
|
|
return [] # object.__init__
|
|
|
|
def names_dicts(self, search_global, is_instance=False):
|
|
if search_global:
|
|
yield self.names_dict
|
|
else:
|
|
for scope in self.py__mro__():
|
|
if isinstance(scope, compiled.CompiledObject):
|
|
yield scope.names_dicts(False, is_instance)[0]
|
|
else:
|
|
yield scope.names_dict
|
|
|
|
def get_filters(self, search_global, until_position=None, origin_scope=None, is_instance=False):
|
|
if search_global:
|
|
yield ParserTreeFilter(self._evaluator, self, self.base, until_position, origin_scope=origin_scope)
|
|
else:
|
|
for scope in self.py__mro__():
|
|
if isinstance(scope, compiled.CompiledObject):
|
|
for filter in scope.get_filters(is_instance=is_instance):
|
|
yield filter
|
|
else:
|
|
yield ParserTreeFilter(self._evaluator, self, scope.base, origin_scope=origin_scope)
|
|
|
|
def is_class(self):
|
|
return True
|
|
|
|
def get_subscope_by_name(self, name):
|
|
for s in self.py__mro__():
|
|
for sub in reversed(s.subscopes):
|
|
if sub.name.value == name:
|
|
return sub
|
|
raise KeyError("Couldn't find subscope.")
|
|
|
|
def __getattr__(self, name):
|
|
if name not in ['start_pos', 'end_pos', 'parent', 'raw_doc',
|
|
'doc', 'get_imports', 'get_parent_until', 'get_code',
|
|
'subscopes', 'names_dict', 'type']:
|
|
raise AttributeError("Don't touch this: %s of %s !" % (name, self))
|
|
return getattr(self.base, name)
|
|
|
|
def __repr__(self):
|
|
return "<e%s of %s>" % (type(self).__name__, self.base)
|
|
|
|
|
|
class Function(use_metaclass(CachedMetaClass, Wrapper)):
|
|
"""
|
|
Needed because of decorators. Decorators are evaluated here.
|
|
"""
|
|
def __init__(self, evaluator, func, is_decorated=False):
|
|
""" This should not be called directly """
|
|
self._evaluator = evaluator
|
|
self.base = self.base_func = func
|
|
self.is_decorated = is_decorated
|
|
# A property that is set by the decorator resolution.
|
|
self.decorates = None
|
|
|
|
@memoize_default()
|
|
def get_decorated_func(self):
|
|
"""
|
|
Returns the function, that should to be executed in the end.
|
|
This is also the places where the decorators are processed.
|
|
"""
|
|
f = self.base_func
|
|
decorators = self.base_func.get_decorators()
|
|
|
|
if not decorators or self.is_decorated:
|
|
return self
|
|
|
|
# Only enter it, if has not already been processed.
|
|
if not self.is_decorated:
|
|
for dec in reversed(decorators):
|
|
debug.dbg('decorator: %s %s', dec, f)
|
|
dec_results = self._evaluator.eval_element(dec.children[1])
|
|
trailer = dec.children[2:-1]
|
|
if trailer:
|
|
# Create a trailer and evaluate it.
|
|
trailer = tree.Node('trailer', trailer)
|
|
trailer.parent = dec
|
|
dec_results = self._evaluator.eval_trailer(dec_results, trailer)
|
|
|
|
if not len(dec_results):
|
|
debug.warning('decorator not found: %s on %s', dec, self.base_func)
|
|
return self
|
|
decorator = dec_results.pop()
|
|
if dec_results:
|
|
debug.warning('multiple decorators found %s %s',
|
|
self.base_func, dec_results)
|
|
|
|
# Create param array.
|
|
if isinstance(f, Function):
|
|
old_func = f # TODO this is just hacky. change.
|
|
elif f.type == 'funcdef':
|
|
old_func = Function(self._evaluator, f, is_decorated=True)
|
|
else:
|
|
old_func = f
|
|
|
|
wrappers = self._evaluator.execute_evaluated(decorator, old_func)
|
|
if not len(wrappers):
|
|
debug.warning('no wrappers found %s', self.base_func)
|
|
return self
|
|
if len(wrappers) > 1:
|
|
# TODO resolve issue with multiple wrappers -> multiple types
|
|
debug.warning('multiple wrappers found %s %s',
|
|
self.base_func, wrappers)
|
|
f = list(wrappers)[0]
|
|
if isinstance(f, (Instance, Function)):
|
|
f.decorates = self
|
|
|
|
debug.dbg('decorator end %s', f)
|
|
return f
|
|
|
|
def names_dicts(self, search_global):
|
|
if search_global:
|
|
yield self.names_dict
|
|
else:
|
|
scope = self.py__class__()
|
|
for names_dict in scope.names_dicts(False):
|
|
yield names_dict
|
|
|
|
def get_filters(self, search_global, until_position=None, origin_scope=None):
|
|
if search_global:
|
|
yield ParserTreeFilter(self._evaluator, self, self.base, until_position, origin_scope=origin_scope)
|
|
else:
|
|
scope = self.py__class__()
|
|
for filter in scope.get_filters(search_global=False, origin_scope=origin_scope):
|
|
yield filter
|
|
|
|
@Python3Method
|
|
def py__call__(self, params):
|
|
if self.base.is_generator():
|
|
return set([iterable.Generator(self._evaluator, self, params)])
|
|
else:
|
|
return FunctionExecution(self._evaluator, self, params).get_return_types()
|
|
|
|
@memoize_default()
|
|
def py__annotations__(self):
|
|
parser_func = self.base
|
|
return_annotation = parser_func.annotation()
|
|
if return_annotation:
|
|
dct = {'return': return_annotation}
|
|
else:
|
|
dct = {}
|
|
for function_param in parser_func.params:
|
|
param_annotation = function_param.annotation()
|
|
if param_annotation is not None:
|
|
dct[function_param.name.value] = param_annotation
|
|
return dct
|
|
|
|
def py__class__(self):
|
|
# This differentiation is only necessary for Python2. Python3 does not
|
|
# use a different method class.
|
|
if isinstance(self.base.get_parent_scope(), tree.Class):
|
|
name = 'METHOD_CLASS'
|
|
else:
|
|
name = 'FUNCTION_CLASS'
|
|
return compiled.get_special_object(self._evaluator, name)
|
|
|
|
def __getattr__(self, name):
|
|
return getattr(self.base_func, name)
|
|
|
|
def __repr__(self):
|
|
dec = ''
|
|
if self.decorates is not None:
|
|
dec = " decorates " + repr(self.decorates)
|
|
return "<e%s of %s%s>" % (type(self).__name__, self.base_func, dec)
|
|
|
|
|
|
class LambdaWrapper(Function):
|
|
def get_decorated_func(self):
|
|
return self
|
|
|
|
|
|
class FunctionExecution(Executed):
|
|
"""
|
|
This class is used to evaluate functions and their returns.
|
|
|
|
This is the most complicated class, because it contains the logic to
|
|
transfer parameters. It is even more complicated, because there may be
|
|
multiple calls to functions and recursion has to be avoided. But this is
|
|
responsibility of the decorators.
|
|
"""
|
|
type = 'funcdef'
|
|
|
|
def __init__(self, evaluator, base, *args, **kwargs):
|
|
super(FunctionExecution, self).__init__(evaluator, base, *args, **kwargs)
|
|
self._copy_dict = {}
|
|
self._original_function = funcdef = base.base_func
|
|
if isinstance(funcdef, mixed.MixedObject):
|
|
# The extra information in mixed is not needed anymore. We can just
|
|
# unpack it and give it the tree object.
|
|
funcdef = funcdef.definition
|
|
|
|
# Just overwrite the old version. We don't need it anymore.
|
|
funcdef = helpers.deep_ast_copy(funcdef, new_elements=self._copy_dict)
|
|
for child in funcdef.children:
|
|
if child.type not in ('operator', 'keyword'):
|
|
# Not all nodes are properly copied by deep_ast_copy.
|
|
child.parent = self
|
|
self.children = funcdef.children
|
|
self.names_dict = funcdef.names_dict
|
|
self._copied_funcdef = funcdef
|
|
|
|
@memoize_default(default=set())
|
|
@recursion.execution_recursion_decorator
|
|
def get_return_types(self, check_yields=False):
|
|
func = self.base
|
|
|
|
if func.isinstance(LambdaWrapper):
|
|
return self._evaluator.eval_element(self.children[-1])
|
|
|
|
if func.listeners:
|
|
# Feed the listeners, with the params.
|
|
for listener in func.listeners:
|
|
listener.execute(self._get_params())
|
|
# If we do have listeners, that means that there's not a regular
|
|
# execution ongoing. In this case Jedi is interested in the
|
|
# inserted params, not in the actual execution of the function.
|
|
return set()
|
|
|
|
if check_yields:
|
|
types = set()
|
|
returns = self.yields
|
|
else:
|
|
returns = self.returns
|
|
types = set(docstrings.find_return_types(self._evaluator, func))
|
|
types |= set(pep0484.find_return_types(self._evaluator, func))
|
|
|
|
for r in returns:
|
|
check = flow_analysis.break_check(self._evaluator, self, r)
|
|
if check is flow_analysis.UNREACHABLE:
|
|
debug.dbg('Return unreachable: %s', r)
|
|
else:
|
|
if check_yields:
|
|
types |= iterable.unite(self._eval_yield(r))
|
|
else:
|
|
types |= self._evaluator.eval_element(r.children[1])
|
|
if check is flow_analysis.REACHABLE:
|
|
debug.dbg('Return reachable: %s', r)
|
|
break
|
|
return types
|
|
|
|
def _eval_yield(self, yield_expr):
|
|
element = yield_expr.children[1]
|
|
if element.type == 'yield_arg':
|
|
# It must be a yield from.
|
|
yield_from_types = self._evaluator.eval_element(element.children[1])
|
|
for result in iterable.py__iter__(self._evaluator, yield_from_types, element):
|
|
yield result
|
|
else:
|
|
yield self._evaluator.eval_element(element)
|
|
|
|
@recursion.execution_recursion_decorator
|
|
def get_yield_types(self):
|
|
yields = self.yields
|
|
stopAt = tree.ForStmt, tree.WhileStmt, FunctionExecution, tree.IfStmt
|
|
for_parents = [(x, x.get_parent_until((stopAt))) for x in yields]
|
|
|
|
# Calculate if the yields are placed within the same for loop.
|
|
yields_order = []
|
|
last_for_stmt = None
|
|
for yield_, for_stmt in for_parents:
|
|
# For really simple for loops we can predict the order. Otherwise
|
|
# we just ignore it.
|
|
parent = for_stmt.parent
|
|
if parent.type == 'suite':
|
|
parent = parent.parent
|
|
if for_stmt.type == 'for_stmt' and parent == self \
|
|
and for_stmt.defines_one_name(): # Simplicity for now.
|
|
if for_stmt == last_for_stmt:
|
|
yields_order[-1][1].append(yield_)
|
|
else:
|
|
yields_order.append((for_stmt, [yield_]))
|
|
elif for_stmt == self:
|
|
yields_order.append((None, [yield_]))
|
|
else:
|
|
yield self.get_return_types(check_yields=True)
|
|
return
|
|
last_for_stmt = for_stmt
|
|
|
|
evaluator = self._evaluator
|
|
for for_stmt, yields in yields_order:
|
|
if for_stmt is None:
|
|
# No for_stmt, just normal yields.
|
|
for yield_ in yields:
|
|
for result in self._eval_yield(yield_):
|
|
yield result
|
|
else:
|
|
input_node = for_stmt.get_input_node()
|
|
for_types = evaluator.eval_element(input_node)
|
|
ordered = iterable.py__iter__(evaluator, for_types, input_node)
|
|
for index_types in ordered:
|
|
dct = {str(for_stmt.children[1]): index_types}
|
|
evaluator.predefined_if_name_dict_dict[for_stmt] = dct
|
|
for yield_in_same_for_stmt in yields:
|
|
for result in self._eval_yield(yield_in_same_for_stmt):
|
|
yield result
|
|
del evaluator.predefined_if_name_dict_dict[for_stmt]
|
|
|
|
def get_filters(self, search_global, until_position=None, origin_scope=None):
|
|
yield FunctionExecutionFilter(self._evaluator, self, self._original_function,
|
|
self._copied_funcdef,
|
|
self.param_by_name,
|
|
until_position,
|
|
origin_scope=origin_scope)
|
|
|
|
@memoize_default(default=NO_DEFAULT)
|
|
def _get_params(self):
|
|
"""
|
|
This returns the params for an TODO and is injected as a
|
|
'hack' into the tree.Function class.
|
|
This needs to be here, because Instance can have __init__ functions,
|
|
which act the same way as normal functions.
|
|
"""
|
|
return param.get_params(self._evaluator, self.base, self.var_args)
|
|
|
|
def param_by_name(self, name):
|
|
return [n for n in self._get_params() if str(n) == name][0]
|
|
|
|
def name_for_position(self, position):
|
|
return tree.Function.name_for_position(self, position)
|
|
|
|
def __getattr__(self, name):
|
|
if name not in ['start_pos', 'end_pos', 'imports', 'name', 'type']:
|
|
raise AttributeError('Tried to access %s: %s. Why?' % (name, self))
|
|
return getattr(self.base, name)
|
|
|
|
@common.safe_property
|
|
@memoize_default()
|
|
def returns(self):
|
|
return tree.Scope._search_in_scope(self, tree.ReturnStmt)
|
|
|
|
@common.safe_property
|
|
@memoize_default()
|
|
def yields(self):
|
|
return tree.Scope._search_in_scope(self, tree.YieldExpr)
|
|
|
|
@common.safe_property
|
|
@memoize_default()
|
|
def statements(self):
|
|
return tree.Scope._search_in_scope(self, tree.ExprStmt)
|
|
|
|
@common.safe_property
|
|
@memoize_default()
|
|
def subscopes(self):
|
|
return tree.Scope._search_in_scope(self, tree.Scope)
|
|
|
|
def __repr__(self):
|
|
return "<%s of %s>" % (type(self).__name__, self.base)
|
|
|
|
|
|
class GlobalName(helpers.FakeName):
|
|
def __init__(self, name):
|
|
"""
|
|
We need to mark global names somehow. Otherwise they are just normal
|
|
names that are not definitions.
|
|
"""
|
|
super(GlobalName, self).__init__(name.value, name.parent,
|
|
name.start_pos, is_definition=True)
|
|
|
|
|
|
class ModuleContext(use_metaclass(CachedMetaClass, tree.Module, Wrapper)):
|
|
parent_context = None
|
|
|
|
def __init__(self, evaluator, module, parent_module=None):
|
|
self._evaluator = evaluator
|
|
self.base = self._module = module
|
|
self._parent_module = parent_module
|
|
|
|
def names_dicts(self, search_global):
|
|
yield self.base.names_dict
|
|
yield self._module_attributes_dict()
|
|
|
|
for star_module in self.star_imports():
|
|
yield star_module.names_dict
|
|
|
|
yield dict((str(n), [GlobalName(n)]) for n in self.base.global_names)
|
|
yield self._sub_modules_dict()
|
|
|
|
def get_filters(self, search_global, until_position=None, origin_scope=None):
|
|
yield ParserTreeFilter(
|
|
self._evaluator,
|
|
self,
|
|
self._module,
|
|
until_position,
|
|
origin_scope=origin_scope
|
|
)
|
|
yield GlobalNameFilter(self, self._module)
|
|
yield DictFilter(self._sub_modules_dict())
|
|
yield DictFilter(self._module_attributes_dict())
|
|
# TODO
|
|
'''
|
|
for star_module in self.star_imports():
|
|
yield star_module.names_dict
|
|
'''
|
|
|
|
# I'm not sure if the star import cache is really that effective anymore
|
|
# with all the other really fast import caches. Recheck. Also we would need
|
|
# to push the star imports into Evaluator.modules, if we reenable this.
|
|
#@cache_star_import
|
|
@memoize_default([])
|
|
def star_imports(self):
|
|
modules = []
|
|
for i in self.base.imports:
|
|
if i.is_star_import():
|
|
name = i.star_import_name()
|
|
new = imports.ImportWrapper(self._evaluator, name).follow()
|
|
for module in new:
|
|
if isinstance(module, tree.Module):
|
|
modules += module.star_imports()
|
|
modules += new
|
|
return modules
|
|
|
|
@memoize_default()
|
|
def _module_attributes_dict(self):
|
|
def parent_callback():
|
|
# Create a string type object (without a defined string in it):
|
|
return list(self._evaluator.execute(compiled.create(self._evaluator, str)))[0]
|
|
|
|
names = ['__file__', '__package__', '__doc__', '__name__']
|
|
# All the additional module attributes are strings.
|
|
return dict((n, helpers.LazyName(n, parent_callback, is_definition=True))
|
|
for n in names)
|
|
|
|
@property
|
|
@memoize_default()
|
|
def name(self):
|
|
return helpers.FakeName(unicode(self.base.name), self, (1, 0))
|
|
|
|
def _get_init_directory(self):
|
|
"""
|
|
:return: The path to the directory of a package. None in case it's not
|
|
a package.
|
|
"""
|
|
for suffix, _, _ in imp.get_suffixes():
|
|
ending = '__init__' + suffix
|
|
py__file__ = self.py__file__()
|
|
if py__file__ is not None and py__file__.endswith(ending):
|
|
# Remove the ending, including the separator.
|
|
return self.py__file__()[:-len(ending) - 1]
|
|
return None
|
|
|
|
def py__name__(self):
|
|
for name, module in self._evaluator.modules.items():
|
|
if module == self:
|
|
return name
|
|
|
|
return '__main__'
|
|
|
|
def py__file__(self):
|
|
"""
|
|
In contrast to Python's __file__ can be None.
|
|
"""
|
|
if self._module.path is None:
|
|
return None
|
|
|
|
return os.path.abspath(self._module.path)
|
|
|
|
def py__package__(self):
|
|
if self._get_init_directory() is None:
|
|
return re.sub(r'\.?[^\.]+$', '', self.py__name__())
|
|
else:
|
|
return self.py__name__()
|
|
|
|
def _py__path__(self):
|
|
if self._parent_module is None:
|
|
search_path = self._evaluator.sys_path
|
|
else:
|
|
search_path = self._parent_module.py__path__()
|
|
init_path = self.py__file__()
|
|
if os.path.basename(init_path) == '__init__.py':
|
|
with open(init_path, 'rb') as f:
|
|
content = common.source_to_unicode(f.read())
|
|
# these are strings that need to be used for namespace packages,
|
|
# the first one is ``pkgutil``, the second ``pkg_resources``.
|
|
options = ('declare_namespace(__name__)', 'extend_path(__path__')
|
|
if options[0] in content or options[1] in content:
|
|
# It is a namespace, now try to find the rest of the
|
|
# modules on sys_path or whatever the search_path is.
|
|
paths = set()
|
|
for s in search_path:
|
|
other = os.path.join(s, unicode(self.name))
|
|
if os.path.isdir(other):
|
|
paths.add(other)
|
|
return list(paths)
|
|
# Default to this.
|
|
return [self._get_init_directory()]
|
|
|
|
@property
|
|
def py__path__(self):
|
|
"""
|
|
Not seen here, since it's a property. The callback actually uses a
|
|
variable, so use it like::
|
|
|
|
foo.py__path__(sys_path)
|
|
|
|
In case of a package, this returns Python's __path__ attribute, which
|
|
is a list of paths (strings).
|
|
Raises an AttributeError if the module is not a package.
|
|
"""
|
|
path = self._get_init_directory()
|
|
|
|
if path is None:
|
|
raise AttributeError('Only packages have __path__ attributes.')
|
|
else:
|
|
return self._py__path__
|
|
|
|
@memoize_default()
|
|
def _sub_modules_dict(self):
|
|
"""
|
|
Lists modules in the directory of this module (if this module is a
|
|
package).
|
|
"""
|
|
path = self._module.path
|
|
names = {}
|
|
if path is not None and path.endswith(os.path.sep + '__init__.py'):
|
|
mods = pkgutil.iter_modules([os.path.dirname(path)])
|
|
for module_loader, name, is_pkg in mods:
|
|
fake_n = helpers.FakeName(name)
|
|
# It's obviously a relative import to the current module.
|
|
imp = helpers.FakeImport(fake_n, self, level=1)
|
|
fake_n.parent = imp
|
|
names[name] = fake_n
|
|
|
|
# TODO add something like this in the future, its cleaner than the
|
|
# import hacks.
|
|
# ``os.path`` is a hardcoded exception, because it's a
|
|
# ``sys.modules`` modification.
|
|
#if str(self.name) == 'os':
|
|
# names.append(helpers.FakeName('path', parent=self))
|
|
|
|
return names
|
|
|
|
def py__class__(self):
|
|
return compiled.get_special_object(self._evaluator, 'MODULE_CLASS')
|
|
|
|
def __getattr__(self, name):
|
|
return getattr(self._module, name)
|
|
|
|
def __repr__(self):
|
|
return "<%s: %s>" % (type(self).__name__, self._module)
|