From c7eb53317b4535cabd50d817964ca7e4644cdcf9 Mon Sep 17 00:00:00 2001 From: Ronny Pfannschmidt Date: Sun, 17 Jun 2018 16:23:44 +0200 Subject: [PATCH] port cache plugin internals to pathlib warning logging got broken by detanglement from config --- setup.py | 4 +- src/_pytest/cacheprovider.py | 101 ++++++++++++++++------------------ src/_pytest/compat.py | 3 + testing/test_cacheprovider.py | 4 +- 4 files changed, 57 insertions(+), 55 deletions(-) diff --git a/setup.py b/setup.py index e799d53bf..ed5a96d5e 100644 --- a/setup.py +++ b/setup.py @@ -73,15 +73,17 @@ def main(): environment_marker_support_level = get_environment_marker_support_level() if environment_marker_support_level >= 2: install_requires.append('funcsigs;python_version<"3.0"') + install_requires.append('pathlib2;python_version<"3.0"') install_requires.append('colorama;sys_platform=="win32"') elif environment_marker_support_level == 1: - extras_require[':python_version<"3.0"'] = ["funcsigs"] + extras_require[':python_version<"3.0"'] = ["funcsigs", "pathlib2"] extras_require[':sys_platform=="win32"'] = ["colorama"] else: if sys.platform == "win32": install_requires.append("colorama") if sys.version_info < (3, 0): install_requires.append("funcsigs") + install_requires.append("pathlib2") setup( name="pytest", diff --git a/src/_pytest/cacheprovider.py b/src/_pytest/cacheprovider.py index f15398383..5b4dbc381 100755 --- a/src/_pytest/cacheprovider.py +++ b/src/_pytest/cacheprovider.py @@ -5,40 +5,41 @@ the name cache was not chosen to ensure pluggy automatically ignores the external pytest-cache """ from __future__ import absolute_import, division, print_function - from collections import OrderedDict import py import six +import attr import pytest import json -import os from os.path import sep as _sep, altsep as _altsep from textwrap import dedent +from . import paths +import logging + + +log = logging.getLogger(__name__) + + +@attr.s class Cache(object): - def __init__(self, config): - self.config = config - self._cachedir = Cache.cache_dir_from_config(config) - self.trace = config.trace.root.get("cache") - if config.getoption("cacheclear"): - self.trace("clearing cachedir") - if self._cachedir.check(): - self._cachedir.remove() - self._cachedir.mkdir() + @classmethod + def for_config(cls, config): + cachedir = cls.cache_dir_from_config(config) + if config.getoption("cacheclear") and cachedir.exists(): + shutil.rmtree(str(cachedir)) + cachedir.mkdir() + return cls(cachedir) + + _cachedir = attr.ib(repr=False) @staticmethod def cache_dir_from_config(config): - cache_dir = config.getini("cache_dir") - cache_dir = os.path.expanduser(cache_dir) - cache_dir = os.path.expandvars(cache_dir) - if os.path.isabs(cache_dir): - return py.path.local(cache_dir) - else: - return config.rootdir.join(cache_dir) + return paths.resolve_from_str(config.getini("cache_dir"), config.rootdir) def makedir(self, name): """ return a directory path object with the given name. If the @@ -52,10 +53,12 @@ class Cache(object): """ if _sep in name or _altsep is not None and _altsep in name: raise ValueError("name is not allowed to contain path separators") - return self._cachedir.ensure_dir("d", name) + res = self._cachedir.joinpath("d", name) + res.mkdir(exist_ok=True, parents=True) + return py.path.local(res) def _getvaluepath(self, key): - return self._cachedir.join("v", *key.split("/")) + return self._cachedir.joinpath("v", *key.split("/")) def get(self, key, default): """ return cached value for the given key. If no value @@ -69,13 +72,11 @@ class Cache(object): """ path = self._getvaluepath(key) - if path.check(): - try: - with path.open("r") as f: - return json.load(f) - except ValueError: - self.trace("cache-invalid at %s" % (path,)) - return default + try: + with path.open("r") as f: + return json.load(f) + except (ValueError, IOError): + return default def set(self, key, value): """ save value for the given key. @@ -88,21 +89,16 @@ class Cache(object): """ path = self._getvaluepath(key) try: - path.dirpath().ensure_dir() - except (py.error.EEXIST, py.error.EACCES): - self.config.warn( - code="I9", message="could not create cache path %s" % (path,) - ) + path.parent.mkdir(exist_ok=True, parents=True) + except IOError: + log.warning("could not create cache path %s", path) return try: f = path.open("w") except py.error.ENOTDIR: - self.config.warn( - code="I9", message="cache could not write path %s" % (path,) - ) + log.warning("cache could not write path %s", path) else: with f: - self.trace("cache-write %s: %r" % (key, value)) json.dump(value, f, indent=2, sort_keys=True) self._ensure_readme() @@ -297,7 +293,7 @@ def pytest_cmdline_main(config): @pytest.hookimpl(tryfirst=True) def pytest_configure(config): - config.cache = Cache(config) + config.cache = Cache.for_config(config) config.pluginmanager.register(LFPlugin(config), "lfplugin") config.pluginmanager.register(NFPlugin(config), "nfplugin") @@ -320,41 +316,40 @@ def cache(request): def pytest_report_header(config): if config.option.verbose: - relpath = py.path.local().bestrelpath(config.cache._cachedir) - return "cachedir: %s" % relpath + relpath = config.cache._cachedir.relative_to(config.rootdir) + return "cachedir: {}".format(relpath) def cacheshow(config, session): - from pprint import pprint + from pprint import pformat tw = py.io.TerminalWriter() tw.line("cachedir: " + str(config.cache._cachedir)) - if not config.cache._cachedir.check(): + if not config.cache._cachedir.is_dir(): tw.line("cache is empty") return 0 dummy = object() basedir = config.cache._cachedir - vdir = basedir.join("v") + vdir = basedir.joinpath("v") tw.sep("-", "cache values") - for valpath in sorted(vdir.visit(lambda x: x.isfile())): - key = valpath.relto(vdir).replace(valpath.sep, "/") + for valpath in sorted(x for x in vdir.rglob("*") if x.is_file()): + key = "/".join(valpath.relative_to(vdir).parts) val = config.cache.get(key, dummy) if val is dummy: tw.line("%s contains unreadable content, " "will be ignored" % key) else: tw.line("%s contains:" % key) - stream = py.io.TextIO() - pprint(val, stream=stream) - for line in stream.getvalue().splitlines(): + for line in pformat(val).splitlines(): tw.line(" " + line) - ddir = basedir.join("d") - if ddir.isdir() and ddir.listdir(): + ddir = basedir.joinpath("d") + if ddir.is_dir(): + contents = sorted(ddir.rglob("*")) tw.sep("-", "cache directories") - for p in sorted(basedir.join("d").visit()): + for p in contents: # if p.check(dir=1): # print("%s/" % p.relto(basedir)) - if p.isfile(): - key = p.relto(basedir) - tw.line("%s is a file of length %d" % (key, p.size())) + if p.is_file(): + key = p.relative_to(basedir) + tw.line("{} is a file of length {:d}".format(key, p.stat().st_size)) return 0 diff --git a/src/_pytest/compat.py b/src/_pytest/compat.py index 7abd3d53f..78a23523b 100644 --- a/src/_pytest/compat.py +++ b/src/_pytest/compat.py @@ -29,8 +29,11 @@ _PY2 = not _PY3 if _PY3: from inspect import signature, Parameter as Parameter + from pathlib import Path else: from funcsigs import signature, Parameter as Parameter + from pathlib2 import Path +Path NoneType = type(None) diff --git a/testing/test_cacheprovider.py b/testing/test_cacheprovider.py index 4a7c25aa0..68ed33910 100644 --- a/testing/test_cacheprovider.py +++ b/testing/test_cacheprovider.py @@ -1,5 +1,7 @@ from __future__ import absolute_import, division, print_function + import sys + import py import _pytest import pytest @@ -26,7 +28,7 @@ class TestNewAPI(object): cache = config.cache pytest.raises(TypeError, lambda: cache.set("key/name", cache)) config.cache.set("key/name", 0) - config.cache._getvaluepath("key/name").write("123invalid") + config.cache._getvaluepath("key/name").write_bytes(b"123invalid") val = config.cache.get("key/name", -2) assert val == -2