forked from VimPlug/jedi
267 lines
9.9 KiB
Python
267 lines
9.9 KiB
Python
"""
|
|
Like described in the :mod:`parso.python.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. Returns None if does
|
|
not exist.
|
|
py__package__() Only on modules. For the import system.
|
|
py__path__() Only on modules. For the import system.
|
|
py__get__(call_object) Only on instances. Simulates
|
|
descriptors.
|
|
py__doc__(include_call_signature: Returns the docstring for a context.
|
|
bool)
|
|
====================================== ========================================
|
|
|
|
"""
|
|
import os
|
|
from itertools import chain
|
|
|
|
from jedi._compatibility import use_metaclass
|
|
from jedi.evaluate.cache import evaluator_method_cache, CachedMetaClass
|
|
from jedi.evaluate import compiled
|
|
from jedi.evaluate import param
|
|
from jedi.evaluate import imports
|
|
from jedi.evaluate.filters import ParserTreeFilter, TreeNameDefinition, \
|
|
DictFilter, ContextName, AbstractNameDefinition, AnonymousInstanceParamName
|
|
from jedi.evaluate import context
|
|
from jedi.evaluate.context import NO_CONTEXTS, ContextSet, iterator_to_context_set
|
|
|
|
|
|
def apply_py__get__(context, base_context):
|
|
try:
|
|
method = context.py__get__
|
|
except AttributeError:
|
|
yield context
|
|
else:
|
|
for descriptor_context in method(base_context):
|
|
yield descriptor_context
|
|
|
|
|
|
class ClassName(TreeNameDefinition):
|
|
def __init__(self, parent_context, tree_name, name_context):
|
|
super(ClassName, self).__init__(parent_context, tree_name)
|
|
self._name_context = name_context
|
|
|
|
@iterator_to_context_set
|
|
def infer(self):
|
|
# TODO this _name_to_types might get refactored and be a part of the
|
|
# parent class. Once it is, we can probably just overwrite method to
|
|
# achieve this.
|
|
from jedi.evaluate.syntax_tree import tree_name_to_contexts
|
|
inferred = tree_name_to_contexts(
|
|
self.parent_context.evaluator, self._name_context, self.tree_name)
|
|
|
|
for result_context in inferred:
|
|
for c in apply_py__get__(result_context, self.parent_context):
|
|
yield c
|
|
|
|
|
|
class ClassFilter(ParserTreeFilter):
|
|
name_class = ClassName
|
|
|
|
def _convert_names(self, names):
|
|
return [self.name_class(self.context, name, self._node_context)
|
|
for name in names]
|
|
|
|
|
|
class ClassContext(use_metaclass(CachedMetaClass, context.TreeContext)):
|
|
"""
|
|
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).
|
|
"""
|
|
api_type = 'class'
|
|
|
|
def __init__(self, evaluator, parent_context, classdef):
|
|
super(ClassContext, self).__init__(evaluator, parent_context=parent_context)
|
|
self.tree_node = classdef
|
|
|
|
@evaluator_method_cache(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 lazy_cls in self.py__bases__():
|
|
# TODO there's multiple different mro paths possible if this yields
|
|
# multiple possibilities. Could be changed to be more correct.
|
|
for cls in lazy_cls.infer():
|
|
# 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)
|
|
|
|
@evaluator_method_cache(default=())
|
|
def py__bases__(self):
|
|
arglist = self.tree_node.get_super_arglist()
|
|
if arglist:
|
|
args = param.TreeArguments(self.evaluator, self, arglist)
|
|
return [value for key, value in args.unpack() if key is None]
|
|
else:
|
|
return [context.LazyKnownContext(compiled.create(self.evaluator, object))]
|
|
|
|
def py__call__(self, params):
|
|
from jedi.evaluate.context.instance import TreeInstance
|
|
return ContextSet(TreeInstance(self.evaluator, self.parent_context, self, params))
|
|
|
|
def py__class__(self):
|
|
return compiled.create(self.evaluator, type)
|
|
|
|
def get_params(self):
|
|
from jedi.evaluate.context.instance import AnonymousInstance
|
|
anon = AnonymousInstance(self.evaluator, self.parent_context, self)
|
|
return [AnonymousInstanceParamName(anon, param.name) for param in self.funcdef.get_params()]
|
|
|
|
def get_filters(self, search_global, until_position=None, origin_scope=None, is_instance=False):
|
|
if search_global:
|
|
yield ParserTreeFilter(
|
|
self.evaluator,
|
|
context=self,
|
|
until_position=until_position,
|
|
origin_scope=origin_scope
|
|
)
|
|
else:
|
|
for cls in self.py__mro__():
|
|
if isinstance(cls, compiled.CompiledObject):
|
|
for filter in cls.get_filters(is_instance=is_instance):
|
|
yield filter
|
|
else:
|
|
yield ClassFilter(
|
|
self.evaluator, self, node_context=cls,
|
|
origin_scope=origin_scope)
|
|
|
|
def is_class(self):
|
|
return True
|
|
|
|
def get_function_slot_names(self, name):
|
|
for filter in self.get_filters(search_global=False):
|
|
names = filter.get(name)
|
|
if names:
|
|
return names
|
|
return []
|
|
|
|
def get_param_names(self):
|
|
for name in self.get_function_slot_names('__init__'):
|
|
for context_ in name.infer():
|
|
try:
|
|
method = context_.get_param_names
|
|
except AttributeError:
|
|
pass
|
|
else:
|
|
return list(method())[1:]
|
|
return []
|
|
|
|
@property
|
|
def name(self):
|
|
return ContextName(self, self.tree_node.name)
|
|
|
|
|
|
class ImplicitNSName(AbstractNameDefinition):
|
|
"""
|
|
Accessing names for implicit namespace packages should infer to nothing.
|
|
This object will prevent Jedi from raising exceptions
|
|
"""
|
|
def __init__(self, implicit_ns_context, string_name):
|
|
self.implicit_ns_context = implicit_ns_context
|
|
self.string_name = string_name
|
|
|
|
def infer(self):
|
|
return NO_CONTEXTS
|
|
|
|
def get_root_context(self):
|
|
return self.implicit_ns_context
|
|
|
|
|
|
class ImplicitNamespaceContext(use_metaclass(CachedMetaClass, context.TreeContext)):
|
|
"""
|
|
Provides support for implicit namespace packages
|
|
"""
|
|
api_type = 'module'
|
|
parent_context = None
|
|
|
|
def __init__(self, evaluator, fullname):
|
|
super(ImplicitNamespaceContext, self).__init__(evaluator, parent_context=None)
|
|
self.evaluator = evaluator
|
|
self.fullname = fullname
|
|
|
|
def get_filters(self, search_global, until_position=None, origin_scope=None):
|
|
yield DictFilter(self._sub_modules_dict())
|
|
|
|
@property
|
|
@evaluator_method_cache()
|
|
def name(self):
|
|
string_name = self.py__package__().rpartition('.')[-1]
|
|
return ImplicitNSName(self, string_name)
|
|
|
|
def py__file__(self):
|
|
return None
|
|
|
|
def py__package__(self):
|
|
"""Return the fullname
|
|
"""
|
|
return self.fullname
|
|
|
|
@property
|
|
def py__path__(self):
|
|
return lambda: [self.paths]
|
|
|
|
@evaluator_method_cache()
|
|
def _sub_modules_dict(self):
|
|
names = {}
|
|
|
|
paths = self.paths
|
|
file_names = chain.from_iterable(os.listdir(path) for path in paths)
|
|
mods = [
|
|
file_name.rpartition('.')[0] if '.' in file_name else file_name
|
|
for file_name in file_names
|
|
if file_name != '__pycache__'
|
|
]
|
|
|
|
for name in mods:
|
|
names[name] = imports.SubModuleName(self, name)
|
|
return names
|