""" Used only for REPL Completion. """ import inspect import os import sys from jedi.parser_utils import get_cached_code_lines from jedi import settings from jedi.inference import compiled from jedi.cache import underscore_memoization from jedi.file_io import FileIO from jedi.inference.base_value import ValueSet, ValueWrapper from jedi.inference.helpers import SimpleGetItemNotFound from jedi.inference.value import ModuleValue from jedi.inference.cache import inference_state_function_cache from jedi.inference.compiled.getattr_static import getattr_static from jedi.inference.compiled.access import compiled_objects_cache, \ ALLOWED_GETITEM_TYPES, get_api_type from jedi.inference.compiled.value import create_cached_compiled_object from jedi.inference.gradual.conversion import to_stub _sentinel = object() class MixedObject(ValueWrapper): """ A ``MixedObject`` is used in two ways: 1. It uses the default logic of ``parser.python.tree`` objects, 2. except for getattr calls. The names dicts are generated in a fashion like ``CompiledObject``. This combined logic makes it possible to provide more powerful REPL completion. It allows side effects that are not noticable with the default parser structure to still be completeable. The biggest difference from CompiledObject to MixedObject is that we are generally dealing with Python code and not with C code. This will generate fewer special cases, because we in Python you don't have the same freedoms to modify the runtime. """ def __init__(self, compiled_object, tree_value): super(MixedObject, self).__init__(tree_value) self.compiled_object = compiled_object self.access_handle = compiled_object.access_handle def get_filters(self, *args, **kwargs): yield MixedObjectFilter(self.inference_state, self) def get_signatures(self): # Prefer `inspect.signature` over somehow analyzing Python code. It # should be very precise, especially for stuff like `partial`. return self.compiled_object.get_signatures() def py__call__(self, arguments): return (to_stub(self._wrapped_value) or self._wrapped_value).py__call__(arguments) def get_safe_value(self, default=_sentinel): if default is _sentinel: return self.compiled_object.get_safe_value() else: return self.compiled_object.get_safe_value(default) def py__simple_getitem__(self, index): python_object = self.compiled_object.access_handle.access._obj if type(python_object) in ALLOWED_GETITEM_TYPES: return self.compiled_object.py__simple_getitem__(index) raise SimpleGetItemNotFound def __repr__(self): return '<%s: %s>' % ( type(self).__name__, self.access_handle.get_repr() ) class MixedName(compiled.CompiledName): """ The ``CompiledName._compiled_object`` is our MixedObject. """ @property def start_pos(self): values = list(self.infer()) if not values: # This means a start_pos that doesn't exist (compiled objects). return 0, 0 return values[0].name.start_pos @start_pos.setter def start_pos(self, value): # Ignore the __init__'s start_pos setter call. pass @underscore_memoization def infer(self): # TODO use logic from compiled.CompiledObjectFilter access_paths = self.parent_context.access_handle.getattr_paths( self.string_name, default=None ) assert len(access_paths) values = [None] for access in access_paths: values = ValueSet.from_sets( _create(self._inference_state, access, parent_context=c) if c is None or isinstance(c, MixedObject) else ValueSet({create_cached_compiled_object(c.inference_state, access, c)}) for c in values ) return values @property def api_type(self): return next(iter(self.infer())).api_type class MixedObjectFilter(compiled.CompiledObjectFilter): name_class = MixedName @inference_state_function_cache() def _load_module(inference_state, path): module_node = inference_state.parse( path=path, cache=True, diff_cache=settings.fast_parser, cache_path=settings.cache_directory ).get_root_node() # python_module = inspect.getmodule(python_object) # TODO we should actually make something like this possible. #inference_state.modules[python_module.__name__] = module_node return module_node def _get_object_to_check(python_object): """Check if inspect.getfile has a chance to find the source.""" if sys.version_info[0] > 2: python_object = inspect.unwrap(python_object) if (inspect.ismodule(python_object) or inspect.isclass(python_object) or inspect.ismethod(python_object) or inspect.isfunction(python_object) or inspect.istraceback(python_object) or inspect.isframe(python_object) or inspect.iscode(python_object)): return python_object try: return python_object.__class__ except AttributeError: raise TypeError # Prevents computation of `repr` within inspect. def _find_syntax_node_name(inference_state, python_object): original_object = python_object try: python_object = _get_object_to_check(python_object) path = inspect.getsourcefile(python_object) except TypeError: # The type might not be known (e.g. class_with_dict.__weakref__) return None if path is None or not os.path.exists(path): # The path might not exist or be e.g. . return None file_io = FileIO(path) module_node = _load_module(inference_state, path) if inspect.ismodule(python_object): # We don't need to check names for modules, because there's not really # a way to write a module in a module in Python (and also __name__ can # be something like ``email.utils``). code_lines = get_cached_code_lines(inference_state.grammar, path) return module_node, module_node, file_io, code_lines try: name_str = python_object.__name__ except AttributeError: # Stuff like python_function.__code__. return None if name_str == '': return None # It's too hard to find lambdas. # Doesn't always work (e.g. os.stat_result) names = module_node.get_used_names().get(name_str, []) # Only functions and classes are relevant. If a name e.g. points to an # import, it's probably a builtin (like collections.deque) and needs to be # ignored. names = [ n for n in names if n.parent.type in ('funcdef', 'classdef') and n.parent.name == n ] if not names: return None try: code = python_object.__code__ # By using the line number of a code object we make the lookup in a # file pretty easy. There's still a possibility of people defining # stuff like ``a = 3; foo(a); a = 4`` on the same line, but if people # do so we just don't care. line_nr = code.co_firstlineno except AttributeError: pass else: line_names = [name for name in names if name.start_pos[0] == line_nr] # There's a chance that the object is not available anymore, because # the code has changed in the background. if line_names: names = line_names code_lines = get_cached_code_lines(inference_state.grammar, path) # It's really hard to actually get the right definition, here as a last # resort we just return the last one. This chance might lead to odd # completions at some points but will lead to mostly correct type # inference, because people tend to define a public name in a module only # once. tree_node = names[-1].parent if tree_node.type == 'funcdef' and get_api_type(original_object) == 'instance': # If an instance is given and we're landing on a function (e.g. # partial in 3.5), something is completely wrong and we should not # return that. return None return module_node, tree_node, file_io, code_lines @compiled_objects_cache('mixed_cache') def _create(inference_state, access_handle, parent_context, *args): compiled_object = create_cached_compiled_object( inference_state, access_handle, parent_context=parent_context and parent_context.compiled_object ) # TODO accessing this is bad, but it probably doesn't matter that much, # because we're working with interpreteters only here. python_object = access_handle.access._obj result = _find_syntax_node_name(inference_state, python_object) if result is None: # TODO Care about generics from stuff like `[1]` and don't return like this. if type(python_object) in (dict, list, tuple): return ValueSet({compiled_object}) tree_values = to_stub(compiled_object) if not tree_values: return ValueSet({compiled_object}) else: module_node, tree_node, file_io, code_lines = result if parent_context is None: # TODO this __name__ is probably wrong. name = compiled_object.get_root_context().py__name__() string_names = tuple(name.split('.')) module_context = ModuleValue( inference_state, module_node, file_io=file_io, string_names=string_names, code_lines=code_lines, is_package=hasattr(compiled_object, 'py__path__'), ).as_context() if name is not None: inference_state.module_cache.add(string_names, ValueSet([module_context])) else: if parent_context.tree_node.get_root_node() != module_node: # This happens e.g. when __module__ is wrong, or when using # TypeVar('foo'), where Jedi uses 'foo' as the name and # Python's TypeVar('foo').__module__ will be typing. return ValueSet({compiled_object}) module_context = parent_context.get_root_context() tree_values = ValueSet({ module_context.create_context( tree_node, node_is_value=True, node_is_object=True ) }) if tree_node.type == 'classdef': if not access_handle.is_class(): # Is an instance, not a class. tree_values = tree_values.execute_with_values() return ValueSet( MixedObject(compiled_object, tree_value=tree_value) for tree_value in tree_values )