Merge pull request #1054 from nicoddemus/cache-fixture-docstring

Add docstring to cache fixture
This commit is contained in:
Ronny Pfannschmidt 2015-09-23 09:00:01 +02:00
commit e5c76cb22d
1 changed files with 12 additions and 0 deletions

View File

@ -186,8 +186,20 @@ def pytest_configure(config):
@pytest.fixture @pytest.fixture
def cache(request): 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 return request.config.cache
def pytest_report_header(config): def pytest_report_header(config):
if config.option.verbose: if config.option.verbose:
relpath = py.path.local().bestrelpath(config.cache._cachedir) relpath = py.path.local().bestrelpath(config.cache._cachedir)