import os import json from jedi._compatibility import FileNotFoundError from jedi.api.environment import DefaultEnvironment, \ get_default_environment, from_executable from jedi.api.exceptions import WrongVersion from jedi._compatibility import force_unicode from jedi.evaluate.sys_path import detect_additional_paths from jedi.evaluate.cache import evaluator_as_method_param_cache _CONFIG_FOLDER = '.jedi' _CONTAINS_POTENTIAL_PROJECT = 'setup.py', '.git', '.hg', 'MANIFEST.in' _SERIALIZER_VERSION = 1 class Project(object): _serializer_ignore_attributes = ('_environment',) _environment = None _executable = None @staticmethod def _get_json_path(base_path): return os.path.join(base_path, _CONFIG_FOLDER, 'project.json') @classmethod def load(cls, path): """ :param path: The path of the directory you want to use as a project. """ with open(cls._get_json_path(path)) as f: version, data = json.load(f) if version == 1: self = cls.__new__() self.__dict__.update(data) if self._executable is not None: self._environment = from_executable(self._executable) return self else: raise WrongVersion( "The Jedi version of this project seems newer than what we can handle." ) def __init__(self, path, **kwargs): """ :param path: The base path for this project. :param sys_path: list of str. You can override the sys path if you want. By default the ``sys.path.`` is generated from the environment (virtualenvs, etc). :param smart_sys_path: If this is enabled (default), adds paths from Django, buildout and local directories. Otherwise you will have to rely on your packages being properly configured on the ``sys.path``. """ def py2_comp(path, environment=None, sys_path=None, smart_sys_path=True): self._path = path if isinstance(environment, DefaultEnvironment): self._environment = environment self._executable = environment._executable self._sys_path = sys_path self._smart_sys_path = smart_sys_path py2_comp(path, **kwargs) def _get_base_sys_path(self, environment=None): if self._sys_path is not None: return self._sys_path # The sys path has not been set explicitly. if environment is None: environment = self.get_environment() sys_path = environment.get_sys_path() try: sys_path.remove('') except ValueError: pass return sys_path @evaluator_as_method_param_cache() def _get_sys_path(self, evaluator, environment=None): """ Keep this method private for all users of jedi. However internally this one is used like a public method. """ sys_path = list(self._get_base_sys_path(environment)) if evaluator.script_path is None or not self._smart_sys_path: return sys_path added_paths = map( force_unicode, detect_additional_paths(evaluator, evaluator.script_path) ) return sys_path + list(added_paths) def save(self): data = dict(self.__dict__) for attribute in self._serializer_ignore_attributes: data.pop(attribute, None) with open(self._get_json_path(self._path), 'wb') as f: return json.dump((_SERIALIZER_VERSION, data), f) def get_environment(self): if self._environment is None: return get_default_environment() return self._environment def __repr__(self): return '<%s: %s>' % (self.__class__.__name__, self._path) def _is_potential_project(path): for name in _CONTAINS_POTENTIAL_PROJECT: if os.path.exists(os.path.join(path, name)): return True return False def get_default_project(path=None): if path is None: path = os.getcwd() previous = None curdir = dir = os.path.realpath(path) probable_path = None while dir != previous: try: return Project.load(dir) except FileNotFoundError: pass if probable_path is None and _is_potential_project(dir): probable_path = dir previous = dir dir = os.path.dirname(dir) else: if probable_path is not None: # TODO search for setup.py etc return Project(probable_path) return Project(curdir)