Source code for jedi.api.project

Projects are a way to handle Python projects within Jedi. For simpler plugins
you might not want to deal with projects, but if you want to give the user more
flexibility to define sys paths and Python interpreters for a project,
:class:`.Project` is the perfect way to allow for that.

Projects can be saved to disk and loaded again, to allow project definitions to
be used across repositories.
import json
from pathlib import Path
from itertools import chain

from jedi import debug
from jedi.api.environment import get_cached_default_environment, create_environment
from jedi.api.exceptions import WrongVersion
from jedi.api.completion import search_in_module
from jedi.api.helpers import split_search_string, get_module_names
from jedi.inference.imports import load_module_from_path, \
    load_namespace_from_path, iter_module_names
from jedi.inference.sys_path import discover_buildout_paths
from jedi.inference.cache import inference_state_as_method_param_cache
from jedi.inference.references import recurse_find_python_folders_and_files, search_in_file_ios
from jedi.file_io import FolderIO

_CONFIG_FOLDER = '.jedi'
    '', '.git', '.hg', 'requirements.txt', '', 'pyproject.toml'


def _try_to_skip_duplicates(func):
    def wrapper(*args, **kwargs):
        found_tree_nodes = []
        found_modules = []
        for definition in func(*args, **kwargs):
            tree_node = definition._name.tree_name
            if tree_node is not None and tree_node in found_tree_nodes:
            if definition.type == 'module' and definition.module_path is not None:
                if definition.module_path in found_modules:
            yield definition
    return wrapper

def _remove_duplicates_from_path(path):
    used = set()
    for p in path:
        if p in used:
        yield p

