diff --git a/_pytest/cacheprovider.py b/_pytest/cacheprovider.py index e4ae64ab3..a1f728d9c 100755 --- a/_pytest/cacheprovider.py +++ b/_pytest/cacheprovider.py @@ -186,8 +186,20 @@ def pytest_configure(config): @pytest.fixture def cache(request): + """ + Return a cache object that can persist state between testing sessions. + + cache.get(key, default) + cache.set(key, value) + + Keys must be strings not containing a "/" separator. Add a unique identifier + (such as plugin/app name) to avoid clashes with other cache users. + + Values can be any object handled by the json stdlib module. + """ return request.config.cache + def pytest_report_header(config): if config.option.verbose: relpath = py.path.local().bestrelpath(config.cache._cachedir)