Trying to make the cache path configurable as a parameter.

This commit is contained in:
Dave Halter
2017-05-15 11:12:28 -04:00
parent fb05fb4c19
commit be782a0141
3 changed files with 48 additions and 28 deletions

View File

@@ -3,9 +3,8 @@ import shutil
import pytest import pytest
import jedi
collect_ignore = ["setup.py"] #collect_ignore = ["setup.py"]
# The following hooks (pytest_configure, pytest_unconfigure) are used # The following hooks (pytest_configure, pytest_unconfigure) are used

View File

@@ -9,7 +9,6 @@ import platform
import errno import errno
import logging import logging
from jedi import settings
from parso._compatibility import FileNotFoundError from parso._compatibility import FileNotFoundError
@@ -40,6 +39,25 @@ we generate something similar. See:
http://docs.python.org/3/library/sys.html#sys.implementation http://docs.python.org/3/library/sys.html#sys.implementation
""" """
def _get_default_cache_path():
if platform.system().lower() == 'windows':
dir_ = os.path.join(os.getenv('APPDATA') or '~', 'Parso', 'Parso')
elif platform.system().lower() == 'darwin':
dir_ = os.path.join('~', 'Library', 'Caches', 'Parso')
else:
dir_ = os.path.join(os.getenv('XDG_CACHE_HOME') or '~/.cache', 'parso')
return os.path.expanduser(dir_)
_default_cache_path = _get_default_cache_path()
"""
The path where the cache is stored.
On Linux, this defaults to ``~/.cache/parso/``, on OS X to
``~/Library/Caches/Parso/`` and on Windows to ``%APPDATA%\\Parso\\Parso\\``.
On Linux, if environment variable ``$XDG_CACHE_HOME`` is set,
``$XDG_CACHE_HOME/parso`` is used instead of the default one.
"""
# for fast_parser, should not be deleted # for fast_parser, should not be deleted
parser_cache = {} parser_cache = {}
@@ -54,7 +72,7 @@ class _NodeCacheItem(object):
self.change_time = change_time self.change_time = change_time
def load_module(grammar, path): def load_module(grammar, path, cache_path=None):
""" """
Returns a module or None, if it fails. Returns a module or None, if it fails.
""" """
@@ -69,14 +87,11 @@ def load_module(grammar, path):
if p_time <= module_cache_item.change_time: if p_time <= module_cache_item.change_time:
return module_cache_item.node return module_cache_item.node
except KeyError: except KeyError:
if not settings.use_filesystem_cache: return _load_from_file_system(grammar, path, p_time, cache_path=cache_path)
return None
return _load_from_file_system(grammar, path, p_time)
def _load_from_file_system(grammar, path, p_time): def _load_from_file_system(grammar, path, p_time, cache_path=None):
cache_path = _get_hashed_path(grammar, path) cache_path = _get_hashed_path(grammar, path, cache_path=cache_path)
try: try:
try: try:
if p_time > os.path.getmtime(cache_path): if p_time > os.path.getmtime(cache_path):
@@ -103,7 +118,7 @@ def _load_from_file_system(grammar, path, p_time):
return module_cache_item.node return module_cache_item.node
def save_module(grammar, path, module, lines, pickling=True): def save_module(grammar, path, module, lines, pickling=True, cache_path=None):
try: try:
p_time = None if path is None else os.path.getmtime(path) p_time = None if path is None else os.path.getmtime(path)
except OSError: except OSError:
@@ -112,13 +127,9 @@ def save_module(grammar, path, module, lines, pickling=True):
item = _NodeCacheItem(module, lines, p_time) item = _NodeCacheItem(module, lines, p_time)
parser_cache[path] = item parser_cache[path] = item
if settings.use_filesystem_cache and pickling and path is not None: if pickling and path is not None:
_save_to_file_system(grammar, path, item) with open(_get_hashed_path(grammar, path, cache_path=cache_path), 'wb') as f:
pickle.dump(item, f, pickle.HIGHEST_PROTOCOL)
def _save_to_file_system(grammar, path, item):
with open(_get_hashed_path(grammar, path), 'wb') as f:
pickle.dump(item, f, pickle.HIGHEST_PROTOCOL)
def remove_old_modules(self): def remove_old_modules(self):
@@ -129,19 +140,23 @@ def remove_old_modules(self):
""" """
def clear_cache(self): def clear_cache(cache_path=None):
shutil.rmtree(settings.cache_directory) if cache_path is None:
cache_path = _default_cache_path
shutil.rmtree(cache_path)
parser_cache.clear() parser_cache.clear()
def _get_hashed_path(grammar, path): def _get_hashed_path(grammar, path, cache_path=None):
file_hash = hashlib.sha256(path.encode("utf-8")).hexdigest() file_hash = hashlib.sha256(path.encode("utf-8")).hexdigest()
directory = _get_cache_directory_path() directory = _get_cache_directory_path()
return os.path.join(directory, '%s-%s.pkl' % (grammar.sha256, file_hash)) return os.path.join(directory, '%s-%s.pkl' % (grammar.sha256, file_hash))
def _get_cache_directory_path(): def _get_cache_directory_path(cache_path=None):
directory = os.path.join(settings.cache_directory, _VERSION_TAG) if cache_path is None:
cache_path = _default_cache_path
directory = os.path.join(cache_path, _VERSION_TAG)
if not os.path.exists(directory): if not os.path.exists(directory):
os.makedirs(directory) os.makedirs(directory)
return directory return directory