[docs]class Project: """ Projects are a simple way to manage Python folders and define how Jedi does import resolution. It is mostly used as a parameter to :class:`.Script`. Additionally there are functions to search a whole project. """ _environment = None @staticmethod def _get_config_folder_path(base_path): return base_path.joinpath(_CONFIG_FOLDER) @staticmethod def _get_json_path(base_path): return Project._get_config_folder_path(base_path).joinpath('project.json')
[docs] @classmethod def load(cls, path): """ Loads a project from a specific path. You should not provide the path to ``.jedi/project.json``, but rather the path to the project folder. :param path: The path of the directory you want to use as a project. """ if isinstance(path, str): path = Path(path) with open(cls._get_json_path(path)) as f: version, data = json.load(f) if version == 1: return cls(**data) else: raise WrongVersion( "The Jedi version of this project seems newer than what we can handle." )
[docs] def save(self): """ Saves the project configuration in the project in ``.jedi/project.json``. """ data = dict(self.__dict__) data.pop('_environment', None) data.pop('_django', None) # TODO make django setting public? data = {k.lstrip('_'): v for k, v in data.items()} data['path'] = str(data['path']) self._get_config_folder_path(self._path).mkdir(parents=True, exist_ok=True) with open(self._get_json_path(self._path), 'w') as f: return json.dump((_SERIALIZER_VERSION, data), f)
def __init__(self, path, **kwargs): """ :param path: The base path for this project. :param environment_path: The Python executable path, typically the path of a virtual environment. :param load_unsafe_extensions: Default False, Loads extensions that are not in the sys path and in the local directories. With this option enabled, this is potentially unsafe if you clone a git repository and analyze it's code, because those compiled extensions will be important and therefore have execution privileges. :param sys_path: list of str. You can override the sys path if you want. By default the ``sys.path.`` is generated by the environment (virtualenvs, etc). :param added_sys_path: list of str. Adds these paths at the end of the sys path. :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_path=None, load_unsafe_extensions=False, sys_path=None, added_sys_path=(), smart_sys_path=True): if isinstance(path, str): path = Path(path).absolute() self._path = path self._environment_path = environment_path if sys_path is not None: # Remap potential pathlib.Path entries sys_path = list(map(str, sys_path)) self._sys_path = sys_path self._smart_sys_path = smart_sys_path self._load_unsafe_extensions = load_unsafe_extensions self._django = False # Remap potential pathlib.Path entries self.added_sys_path = list(map(str, added_sys_path)) """The sys path that is going to be added at the end of the """ py2_comp(path, **kwargs) @property def path(self): """ The base path for this project. """ return self._path @property def sys_path(self): """ The sys path provided to this project. This can be None and in that case will be auto generated. """ return self._sys_path @property def smart_sys_path(self): """ If the sys path is going to be calculated in a smart way, where additional paths are added. """ return self._smart_sys_path @property def load_unsafe_extensions(self): """ Wheter the project loads unsafe extensions. """ return self._load_unsafe_extensions @inference_state_as_method_param_cache() def _get_base_sys_path(self, inference_state): # The sys path has not been set explicitly. sys_path = list(inference_state.environment.get_sys_path()) try: sys_path.remove('') except ValueError: pass return sys_path @inference_state_as_method_param_cache() def _get_sys_path(self, inference_state, add_parent_paths=True, add_init_paths=False): """ Keep this method private for all users of jedi. However internally this one is used like a public method. """ suffixed = list(self.added_sys_path) prefixed = [] if self._sys_path is None: sys_path = list(self._get_base_sys_path(inference_state)) else: sys_path = list(self._sys_path) if self._smart_sys_path: prefixed.append(str(self._path)) if inference_state.script_path is not None: suffixed += map(str, discover_buildout_paths( inference_state, inference_state.script_path )) if add_parent_paths: # Collect directories in upward search by: # 1. Skipping directories with # 2. Stopping immediately when above self._path traversed = [] for parent_path in inference_state.script_path.parents: if parent_path == self._path \ or self._path not in parent_path.parents: break if not add_init_paths \ and parent_path.joinpath("").is_file(): continue traversed.append(str(parent_path)) # AFAIK some libraries have imports like ``, 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(str(self._path)) path = prefixed + sys_path + suffixed return list(_remove_duplicates_from_path(path)) def get_environment(self): if self._environment is None: if self._environment_path is not None: self._environment = create_environment(self._environment_path, safe=False) else: self._environment = get_cached_default_environment() return self._environment
[docs] def search(self, string, *, all_scopes=False): """ Searches a name in the whole project. If the project is very big, at some point Jedi will stop searching. However it's also very much recommended to not exhaust the generator. Just display the first ten results to the user. There are currently three different search patterns: - ``foo`` to search for a definition foo in any file or a file called ```` or ``foo.pyi``. - ```` to search for the ``foo`` and then an attribute ``bar`` in it. - ``class`` or ``def`` to search for a specific API type. :param bool all_scopes: Default False; searches not only for definitions on the top level of a module level, but also in functions and classes. :yields: :class:`.Name` """ return self._search_func(string, all_scopes=all_scopes)
@_try_to_skip_duplicates def _search_func(self, string, complete=False, all_scopes=False): # Using a Script is they easiest way to get an empty module context. from jedi import Script s = Script('', project=self) inference_state = s._inference_state empty_module_context = s._get_module_context() debug.dbg('Search for string %s, complete=%s', string, complete) wanted_type, wanted_names = split_search_string(string) name = wanted_names[0] stub_folder_name = name + '-stubs' ios = recurse_find_python_folders_and_files(FolderIO(str(self._path))) file_ios = [] # 1. Search for modules in the current project for folder_io, file_io in ios: if file_io is None: file_name = folder_io.get_base_name() if file_name == name or file_name == stub_folder_name: f = folder_io.get_file_io('') try: m = load_module_from_path(inference_state, f).as_context() except FileNotFoundError: f = folder_io.get_file_io('__init__.pyi') try: m = load_module_from_path(inference_state, f).as_context() except FileNotFoundError: m = load_namespace_from_path(inference_state, folder_io).as_context() else: continue else: file_ios.append(file_io) if Path(file_io.path).name in (name + '.py', name + '.pyi'): m = load_module_from_path(inference_state, file_io).as_context() else: continue debug.dbg('Search of a specific module %s', m) yield from search_in_module( inference_state, m, names=[], wanted_type=wanted_type, wanted_names=wanted_names, complete=complete, convert=True, ignore_imports=True, ) # 2. Search for identifiers in the project. for module_context in search_in_file_ios(inference_state, file_ios, name): names = get_module_names(module_context.tree_node, all_scopes=all_scopes) names = [module_context.create_name(n) for n in names] names = _remove_imports(names) yield from search_in_module( inference_state, module_context, names=names, wanted_type=wanted_type, wanted_names=wanted_names, complete=complete, ignore_imports=True, ) # 3. Search for modules on sys.path sys_path = [ p for p in self._get_sys_path(inference_state) # Exclude folders that are handled by recursing of the Python # folders. if not p.startswith(str(self._path)) ] names = list(iter_module_names(inference_state, empty_module_context, sys_path)) yield from search_in_module( inference_state, empty_module_context, names=names, wanted_type=wanted_type, wanted_names=wanted_names, complete=complete, convert=True, ) def __repr__(self): return '<%s: %s>' % (self.__class__.__name__, self._path)
def _is_potential_project(path): for name in _CONTAINS_POTENTIAL_PROJECT: if path.joinpath(name).exists(): return True return False def _is_django_path(directory): """ Detects the path of the very well known Django library (if used) """ try: with open(directory.joinpath(''), 'rb') as f: return b"DJANGO_SETTINGS_MODULE" in except (FileNotFoundError, IsADirectoryError, PermissionError): return False
[docs]def get_default_project(path=None): """ If a project is not defined by the user, Jedi tries to define a project by itself as well as possible. Jedi traverses folders until it finds one of the following: 1. A ``.jedi/config.json`` 2. One of the following files: ````, ``.git``, ``.hg``, ``requirements.txt`` and ````. """ if path is None: path = Path.cwd() elif isinstance(path, str): path = Path(path) check = path.absolute() probable_path = None first_no_init_file = None for dir in chain([check], check.parents): try: return Project.load(dir) except (FileNotFoundError, IsADirectoryError, PermissionError): pass except NotADirectoryError: continue if first_no_init_file is None: if dir.joinpath('').exists(): # In the case that a exists, it's in 99% just a # Python package and the project sits at least one level above. continue elif not dir.is_file(): first_no_init_file = dir if _is_django_path(dir): project = Project(dir) project._django = True return project if probable_path is None and _is_potential_project(dir): probable_path = dir if probable_path is not None: # TODO search for etc return Project(probable_path) if first_no_init_file is not None: return Project(first_no_init_file) curdir = path if path.is_dir() else path.parent return Project(curdir)
def _remove_imports(names): return [ n for n in names if n.tree_name is None or n.api_type != 'module' ]