You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
196 lines
6.1 KiB
196 lines
6.1 KiB
import os
|
|
import json
|
|
|
|
from jedi._compatibility import FileNotFoundError, NotADirectoryError, PermissionError
|
|
from jedi.api.environment import SameEnvironment, \
|
|
get_cached_default_environment
|
|
from jedi.api.exceptions import WrongVersion
|
|
from jedi._compatibility import force_unicode
|
|
from jedi.evaluate.sys_path import discover_buildout_paths
|
|
from jedi.evaluate.cache import evaluator_as_method_param_cache
|
|
from jedi.common.utils import traverse_parents
|
|
|
|
_CONFIG_FOLDER = '.jedi'
|
|
_CONTAINS_POTENTIAL_PROJECT = 'setup.py', '.git', '.hg', 'requirements.txt', 'MANIFEST.in'
|
|
|
|
_SERIALIZER_VERSION = 1
|
|
|
|
|
|
def _remove_duplicates_from_path(path):
|
|
used = set()
|
|
for p in path:
|
|
if p in used:
|
|
continue
|
|
used.add(p)
|
|
yield p
|
|
|
|
|
|
def _force_unicode_list(lst):
|
|
return list(map(force_unicode, lst))
|
|
|
|
|
|
class Project(object):
|
|
# TODO serialize environment
|
|
_serializer_ignore_attributes = ('_environment',)
|
|
_environment = 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)
|
|
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
|
|
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, _django=False):
|
|
self._path = path
|
|
if isinstance(environment, SameEnvironment):
|
|
self._environment = environment
|
|
|
|
self._sys_path = sys_path
|
|
self._smart_sys_path = smart_sys_path
|
|
self._django = _django
|
|
|
|
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 = list(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.
|
|
"""
|
|
suffixed = []
|
|
prefixed = []
|
|
|
|
sys_path = list(self._get_base_sys_path(environment))
|
|
if self._smart_sys_path:
|
|
prefixed.append(self._path)
|
|
|
|
if evaluator.script_path is not None:
|
|
suffixed += discover_buildout_paths(evaluator, evaluator.script_path)
|
|
|
|
traversed = list(traverse_parents(evaluator.script_path))
|
|
|
|
# AFAIK some libraries have imports like `foo.foo.bar`, which
|
|
# leads to the conclusion to by default prefer longer paths
|
|
# rather than shorter ones by default.
|
|
suffixed += reversed(traversed)
|
|
|
|
if self._django:
|
|
prefixed.append(self._path)
|
|
|
|
path = prefixed + sys_path + suffixed
|
|
return list(_force_unicode_list(_remove_duplicates_from_path(path)))
|
|
|
|
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_cached_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 _is_django_path(directory):
|
|
""" Detects the path of the very well known Django library (if used) """
|
|
try:
|
|
with open(os.path.join(directory, 'manage.py'), 'rb') as f:
|
|
return b"DJANGO_SETTINGS_MODULE" in f.read()
|
|
except (FileNotFoundError, NotADirectoryError, PermissionError):
|
|
return False
|
|
|
|
return False
|
|
|
|
|
|
def get_default_project(path=None):
|
|
if path is None:
|
|
path = os.getcwd()
|
|
|
|
check = os.path.realpath(path)
|
|
probable_path = None
|
|
first_no_init_file = None
|
|
for dir in traverse_parents(check, include_current=True):
|
|
try:
|
|
return Project.load(dir)
|
|
except (FileNotFoundError, NotADirectoryError, PermissionError):
|
|
pass
|
|
|
|
if first_no_init_file is None:
|
|
if os.path.exists(os.path.join(dir, '__init__.py')):
|
|
# In the case that a __init__.py exists, it's in 99% just a
|
|
# Python package and the project sits at least one level above.
|
|
continue
|
|
else:
|
|
first_no_init_file = dir
|
|
|
|
if _is_django_path(dir):
|
|
return Project(dir, _django=True)
|
|
|
|
if probable_path is None and _is_potential_project(dir):
|
|
probable_path = dir
|
|
|
|
if probable_path is not None:
|
|
# TODO search for setup.py etc
|
|
return Project(probable_path)
|
|
|
|
if first_no_init_file is not None:
|
|
return Project(first_no_init_file)
|
|
|
|
curdir = path if os.path.isdir(path) else os.path.dirname(path)
|
|
return Project(curdir)
|