View File

@@ -48,7 +48,8 @@ def load_grammar(version=None):
def parse(code=None, path=None, grammar=None, error_recovery=True, def parse(code=None, path=None, grammar=None, error_recovery=True,
start_symbol='file_input', cache=False, diff_cache=False): start_symbol='file_input', cache=False, diff_cache=False,
cache_path=None):
""" """
If you want to parse a Python file you want to start here, most likely. If you want to parse a Python file you want to start here, most likely.
@@ -64,6 +65,8 @@ def parse(code=None, path=None, grammar=None, error_recovery=True,
get a ParseError when encountering syntax errors in your code. get a ParseError when encountering syntax errors in your code.
:param start_symbol: The grammar symbol that you want to parse. Only :param start_symbol: The grammar symbol that you want to parse. Only
allowed to be used when error_recovery is disabled. allowed to be used when error_recovery is disabled.
:param cache_path: If given saves the parso cache in this directory. If not
given, defaults to the default cache places on each platform.
:return: A syntax tree node. Typically the module. :return: A syntax tree node. Typically the module.
""" """
@@ -75,7 +78,7 @@ def parse(code=None, path=None, grammar=None, error_recovery=True,
if cache and not code and path is not None: if cache and not code and path is not None:
# In this case we do actual caching. We just try to load it. # In this case we do actual caching. We just try to load it.
module_node = load_module(grammar, path) module_node = load_module(grammar, path, cache_path=cache_path)
if module_node is not None: if module_node is not None:
return module_node return module_node
@@ -93,14 +96,16 @@ def parse(code=None, path=None, grammar=None, error_recovery=True,
module_node = module_cache_item.node module_node = module_cache_item.node
old_lines = module_cache_item.lines old_lines = module_cache_item.lines
if old_lines == lines: if old_lines == lines:
save_module(grammar, path, module_node, lines, pickling=False) save_module(grammar, path, module_node, lines, pickling=False,
cache_path=cache_path)
return module_node return module_node
new_node = DiffParser(grammar, module_node).update( new_node = DiffParser(grammar, module_node).update(
old_lines=old_lines, old_lines=old_lines,
new_lines=lines new_lines=lines
) )
save_module(grammar, path, new_node, lines, pickling=cache) save_module(grammar, path, new_node, lines, pickling=cache,
cache_path=cache_path)
return new_node return new_node
added_newline = not code.endswith('\n') added_newline = not code.endswith('\n')
@@ -119,5 +124,6 @@ def parse(code=None, path=None, grammar=None, error_recovery=True,
_remove_last_newline(root_node) _remove_last_newline(root_node)
if cache or diff_cache: if cache or diff_cache:
save_module(grammar, path, root_node, lines, pickling=cache) save_module(grammar, path, root_node, lines, pickling=cache,
cache_path=cache_path)
return root_node return root_node