""" For dynamic completion. Sorry to everyone who is reading this code. Especially the array parts are really cryptic and not understandable. It's just a hack, that turned out to be working quite good. """ import re import os import parsing import modules import evaluate import helpers import settings import debug # This is something like the sys.path, but only for searching params. It means # that this is the order in which Jedi searches params. search_param_modules = ['.'] search_param_cache = {} def search_param_memoize(func): """ Is only good for search params memoize, respectively the closure, because it just caches the input, not the func, like normal memoize does. """ def wrapper(*args, **kwargs): key = (args, frozenset(kwargs.items())) if key in search_param_cache: return search_param_cache[key] else: rv = func(*args, **kwargs) search_param_cache[key] = rv return rv return wrapper class ParamListener(object): """ This listener is used to get the params for a function. """ def __init__(self): self.param_possibilities = [] def execute(self, params): self.param_possibilities.append(params) @evaluate.memoize_default([]) def search_params(param): """ This is a dynamic search for params. If you try to complete a type: >>> def func(foo): >>> # here is the completion >>> foo >>> func(1) >>> func("") It is not known what the type is, because it cannot be guessed with recursive madness. Therefore one has to analyse the statements that are calling the function, as well as analyzing the incoming params. """ if not settings.dynamic_params: return [] def get_params_for_module(module): """ Returns the values of a param, or an empty array. """ @search_param_memoize def get_posibilities(module, func_name): try: possible_stmts = module.used_names[func_name] except KeyError: return [] for stmt in possible_stmts: evaluate.follow_statement(stmt) return listener.param_possibilities result = [] for params in get_posibilities(module, func_name): for p in params: if str(p) == param_name: result += evaluate.follow_statement(p.parent()) #print listener.param_possibilities, param, result return result func = param.get_parent_until(parsing.Function) current_module = param.get_parent_until() func_name = str(func.name) if func_name == '__init__' and isinstance(func.parent(), parsing.Class): func_name = str(func.parent().name) # get the param name if param.assignment_details: arr = param.assignment_details[0][1] else: arr = param.get_assignment_calls() offset = 1 if arr[0][0] in ['*', '**'] else 0 param_name = str(arr[0][offset].name) # add the listener listener = ParamListener() func.listeners.add(listener) result = get_params_for_module(current_module) # TODO check other modules # cleanup: remove the listener; important: should not stick. func.listeners.remove(listener) return result def check_array_additions(array): """ Just a mapper function for the internal _check_array_additions """ if array._array.type not in ['list', 'set']: # TODO also check for dict updates return [] is_list = array._array.type == 'list' current_module = array._array.parent_stmt().get_parent_until() res = _check_array_additions(array, current_module, is_list) return res counter = 0 def dec(func): """ TODO delete this """ def wrapper(*args, **kwargs): global counter element = args[0] if isinstance(element, evaluate.Array): stmt = element._array.parent_stmt() else: # must be instance stmt = element.var_args.parent_stmt() print(' ' * counter + 'recursion,', stmt) counter += 1 res = func(*args, **kwargs) counter -= 1 #print ' '*counter + 'end,' return res return wrapper def _scan_array(arr, search_name): """ Returns the function Call that match search_name in an Array. """ result = [] for sub in arr: for s in sub: if isinstance(s, parsing.Array): result += _scan_array(s, search_name) elif isinstance(s, parsing.Call): while s is not None: n = s.name if isinstance(n, parsing.Name) and search_name in n.names: result.append(s) if s.execution is not None: result += _scan_array(s.execution, search_name) s = s.next return result #@dec @evaluate.memoize_default([]) def _check_array_additions(compare_array, module, is_list): """ Checks if a `parsing.Array` has "add" statements: >>> a = [""] >>> a.append(1) """ if not settings.dynamic_array_additions or module.is_builtin(): return [] def check_calls(calls, add_name): """ Calls are processed here. The part before the call is searched and compared with the original Array. """ result = [] for c in calls: call_path = list(c.generate_call_path()) separate_index = call_path.index(add_name) if not len(call_path) > separate_index + 1: # this means that there is no execution -> [].append continue backtrack_path = iter(call_path[:separate_index]) position = c.parent_stmt().start_pos scope = c.parent_stmt().parent() found = evaluate.follow_call_path(backtrack_path, scope, position) if not compare_array in found: continue params = call_path[separate_index + 1] if not params.values: continue # no params: just ignore it if add_name in ['append', 'add']: result += evaluate.follow_call_list(params) elif add_name in ['insert']: try: second_param = params[1] except IndexError: continue else: result += evaluate.follow_call_list([second_param]) elif add_name in ['extend', 'update']: iterators = evaluate.follow_call_list(params) result += evaluate.get_iterator_types(iterators) return result def get_execution_parent(element, *stop_classes): """ Used to get an Instance/Execution parent """ if isinstance(element, evaluate.Array): stmt = element._array.parent_stmt() else: # must be instance stmt = element.var_args.parent_stmt() if isinstance(stmt, evaluate.InstanceElement): stop_classes = list(stop_classes) + [evaluate.Function] return stmt.get_parent_until(stop_classes) search_names = ['append', 'extend', 'insert'] if is_list else \ ['add', 'update'] comp_arr_parent = get_execution_parent(compare_array, evaluate.Execution) possible_stmts = [] res = [] for n in search_names: try: possible_stmts += module.used_names[n] except KeyError: continue for stmt in possible_stmts: # Check if the original scope is an execution. If it is, one # can search for the same statement, that is in the module # dict. Executions are somewhat special in jedi, since they # literally copy the contents of a function. if isinstance(comp_arr_parent, evaluate.Execution): stmt = comp_arr_parent. \ get_statement_for_position(stmt.start_pos) if stmt is None: continue # InstanceElements are special, because they don't get copied, # but have this wrapper around them. if isinstance(comp_arr_parent, evaluate.InstanceElement): stmt = evaluate.InstanceElement(comp_arr_parent.instance, stmt) if evaluate.follow_statement.push_stmt(stmt): # check recursion continue res += check_calls(_scan_array(stmt.get_assignment_calls(), n), n) evaluate.follow_statement.pop_stmt() return res def check_array_instances(instance): """ Used for set() and list() instances. """ if not settings.dynamic_arrays_instances: return instance.var_args ai = ArrayInstance(instance) return helpers.generate_param_array([ai], instance.var_args.parent_stmt()) class ArrayInstance(parsing.Base): """ Used for the usage of set() and list(). This is definitely a hack, but a good one :-) It makes it possible to use set/list conversions. """ def __init__(self, instance): self.instance = instance self.var_args = instance.var_args def iter_content(self): """ The index is here just ignored, because of all the appends, etc. lists/sets are too complicated too handle that. """ items = [] for array in evaluate.follow_call_list(self.var_args): if isinstance(array, evaluate.Instance) and len(array.var_args): temp = array.var_args[0][0] if isinstance(temp, ArrayInstance): # prevent recursions # TODO compare Modules if self.var_args.start_pos != temp.var_args.start_pos: items += temp.iter_content() else: debug.warning('ArrayInstance recursion', self.var_args) continue items += evaluate.get_iterator_types([array]) module = self.var_args.parent_stmt().get_parent_until() is_list = str(self.instance.name) == 'list' items += _check_array_additions(self.instance, module, is_list) return items def related_names(definitions, search_name, modules): def check_call(call): result = [] follow = [] # There might be multiple search_name's in one call_path call_path = list(call.generate_call_path()) for i, name in enumerate(call_path): if name == search_name: follow.append(call_path[:i + 1]) for f in follow: scope = call.parent_stmt().parent() evaluate.statement_path = [] position = call.parent_stmt().start_pos if len(f) > 1: f, search = f[:-1], f[-1] else: search = None scopes = evaluate.follow_call_path(iter(f), scope, position) follow_res = evaluate.goto(scopes, search, statement_path_offset=0) # compare to see if they match if True in [r in definitions for r in follow_res]: l = f[-1] # the NamePart object scope = call.parent_stmt() result.append(RelatedName(l, scope)) return result names = [] # TODO check modules in the same directoy for m in modules: if not m.path.endswith('.py'): # don't search for names in builtin modules continue try: stmts = m.used_names[search_name] except KeyError: continue #TODO check heritage of statements for stmt in stmts: for call in _scan_array(stmt.get_assignment_calls(), search_name): names += check_call(call) return names class BaseOutput(object): def __init__(self, start_pos, definition): self.module_path = str(definition.get_parent_until().path) self.start_pos = start_pos self.definition = definition @property def module_name(self): path = self.module_path sep = os.path.sep p = re.sub(r'^.*?([\w\d]+)(%s__init__)?.py$' % sep, r'\1', path) return p def in_builtin_module(self): return not self.module_path.endswith('.py') @property def line_nr(self): return self.start_pos[0] @property def column(self): return self.start_pos[1] @property def description(self): raise NotImplementedError('Base Class') def __repr__(self): return "<%s %s>" % (self.__class__.__name__, self.description) class RelatedName(BaseOutput): def __init__(self, name_part, scope): super(RelatedName, self).__init__(name_part.start_pos, scope) self.text = str(name_part) self.end_pos = name_part.end_pos @property def description(self): return "%s@%s,%s" % (self.text, self.start_pos[0], self.start_pos[1])